Merge branch 'issue#13'

CRM/CivirulesConditions/Contribution/SpecificAmount.mgd.php

+<?php
+
+return array (
+  0 =>
+    array (
+      'name' => 'Civirules:Condition.SpecificAmount',
+      'entity' => 'CiviRuleCondition',
+      'params' =>
+        array (
+          'version' => 3,
+          'name' => 'specific_amount',
+          'label' => 'xth Contribution of Amount xxx',
+          'class_name' => 'CRM_CivirulesConditions_Contribution_SpecificAmount',
+          'is_active' => 1
+        ),
+    ),
+);
\ No newline at end of file

CRM/CivirulesConditions/Contribution/SpecificAmount.php

+<?php
+
+/**
+ * Class CRM_CivirulesConditions_Contribution_SpecificAmount
+ *
+ * This CiviRule condition will check for the xth contribution of a certain amount and financial type
+ *
+ * @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_SpecificAmount extends CRM_Civirules_Condition {
+
+  private $conditionParams = array();
+  private $whereClauses = array();
+  private $whereParams = 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;
+
+    $this->buildWhereClauses($eventData->getEntityData('Contribution'));
+    if (!empty($this->whereClauses)) {
+      $query = 'SELECT COUNT(*) as countContributions FROM civicrm_contribution WHERE '.implode(' AND ', $this->whereClauses);
+      $dao = CRM_Core_DAO::executeQuery($query, $this->whereParams);
+      if ($dao->fetch()) {
+        switch ($this->conditionParams['count_operator']) {
+          case 1:
+            if ($dao->countContributions != $this->conditionParams['no_of_contributions']) {
+              $isConditionValid = TRUE;
+            }
+          break;
+          case 2:
+            if ($dao->countContributions > $this->conditionParams['no_of_contributions']) {
+              $isConditionValid = TRUE;
+            }
+          break;
+          case 3:
+            if ($dao->countContributions >= $this->conditionParams['no_of_contributions']) {
+              $isConditionValid = TRUE;
+            }
+          break;
+          case 4:
+            if ($dao->countContributions < $this->conditionParams['no_of_contributions']) {
+              $isConditionValid = TRUE;
+            }
+          break;
+          case 5:
+            if ($dao->countContributions <= $this->conditionParams['no_of_contributions']) {
+              $isConditionValid = TRUE;
+            }
+          break;
+          default:
+            if ($dao->countContributions == $this->conditionParams['no_of_contribution']) {
+              $isConditionValid = TRUE;
+            }
+          break;
+        }
+      }
+    }
+    return $isConditionValid;
+  }
+  /**
+   * Method to build the where Clauses and related Params
+   *
+   * @param array $contribution
+   * @access protected
+   */
+  protected function buildWhereClauses($contribution) {
+    $this->whereClauses[] = 'contribution_status_id = %1';
+    $this->whereParams[1] = array(CRM_Civirules_Utils::getContributionStatusIdWithName('Completed'), 'Integer');
+    $this->whereClauses[] = 'is_test = %2';
+    $this->whereParams[2] = array(0, 'Integer');
+    $this->whereClauses[] = 'contact_id = %3';
+    $this->whereParams[3] = array($contribution['contact_id'], 'Integer');
+    $index = 3;
+    if (!empty($this->conditionParams['amount'])) {
+      $index++;
+      $this->whereClauses[] = 'total_amount '.$this->setOperator($this->conditionParams['amount_operator']).' %'.$index;
+      $this->whereParams[$index] = array($this->conditionParams['amount'], 'Money');
+    }
+    if (!empty($this->conditionParams['financial_type'])) {
+      $index++;
+      $this->whereClauses[] = 'financial_type_id = %'.$index;
+      $this->whereParams[$index] = array($this->conditionParams['financial_type'], 'Integer');
+    }
+  }
+
+  /**
+   * Method to get the operator
+   *
+   * @param int $operatorId
+   * @return string
+   * @access protected
+   */
+  protected function setOperator($operatorId) {
+    switch ($operatorId) {
+      case 1:
+        return "!=";
+      break;
+      case 2:
+        return ">";
+      break;
+      case 3:
+        return ">=";
+      break;
+      case 4:
+        return "<";
+      break;
+      case 5:
+        return "<=";
+      break;
+      default:
+        return "=";
+      break;
+    }
+  }
+
+  /**
+   * 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_specificamount/', '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() {
+    $operator = null;
+    $countOperator = $this->setOperator($this->conditionParams['count_operator']);
+    $formattedString = 'Number of contributions '.$countOperator.' '.$this->conditionParams['no_of_contributions'];
+    if (!empty($this->conditionParams['financial_type'])) {
+      $financialType = new CRM_Financial_BAO_FinancialType();
+      $financialType->id = $this->conditionParams['financial_type'];
+      if ($financialType->find(true)) {
+        $formattedString .= ' of financial type ' . $financialType->name;
+      }
+    }
+    $amountOperator = $this->setOperator($this->conditionParams['amount_operator']);
+    $formattedString .= ' where amount '.$amountOperator.' '.CRM_Utils_Money::format($this->conditionParams['amount']);
+    return $formattedString;
+  }
+
+  /**
+   * Returns an array with required entity names
+   *
+   * @return array
+   * @access public
+   */
+  public function requiredEntities() {
+    return array('Contribution');
+  }
+
+}
\ No newline at end of file

CRM/CivirulesConditions/Form/Contribution/SpecificAmount.php

+<?php
+/**
+ * Class for CiviRules Condition Contribution Count Number of Contributions with a Specific Amount
+ *
+ * @author Erik Hommel (CiviCooP) <erik.hommel@civicoop.org>
+ * @license AGPL-3.0
+ */
+
+class CRM_CivirulesConditions_Form_Contribution_SpecificAmount extends CRM_CivirulesConditions_Form_Form {
+
+  /**
+   * Overridden parent method to build form
+   *
+   * @access public
+   */
+  public function buildQuickForm() {
+    $operatorList[0] = 'equals (=)';
+    $operatorList[1] = 'is not equal (!=)';
+    $operatorList[2] = 'is more than (>)';
+    $operatorList[3] = 'is more than or equal (>=)';
+    $operatorList[4] = 'is less than (<)';
+    $operatorList[5] = 'is less than or equal (<=)';
+
+    $financialTypes = CRM_Civirules_Utils::getFinancialTypes();
+    $financialTypes[0] = ts(' - any -');
+    asort($financialTypes);
+
+    $this->add('hidden', 'rule_condition_id');
+    $this->add('select', 'count_operator', ts('Operator'), $operatorList, true);
+    $this->add('select', 'amount_operator', ts('where Operator'), $operatorList, true);
+    $this->add('select', 'financial_type', ts('of Financial Type'), $financialTypes, true);
+    $this->add('text', 'no_of_contributions', ts('Number of Contributions'), array(), true);
+    $this->addRule('no_of_contributions','Number of contributions must be a whole number','numeric');
+    $this->addRule('no_of_contributions','Number of contributions must be a whole number','nopunctuation');
+    $this->add('text', 'amount', ts('Amount'), array(), true);
+    $this->addRule('amount','Amount can only contain numbers','numeric');
+
+    $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['count_operator'])) {
+      $defaultValues['count_operator'] = $data['count_operator'];
+    }
+    if (!empty($data['no_of_contributions'])) {
+      $defaultValues['no_of_contributions'] = $data['no_of_contributions'];
+    }
+    if (!empty($data['financial_type'])) {
+      $defaultValues['financial_type'] = $data['financial_type'];
+    }
+    if (!empty($data['amount_operator'])) {
+      $defaultValues['amount_operator'] = $data['amount_operator'];
+    }
+    if (!empty($data['amount'])) {
+      $defaultValues['amount'] = $data['amount'];
+    }
+    return $defaultValues;
+  }
+
+  /**
+   * Overridden parent method to process form data after submission
+   *
+   * @throws Exception when rule condition not found
+   * @access public
+   */
+  public function postProcess() {
+    $data['count_operator'] = $this->_submitValues['count_operator'];
+    $data['no_of_contributions'] = $this->_submitValues['no_of_contributions'];
+    $data['financial_type'] = $this->_submitValues['financial_type'];
+    $data['amount_operator'] = $this->_submitValues['amount_operator'];
+    $data['amount'] = $this->_submitValues['amount'];
+    $this->ruleCondition->condition_params = serialize($data);
+    $this->ruleCondition->save();
+
+    parent::postProcess();
+  }
+}
\ No newline at end of file

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

+<h3>{$ruleConditionHeader}</h3>
+<div class="crm-block crm-form-block crm-civirule-rule_condition-block-contribution_specificamount">
+  <div class="'crm-section">
+    Contribution is:
+  </div>
+  <div class="crm-section">
+    <div class="label">{$form.count_operator.label}</div>
+    <div class="content">{$form.count_operator.html}</div>
+    <div class="clear"></div>
+  </div>
+  <div class="crm-section">
+    <div class="label">{$form.no_of_contributions.label}</div>
+    <div class="content">{$form.no_of_contributions.html}</div>
+    <div class="clear"></div>
+  </div>
+  <div class="crm-section">
+    <div class="label">{$form.financial_type.label}</div>
+    <div class="content">{$form.financial_type.html}</div>
+    <div class="clear"></div>
+  </div>
+  <div class="crm-section">
+    <div class="label">{$form.amount_operator.label}</div>
+    <div class="content">{$form.amount_operator.html}</div>
+    <div class="clear"></div>
+  </div>
+  <div class="crm-section">
+    <div class="label">{$form.amount.label}</div>
+    <div class="content">{$form.amount.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_specificamount</path>
+    <page_callback>CRM_CivirulesConditions_Form_Contribution_SpecificAmount</page_callback>
+    <title>specific amount count</title>
+    <access_arguments>access CiviCRM</access_arguments>
+  </item>
   <item>
     <path>civicrm/civirule/form/condition/contact_ingroup</path>
     <page_callback>CRM_CivirulesConditions_Form_Contact_InGroup</page_callback>