add condition membership status

CRM/Civirules/Utils.php

@@ -232,6 +232,27 @@ class CRM_Civirules_Utils {
     return $return;
   }
 
+  /**
+   * Method to get the membership status
+   * @param bool $onlyActive
+   * @return array
+   */
+  public static function getMembershipStatus($onlyActive = TRUE) {
+    $return = array();
+    if ($onlyActive) {
+      $params = array('is_active' => 1);
+    } else {
+      $params = array();
+    }
+    try {
+      $apiMembershipStatus = civicrm_api3("MembershipStatus", "Get", $params);
+      foreach ($apiMembershipStatus['values'] as $membershipStatus) {
+        $return[$membershipStatus['id']] = $membershipStatus['name'];
+      }
+    } catch (CiviCRM_API3_Exception $ex) {}
+    return $return;
+  }
+
   /**
    * Method to check if the incoming date is later than today
    *

CRM/CivirulesConditions/Form/Membership/Status.php

+<?php
+/**
+ * Class for CiviRules Condition Membership Status Form
+ *
+ * @author Erik Hommel (CiviCooP) <erik.hommel@civicoop.org>
+ * @license AGPL-3.0
+ */
+
+class CRM_CivirulesConditions_Form_Membership_Status extends CRM_CivirulesConditions_Form_Form {
+
+  /**
+   * Overridden parent method to build form
+   *
+   * @access public
+   */
+  public function buildQuickForm() {
+    $this->add('hidden', 'rule_condition_id');
+
+    $membershipStatus = CRM_Civirules_Utils::getMembershipStatus();
+    $membershipStatus[0] = ts('- select -');
+    asort($membershipStatus);
+    $this->add('select', 'membership_status_id', ts('Membership Status'), $membershipStatus, true);
+    $this->add('select', 'operator', ts('Operator'), array('equals', 'is not equal to'), 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['membership_status_id'])) {
+      $defaultValues['membership_status_id'] = $data['membership_status_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['membership_status_id'] = $this->_submitValues['membership_status_id'];
+    $data['operator'] = $this->_submitValues['operator'];
+    $this->ruleCondition->condition_params = serialize($data);
+    $this->ruleCondition->save();
+    parent::postProcess();
+  }
+}
\ No newline at end of file

CRM/CivirulesConditions/Form/Membership/Type.php

@@ -19,7 +19,7 @@ class CRM_CivirulesConditions_Form_Membership_Type extends CRM_CivirulesConditio
     $membershipTypes = CRM_Civirules_Utils::getMembershipTypes();
     $membershipTypes[0] = ts('- select -');
     asort($membershipTypes);
-    $this->add('select', 'membership_type_id', ts('Membership type'), $membershipTypes, true);
+    $this->add('select', 'membership_type_id', ts('Membership Type'), $membershipTypes, true);
     $this->add('select', 'operator', ts('Operator'), array('equals', 'is not equal to'), true);
 
     $this->addButtons(array(

CRM/CivirulesConditions/Membership/Status.mgd.php

+<?php
+
+return array (
+  0 =>
+    array (
+      'name' => 'Civirules:Condition.MembershipStatus',
+      'entity' => 'CiviRuleCondition',
+      'params' =>
+        array (
+          'version' => 3,
+          'name' => 'membership_status',
+          'label' => 'Membership status is (not) ...',
+          'class_name' => 'CRM_CivirulesConditions_Membership_Status',
+          'is_active' => 1
+        ),
+    ),
+);
\ No newline at end of file

CRM/CivirulesConditions/Membership/Status.php

+<?php
+
+class CRM_CivirulesConditions_Membership_Status 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;
+    $membership = $triggerData->getEntityData('Membership');
+    CRM_Core_Error::debug('membership', $membership);
+    switch ($this->conditionParams['operator']) {
+      case 0:
+        if ($membership['status_id'] == $this->conditionParams['membership_status_id']) {
+          $isConditionValid = TRUE;
+        }
+      break;
+      case 1:
+        if ($membership['status_id'] != $this->conditionParams['membership_status_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/membershipstatus', '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() {
+    try {
+      $apiMembershipStatus = civicrm_api3('MembershipStatus', 'Get', array('is_active' => 1));
+      $operator = null;
+      if ($this->conditionParams['operator'] == 0) {
+        $operator = 'equals';
+      }
+      if ($this->conditionParams['operator'] == 1) {
+        $operator = 'is not equal to';
+      }
+      foreach ($apiMembershipStatus['values'] as $membershipStatus) {
+        if ($membershipStatus['id'] == $this->conditionParams['membership_status_id']) {
+          return "Membership Status ".$operator." ".$membershipStatus['name'];
+        }
+      }
+    } catch (CiviCRM_API3_Exception $ex) {}
+    return '';
+  }
+
+  /**
+   * Returns an array with required entity names
+   *
+   * @return array
+   * @access public
+   */
+  public function requiredEntities() {
+    return array('Membership');
+  }
+
+}
\ No newline at end of file

CRM/CivirulesConditions/Membership/Type.mgd.php

@@ -9,7 +9,7 @@ return array (
         array (
           'version' => 3,
           'name' => 'membership_type',
-          'label' => 'Membership is (not) of membership type ...',
+          'label' => 'Membership type is (not) ...',
           'class_name' => 'CRM_CivirulesConditions_Membership_Type',
           'is_active' => 1
         ),

templates/CRM/CivirulesConditions/Form/Membership/Status.tpl

+<h3>{$ruleConditionHeader}</h3>
+<div class="crm-block crm-form-block crm-civirule-rule_condition-block-membership_status">
+  <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.membership_status_id.label}</div>
+    <div class="content">{$form.membership_status_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

@@ -63,6 +63,13 @@
     <access_arguments>access CiviCRM</access_arguments>
     <access_arguments>administer CiviCRM</access_arguments>
   </item>
+  <item>
+    <path>civicrm/civirule/form/condition/membershipstatus</path>
+    <page_callback>CRM_CivirulesConditions_Form_Membership_Status</page_callback>
+    <title>membership status</title>
+    <access_arguments>access CiviCRM</access_arguments>
+    <access_arguments>administer CiviCRM</access_arguments>
+  </item>
   <item>
     <path>civicrm/civirule/form/condition/contribution_totalcontributedamount</path>
     <page_callback>CRM_CivirulesConditions_Form_Contribution_TotalContributedAmount</page_callback>