fix #73 add contribution campaign condition

CRM/CivirulesConditions/Contribution/Campaign.mgd.php

+<?php
+
+return array (
+  0 =>
+    array (
+      'name' => 'Civirules:Condition.ContributionCampaign',
+      'entity' => 'CiviRuleCondition',
+      'params' =>
+        array (
+          'version' => 3,
+          'name' => 'contribution_campaign',
+          'label' => 'Contribution is (not) in campaign...',
+          'class_name' => 'CRM_CivirulesConditions_Contribution_Campaign',
+          'is_active' => 1
+        ),
+    ),
+);
\ No newline at end of file

CRM/CivirulesConditions/Contribution/Campaign.php

+<?php
+/**
+ * Class for CiviRules Condition Contribution Campaign
+ *
+ * @author Erik Hommel (CiviCooP) <erik.hommel@civicoop.org>
+ * @date 18 May 2016
+ * @license AGPL-3.0
+ */
+
+class CRM_CivirulesConditions_Contribution_Campaign 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_TriggerData_TriggerData $triggerData
+   * @return bool
+   */
+
+  public function isConditionValid(CRM_Civirules_TriggerData_TriggerData $triggerData) {
+    $isConditionValid = FALSE;
+    $contribution = $triggerData->getEntityData('Contribution');
+    switch ($this->conditionParams['operator']) {
+      case 0:
+        if (in_array($contribution['campaign_id'], $this->conditionParams['campaign_id'])) {
+          $isConditionValid = TRUE;
+        }
+      break;
+      case 1:
+        if (!in_array($contribution['campaign_id'], $this->conditionParams['campaign_id'])) {
+          $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_campaign/', '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() {
+    $friendlyText = "";
+    if ($this->conditionParams['operator'] == 0) {
+      $friendlyText = 'Is in one of these campaigns: ';
+    }
+    if ($this->conditionParams['operator'] == 1) {
+      $friendlyText = 'Is NOT in of these campaigns: ';
+    }
+    $campaignText = array();
+    foreach ($this->conditionParams['campaign_id'] as $campaignId) {
+      try {
+        $campaignText[] = civicrm_api3('Campaign', 'Getvalue', array('id' => $campaignId, 'return' => 'title'));
+      } catch (CiviCRM_API3_Exception $ex) {}
+    }
+    if (!empty($campaignText)) {
+      $friendlyText .= implode(", ", $campaignText);
+    }
+    return $friendlyText;
+  }
+
+  /**
+   * 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/Campaign.php

+<?php
+/**
+ * Class for CiviRules Condition Contribution Campaign Form
+ *
+ * @author Erik Hommel (CiviCooP) <erik.hommel@civicoop.org>
+ * @date 18 May 2016
+ * @license AGPL-3.0
+ */
+
+class CRM_CivirulesConditions_Form_Contribution_Campaign extends CRM_CivirulesConditions_Form_Form {
+
+  /**
+   * Overridden parent method to build form
+   *
+   * @access public
+   */
+  public function buildQuickForm() {
+    $this->add('hidden', 'rule_condition_id');
+    $campaignList = array();
+    $campaigns = civicrm_api3('Campaign', 'Get', array(
+      'is_active' => 1, 'options' => array('limit' => 99999)));
+    foreach ($campaigns['values'] as $campaign) {
+      $campaignList[$campaign['id']] = $campaign['title'];
+    }
+    asort($campaignList);
+    $this->add('select', 'campaign_id', ts('Campaign(s)'), $campaignList, true,
+      array('id' => 'campaign_ids', 'multiple' => 'multiple','class' => 'crm-select2'));
+    $this->add('select', 'operator', ts('Operator'), array('is one of', 'is NOT one of'), 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['campaign_id'])) {
+      $defaultValues['campaign_id'] = $data['campaign_id'];
+    }
+    if (!empty($data['operator'])) {
+      $defaultValues['operator'] = $data['operator'];
+    }
+    return $defaultValues;
+  }
+
+  /**
+   * Overridden parent method to process form data after submission
+   *
+   * @throws Exception when rule condition not found
+   * @access public
+   */
+  public function postProcess() {
+    $data['campaign_id'] = $this->_submitValues['campaign_id'];
+    $data['operator'] = $this->_submitValues['operator'];
+    $this->ruleCondition->condition_params = serialize($data);
+    $this->ruleCondition->save();
+    parent::postProcess();
+  }
+}
\ No newline at end of file

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

+<h3>{$ruleConditionHeader}</h3>
+<div class="crm-block crm-form-block crm-civirule-rule_condition-block-contribution_campaign">
+  <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 sector-section">
+    <div class="label">
+      <label for="campaign-select">{ts}Campaign(s){/ts}</label>
+    </div>
+    <div class="content crm-select-container" id="campaign_block">
+      {$form.campaign_id.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

@@ -98,6 +98,13 @@
     <access_arguments>access CiviCRM</access_arguments>
     <access_arguments>administer CiviCRM</access_arguments>
   </item>
+  <item>
+    <path>civicrm/civirule/form/condition/contribution_campaign</path>
+    <page_callback>CRM_CivirulesConditions_Form_Contribution_Campaign</page_callback>
+    <title>contribution campaign</title>
+    <access_arguments>access CiviCRM</access_arguments>
+    <access_arguments>administer CiviCRM</access_arguments>
+  </item>
   <item>
     <path>civicrm/civirule/form/condition/contribution_distinctcontributingday</path>
     <page_callback>CRM_CivirulesConditions_Form_Contribution_DistinctContributingDay</page_callback>