Merge branch 'issue#4'

CRM/CivirulesConditions/Contribution/DistinctContributingDay.mgd.php

+<?php
+
+return array (
+  0 =>
+    array (
+      'name' => 'Civirules:Condition.DistinctContributingDay',
+      'entity' => 'CiviRuleCondition',
+      'params' =>
+        array (
+          'version' => 3,
+          'name' => 'distinct_contributing_day_of_contact',
+          'label' => 'xth Day of Contributing by Donor',
+          'class_name' => 'CRM_CivirulesConditions_Contribution_DistinctContributingDay',
+          'is_active' => 1
+        ),
+    ),
+);
\ No newline at end of file

CRM/CivirulesConditions/Contribution/DistinctContributingDay.php

+<?php
+
+/**
+ * Class CRM_CivirulesConditions_Contribution_DistinctContributingDay
+ *
+ * This CiviRule condition will check for the xth distinct contributing day for the donor.
+ * All contributions on the same date will count as 1.
+ *
+ * @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_DistinctContributingDay 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;
+    $contribution = $eventData->getEntityData('Contribution');
+    /*
+     * retrieve count of contributions for donor grouped by extracted YMD from receive_date
+     */
+    $query = 'SELECT COUNT(DISTINCT CONCAT(EXTRACT(YEAR FROM receive_date),
+EXTRACT(MONTH FROM receive_date), EXTRACT(DAY FROM receive_date))) AS distinctDates
+FROM civicrm_contribution WHERE contact_id = %1';
+    $params = array(1 => array($contribution['contact_id'], 'Positive'));
+    $dao = CRM_Core_DAO::executeQuery($query, $params);
+    if ($dao->fetch()) {
+
+      switch ($this->conditionParams['operator']) {
+        case 1:
+          if ($dao->distinctDates != $this->conditionParams['no_of_days']) {
+            $isConditionValid = TRUE;
+          }
+        break;
+        case 2:
+          if ($dao->distinctDates > $this->conditionParams['no_of_days']) {
+            $isConditionValid = TRUE;
+          }
+        break;
+        case 3:
+          if ($dao->distinctDates >= $this->conditionParams['no_of_days']) {
+          $isConditionValid = TRUE;
+        }
+        break;
+        case 4:
+          if ($dao->distinctDates < $this->conditionParams['no_of_days']) {
+          $isConditionValid = TRUE;
+        }
+        break;
+        case 5:
+          if ($dao->distinctDates <= $this->conditionParams['no_of_days']) {
+          $isConditionValid = TRUE;
+        }
+        break;
+        default:
+          if ($dao->distinctDates == $this->conditionParams['no_of_days']) {
+            $isConditionValid = TRUE;
+          }
+        break;
+      }
+    }
+    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_distinctcontributingday/', '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;
+    switch ($this->conditionParams['operator']) {
+      case 1:
+        $operator = 'is not equal to';
+        break;
+      case 2:
+        $operator = 'bigger than';
+        break;
+      case 3:
+        $operator = 'bigger than or equal to';
+        break;
+      case 4:
+        $operator = 'less than';
+        break;
+      case 5:
+        $operator = 'less than or equal to';
+        break;
+      default:
+        $operator = 'is equal to';
+        break;
+    }
+    return 'Distinct number of contributing days '.$operator.' '.$this->conditionParams['no_of_days'];
+  }
+
+  /**
+   * 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/DistinctContributingDay.php

+<?php
+/**
+ * Class for CiviRules Condition Contribution Distinct Contributing Day Form
+ *
+ * @author Erik Hommel (CiviCooP) <erik.hommel@civicoop.org>
+ * @license AGPL-3.0
+ */
+
+class CRM_CivirulesConditions_Form_Contribution_DistinctContributingDay 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 bigger than (>)';
+    $operatorList[3] = 'is bigger than or equal (>=)';
+    $operatorList[4] = 'is less than (<)';
+    $operatorList[5] = 'is less than or equal (<=)';
+
+    $this->add('hidden', 'rule_condition_id');
+    $this->add('select', 'operator', ts('Operator'), $operatorList, true);
+    $this->add('text', 'no_of_days', ts('Number of Days'), array(), true);
+    $this->addRule('no_of_days','Number of Days must be a whole number','numeric');
+    $this->addRule('no_of_days','Number of Days must be a whole number','nopunctuation');
+
+    $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['operator'])) {
+      $defaultValues['operator'] = $data['operator'];
+    }
+    if (!empty($data['no_of_days'])) {
+      $defaultValues['no_of_days'] = $data['no_of_days'];
+    }
+    return $defaultValues;
+  }
+
+  /**
+   * Overridden parent method to process form data after submission
+   *
+   * @throws Exception when rule condition not found
+   * @access public
+   */
+  public function postProcess() {
+    $data['operator'] = $this->_submitValues['operator'];
+    $data['no_of_days'] = $this->_submitValues['no_of_days'];
+    $this->ruleCondition->condition_params = serialize($data);
+    $this->ruleCondition->save();
+
+    parent::postProcess();
+  }
+}
\ No newline at end of file

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

+<h3>{$ruleConditionHeader}</h3>
+<div class="crm-block crm-form-block crm-civirule-rule_condition-block-contribution_distinctcontributingday">
+  <div class="crm-section">
+    <div class="label">{$form.operator.label}</div>
+    <div class="content">{$form.operator.html}</div>
+    <div class="clear"></div>
+  </div>
+  <div class="crm-section">
+    <div class="label">{$form.no_of_days.label}</div>
+    <div class="content">{$form.no_of_days.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

@@ -60,6 +60,12 @@
     <title>financial type</title>
     <access_arguments>access CiviCRM</access_arguments>
   </item>
+  <item>
+    <path>civicrm/civirule/form/condition/contribution_distinctcontributingday</path>
+    <page_callback>CRM_CivirulesConditions_Form_Contribution_DistinctContributingDay</page_callback>
+    <title>financial type</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>