condition added for issue #23, to be tested on MAF as there is no core way to...

condition added for issue #23, to be tested on MAF as there is no core way to add recurring contribution

CRM/CivirulesConditions/Contribution/CountRecurring.mgd.php

@@ -9,7 +9,7 @@ return array (
         array (
           'version' => 3,
           'name' => 'count_recurring',
-          'label' => 'xth recurring contribution collection',
+          'label' => 'xth Recurring Contribution Collection',
           'class_name' => 'CRM_CivirulesConditions_Contribution_CountRecurring',
           'is_active' => 1
         ),

CRM/CivirulesConditions/Contribution/RecurringEndDate.mgd.php

+<?php
+
+return array (
+  0 =>
+    array (
+      'name' => 'Civirules:Condition.RecurringEndDate',
+      'entity' => 'CiviRuleCondition',
+      'params' =>
+        array (
+          'version' => 3,
+          'name' => 'recurring_end_date',
+          'label' => 'End Date of Recurring Contribution',
+          'class_name' => 'CRM_CivirulesConditions_Contribution_RecurringEndDate',
+          'is_active' => 1
+        ),
+    ),
+);
\ No newline at end of file

CRM/CivirulesConditions/Contribution/RecurringEndDate.php

+<?php
+
+/**
+ * Class CRM_CivirulesConditions_Contribution_RecurringEndDate
+ *
+ * This CiviRule condition will check if the end date of the recurring contribution is set or not set
+ *
+ * @author Erik Hommel (CiviCooP) <erik.hommel@civicoop.org>
+ * @link http://redmine.civicoop.org/projects/civirules/wiki/Tutorial_create_a_more_complicated_condition_with_its_own_form_processing
+ */
+
+class CRM_CivirulesConditions_Contribution_RecurringEndDate extends CRM_Civirules_Condition {
+
+  private $conditionParams = array();
+
+  /**
+   * Method to set the Rule Condition data
+   *
+   * @param array $ruleCondition
+   * @access public
+   */
+  public function setRuleConditionData($ruleCondition) {
+    parent::setRuleConditionData($ruleCondition);
+    $this->conditionParams = array();
+    if (!empty($this->ruleCondition['condition_params'])) {
+      $this->conditionParams = unserialize($this->ruleCondition['condition_params']);
+    }
+  }
+
+  /**
+   * Method to determine if the condition is valid
+   *
+   * @param CRM_Civirules_EventData_EventData $eventData
+   * @return bool
+   */
+
+  public function isConditionValid(CRM_Civirules_EventData_EventData $eventData) {
+    $isConditionValid = FALSE;
+    $recurring = $eventData->getEntityData('ContributionRecur');
+    if ($this->conditionParams['end_date'] == 0 && empty($recurring['end_date'])) {
+      $isConditionValid = TRUE;
+    }
+    if ($this->conditionParams['end_date'] == 1 && !empty($recurring['end_date'])) {
+      $isConditionValid = TRUE;
+    }
+    return $isConditionValid;
+  }
+
+  /**
+   * Returns a redirect url to extra data input from the user after adding a condition
+   *
+   * Return false if you do not need extra data input
+   *
+   * @param int $ruleConditionId
+   * @return bool|string
+   * @access public
+   * @abstract
+   */
+  public function getExtraDataInputUrl($ruleConditionId) {
+    return CRM_Utils_System::url('civicrm/civirule/form/condition/contribution_recurringenddate/', 'rule_condition_id='.$ruleConditionId);
+  }
+
+  /**
+   * Returns a user friendly text explaining the condition params
+   * e.g. 'Older than 65'
+   *
+   * @return string
+   * @access public
+   */
+  public function userFriendlyConditionParams() {
+    if ($this->conditionParams['end_date'] == 1) {
+      $endDateString = 'is set';
+    } else {
+      $endDateString = 'is not set';
+    }
+    return 'End Date of Recurring Contribution '.$endDateString;
+  }
+
+  /**
+   * Returns an array with required entity names
+   *
+   * @return array
+   * @access public
+   */
+  public function requiredEntities() {
+    return array('ContributionRecur');
+  }
+}
\ No newline at end of file

CRM/CivirulesConditions/Form/Contribution/RecurringEndDate.php

+<?php
+/**
+ * Class for CiviRules Condition Contribution Recurring End Date set or not set
+ *
+ * @author Erik Hommel (CiviCooP) <erik.hommel@civicoop.org>
+ * @license AGPL-3.0
+ */
+
+class CRM_CivirulesConditions_Form_Contribution_RecurringEndDate extends CRM_CivirulesConditions_Form_Form {
+
+  /**
+   * Overridden parent method to build form
+   *
+   * @access public
+   */
+  public function buildQuickForm() {
+
+    $this->add('hidden', 'rule_condition_id');
+    $this->add('select', 'end_date', ts('End Date is'), array('is not set', 'is set'), true);
+
+    $this->addButtons(array(
+      array('type' => 'next', 'name' => ts('Save'), 'isDefault' => TRUE,),
+      array('type' => 'cancel', 'name' => ts('Cancel'))));
+  }
+
+  /**
+   * Overridden parent method to set default values
+   *
+   * @return array $defaultValues
+   * @access public
+   */
+  public function setDefaultValues() {
+    $defaultValues = parent::setDefaultValues();
+    $data = unserialize($this->ruleCondition->condition_params);
+    if (!empty($data['end_date'])) {
+      $defaultValues['end_date'] = $data['end_date'];
+    }
+    return $defaultValues;
+  }
+
+  /**
+   * Overridden parent method to process form data after submission
+   *
+   * @throws Exception when rule condition not found
+   * @access public
+   */
+  public function postProcess() {
+    $data['end_date'] = $this->_submitValues['end_date'];
+    $this->ruleCondition->condition_params = serialize($data);
+    $this->ruleCondition->save();
+
+    parent::postProcess();
+  }
+}
\ No newline at end of file

templates/CRM/CivirulesConditions/Form/Contribution/RecurringEndDate.tpl

+<h3>{$ruleConditionHeader}</h3>
+<div class="crm-block crm-form-block crm-civirule-rule_condition-block-contribution_recurring_end_date">
+  <div class="crm-section">
+    <div class="label">{$form.end_date.label}</div>
+    <div class="content">{$form.end_date.html}</div>
+    <div class="clear"></div>
+  </div>
+</div>
+<div class="crm-submit-buttons">
+    {include file="CRM/common/formButtons.tpl" location="bottom"}
+</div>
\ No newline at end of file

xml/Menu/civirules.xml

@@ -72,6 +72,12 @@
     <title>recurring contribution collections</title>
     <access_arguments>access CiviCRM</access_arguments>
   </item>
+  <item>
+    <path>civicrm/civirule/form/condition/contribution_recurringenddate</path>
+    <page_callback>CRM_CivirulesConditions_Form_Contribution_RecurringEndDate</page_callback>
+    <title>end date recurring contribution</title>
+    <access_arguments>access CiviCRM</access_arguments>
+  </item>
   <item>
     <path>civicrm/civirule/form/condition/contribution_specificamount</path>
     <page_callback>CRM_CivirulesConditions_Form_Contribution_SpecificAmount</page_callback>