Skip to content
Snippets Groups Projects
Commit d1db0ffc authored by Erik Hommel's avatar Erik Hommel
Browse files

correct insert Events and doc Generic/ValueComparison

parent b295eeb9
No related branches found
No related tags found
No related merge requests found
...@@ -21,7 +21,7 @@ class CRM_Civirules_Upgrader extends CRM_Civirules_Upgrader_Base { ...@@ -21,7 +21,7 @@ class CRM_Civirules_Upgrader extends CRM_Civirules_Upgrader_Base {
$this->addCondition('CRM_CivirulesConditions_PrimaryEmailChanged', 'primary_email_changed', ts('Primary e-mail addres is changed')); $this->addCondition('CRM_CivirulesConditions_PrimaryEmailChanged', 'primary_email_changed', ts('Primary e-mail addres is changed'));
$this->addCondition('CRM_CivirulesConditions_AgeComparison', 'age_comparison', ts('Age comparison')); $this->addCondition('CRM_CivirulesConditions_AgeComparison', 'age_comparison', ts('Age comparison'));
$this->addCondition('CRM_CivirulesConditions_BirthdayChanged', 'brithday_changed', ts('Birthday changed')); $this->addCondition('CRM_CivirulesConditions_BirthdayChanged', 'birthday_changed', ts('Birthday changed'));
$this->addAction('CRM_CivirulesActions_GroupContact', 'GroupContact', 'Add contact to group', 'GroupContact', 'create'); $this->addAction('CRM_CivirulesActions_GroupContact', 'GroupContact', 'Add contact to group', 'GroupContact', 'create');
} }
......
<?php <?php
/**
* Abstract class for generic value comparison conditions
*
* @author Jaap Jansma (CiviCooP) <jaap.jansma@civicoop.org>
* @license AGPL-3.0
*/
abstract class CRM_CivirulesConditions_Generic_ValueComparison extends CRM_Civirules_Condition { abstract class CRM_CivirulesConditions_Generic_ValueComparison extends CRM_Civirules_Condition {
private $condition_params = array(); private $conditionParams = array();
/**
* Function to set the Rule Condition data
*
* @param array $ruleCondition
* @access public
*/
public function setRuleConditionData($ruleCondition) { public function setRuleConditionData($ruleCondition) {
parent::setRuleConditionData($ruleCondition); parent::setRuleConditionData($ruleCondition);
$this->condition_params = array(); $this->conditionParams = array();
if (!empty($this->ruleCondition['condition_params'])) { if (!empty($this->ruleCondition['condition_params'])) {
$this->condition_params = unserialize($this->ruleCondition['condition_params']); $this->conditionParams = unserialize($this->ruleCondition['condition_params']);
} }
} }
/** /**
* Returns value of the field * Returns the value of the field for the condition
* For example: I want to check if age > 50, this function would return the 50
* *
* @param CRM_Civirules_EventData_EventData $eventData * @param object CRM_Civirules_EventData_EventData $eventData
* @return mixed * @return
* @access protected
* @abstract
*/ */
abstract protected function getFieldValue(CRM_Civirules_EventData_EventData $eventData); abstract protected function getFieldValue(CRM_Civirules_EventData_EventData $eventData);
/** /**
* Returns the value for the data comparison * Returns the value for the data comparison
*
* @return mixed * @return mixed
* @access protected
*/ */
protected function getComparisonValue() { protected function getComparisonValue() {
return (!empty($this->condition_params['value']) ? $this->condition_params['value'] : ''); if (!empty($this->conditionParams['value'])) {
return $this->conditionParams['value'];
} else {
return '';
}
} }
/** /**
...@@ -39,12 +60,25 @@ abstract class CRM_CivirulesConditions_Generic_ValueComparison extends CRM_Civir ...@@ -39,12 +60,25 @@ abstract class CRM_CivirulesConditions_Generic_ValueComparison extends CRM_Civir
* - greater than or equal: >= * - greater than or equal: >=
* - lesser than or equal: <= * - lesser than or equal: <=
* *
* @return an operator for comparison * @return string operator for comparison
* @access protected
*/ */
protected function getOperator() { protected function getOperator() {
return (!empty($this->condition_params['operator']) ? $this->condition_params['operator'] : ''); if (!empty($this->conditionParams['operator'])) {
return $this->conditionParams['operator'];
} else {
return '';
}
} }
/**
* Mandatory function to return if the condition is valid
*
* @param object CRM_Civirules_EventData_EventData $eventData
* @return bool
* @access public
*/
public function isConditionValid(CRM_Civirules_EventData_EventData $eventData) { public function isConditionValid(CRM_Civirules_EventData_EventData $eventData) {
$value = $this->getFieldValue($eventData); $value = $this->getFieldValue($eventData);
$compareValue = $this->getComparisonValue(); $compareValue = $this->getComparisonValue();
...@@ -86,16 +120,18 @@ abstract class CRM_CivirulesConditions_Generic_ValueComparison extends CRM_Civir ...@@ -86,16 +120,18 @@ abstract class CRM_CivirulesConditions_Generic_ValueComparison extends CRM_Civir
* *
* @param int $ruleConditionId * @param int $ruleConditionId
* @return bool|string * @return bool|string
* @access public
*/ */
public function getExtraDataInputUrl($ruleConditionId) { public function getExtraDataInputUrl($ruleConditionId) {
return CRM_Utils_System::url('civicrm/civirule/form/condition/datacomparison/', 'rule_condition_id='.$ruleConditionId); return CRM_Utils_System::url('civicrm/civirule/form/condition/datacomparison/', 'rule_condition_id='.$ruleConditionId);
} }
/** /**
* Retruns a user friendly text explaining the condition params * Returns a user friendly text explaining the condition params
* e.g. 'Older than 65' * e.g. 'Older than 65'
* *
* @return string * @return string
* @access public
*/ */
public function userFriendlyConditionParams() { public function userFriendlyConditionParams() {
return htmlentities(($this->getOperator())).' '.htmlentities($this->getComparisonValue()); return htmlentities(($this->getOperator())).' '.htmlentities($this->getComparisonValue());
......
INSERT INTO civirule_event (name, label, object_name, op, class_name, created_date, created_user_id) INSERT INTO civirule_event (name, label, object_name, op, class_name, created_date, created_user_id)
VALUES VALUES
('new_activity', 'New Activity', 'Activity', 'create', null, CURDATE(), 1), ('new_activity', 'Activity is is added', 'Activity', 'create', null, CURDATE(), 1),
('changed_activity', 'Changed Activity', 'Activity', 'edit', null, CURDATE(), 1), ('changed_activity', 'Activity is changed', 'Activity', 'edit', null, CURDATE(), 1),
('deleted_activity', 'Deleted Activity', 'Activity', 'delete', null, CURDATE(), 1), ('deleted_activity', 'Activity is deleted', 'Activity', 'delete', null, CURDATE(), 1),
('new_address', 'New Address', 'Address', 'create', null, CURDATE(), 1), ('new_address', 'Address is added', 'Address', 'create', null, CURDATE(), 1),
('changed_address', 'Changed Address', 'Address', 'edit', null, CURDATE(), 1), ('changed_address', 'Address is changed', 'Address', 'edit', null, CURDATE(), 1),
('deleted_address', 'Deleted Address', 'Address', 'delete', null, CURDATE(), 1), ('deleted_address', 'Address is deleted', 'Address', 'delete', null, CURDATE(), 1),
('new_case', 'New Case', 'Case', 'create', null, CURDATE(), 1), ('new_case', 'Case is added', 'Case', 'create', null, CURDATE(), 1),
('changed_case', 'Changed Case', 'Case', 'edit', null, CURDATE(), 1), ('changed_case', 'Case is changed', 'Case', 'edit', null, CURDATE(), 1),
('deleted_case', 'Deleted Case', 'Case', 'delete', null, CURDATE(), 1), ('deleted_case', 'Case is deleted', 'Case', 'delete', null, CURDATE(), 1),
('new_contact', 'New Contact (any type)', 'Contact', 'create', null, CURDATE(), 1), ('new_contact', 'Contact of any type is added', 'Contact', 'create', null, CURDATE(), 1),
('changed_contact', 'Changed Contact (any type)', 'Contact', 'edit', null, CURDATE(), 1), ('changed_contact', 'Contact of any type is changed', 'Contact', 'edit', null, CURDATE(), 1),
('deleted_contact', 'Deleted Contact (any type)', 'Contact', 'delete', null, CURDATE(), 1), ('deleted_contact', 'Contact of any type is deleted', 'Contact', 'delete', null, CURDATE(), 1),
('trashed_contact', 'Trashed Contact (any type)', 'Contact', 'delete', null, CURDATE(), 1), ('trashed_contact', 'Contact of any type is trashed', 'Contact', 'delete', null, CURDATE(), 1),
('restored_contact', 'Restored Contact (any type)', 'Contact', 'delete', null, CURDATE(), 1), ('restored_contact', 'Contact of any type is restored', 'Contact', 'delete', null, CURDATE(), 1),
('new_individual', 'New Individual', 'Individual', 'create', null, CURDATE(), 1), ('new_individual', 'Individual is added', 'Individual', 'create', null, CURDATE(), 1),
('changed_individual', 'Changed Individual', 'Individual', 'edit', null, CURDATE(), 1), ('changed_individual', 'Individual is changed', 'Individual', 'edit', null, CURDATE(), 1),
('deleted_individual', 'Deleted Individual', 'Individual', 'delete', null, CURDATE(), 1), ('deleted_individual', 'Individual is deleted', 'Individual', 'delete', null, CURDATE(), 1),
('trashed_individual', 'Trashed Individual', 'Individual', 'delete', null, CURDATE(), 1), ('trashed_individual', 'Individual is trashed', 'Individual', 'delete', null, CURDATE(), 1),
('restored_individual', 'Restored Individual', 'Individual', 'delete', null, CURDATE(), 1), ('restored_individual', 'Individual is restored', 'Individual', 'delete', null, CURDATE(), 1),
('new_household', 'New Household', 'Household', 'create', null, CURDATE(), 1), ('new_household', 'Household is added', 'Household', 'create', null, CURDATE(), 1),
('changed_household', 'Changed Household', 'Household', 'edit', null, CURDATE(), 1), ('changed_household', 'Household is changed', 'Household', 'edit', null, CURDATE(), 1),
('deleted_household', 'Deleted Household', 'Household', 'delete', null, CURDATE(), 1), ('deleted_household', 'Household is deleted', 'Household', 'delete', null, CURDATE(), 1),
('trashed_household', 'Trashed Household', 'Household', 'delete', null, CURDATE(), 1), ('trashed_household', 'Household is trashed', 'Household', 'delete', null, CURDATE(), 1),
('restored_household', 'Restored Household', 'Household', 'delete', null, CURDATE(), 1), ('restored_household', 'Household is restored', 'Household', 'delete', null, CURDATE(), 1),
('new_organization', 'New Household', 'Household', 'create', null, CURDATE(), 1), ('new_organization', 'Organization is added', 'Organization', 'create', null, CURDATE(), 1),
('changed_organization', 'Changed Household', 'Household', 'edit', null, CURDATE(), 1), ('changed_organization', 'Organization is changed', 'Organization', 'edit', null, CURDATE(), 1),
('deleted_organization', 'Deleted Household', 'Household', 'delete', null, CURDATE(), 1), ('deleted_organization', 'Organization is deleted', 'Organization', 'delete', null, CURDATE(), 1),
('trashed_organization', 'Trashed Household', 'Household', 'delete', null, CURDATE(), 1), ('trashed_organization', 'Organization is trashed', 'Organization', 'delete', null, CURDATE(), 1),
('restored_organization', 'Restored Household', 'Household', 'delete', null, CURDATE(), 1); ('restored_organization', 'Organization is restored', 'Organization', 'delete', null, CURDATE(), 1);
INSERT INTO civirule_event (name, label, object_name, op, class_name, created_date, created_user_id) INSERT INTO civirule_event (name, label, object_name, op, class_name, created_date, created_user_id)
VALUES VALUES
('new_contribution', 'New Contribution', 'Contribution', 'create', null, CURDATE(), 1), ('new_contribution', 'Contribution is added', 'Contribution', 'create', null, CURDATE(), 1),
('changed_contribution', 'Changed Contribution', 'Contribution', 'edit', null, CURDATE(), 1), ('changed_contribution', 'Contribution is changed', 'Contribution', 'edit', null, CURDATE(), 1),
('deleted_contribution', 'Deleted Contribution', 'Contribution', 'delete', null, CURDATE(), 1), ('deleted_contribution', 'Contribution is deleted', 'Contribution', 'delete', null, CURDATE(), 1),
('new_contribution_recur', 'New Recurring Contribution', 'ContributionRecur', 'create', null, CURDATE(), 1), ('new_contribution_recur', 'Recurring Contribution is added', 'ContributionRecur', 'create', null, CURDATE(), 1),
('changed_contribution_recur', 'Changed Recurring Contribution', 'ContributionRecur', 'edit', null, CURDATE(), 1), ('changed_contribution_recur', 'Recurring Contribution is changed', 'ContributionRecur', 'edit', null, CURDATE(), 1),
('deleted_contribution_recur', 'Deleted Recurring Contribution', 'ContributionRecur', 'delete', null, CURDATE(), 1), ('deleted_contribution_recur', 'Recurring Contribution is deleted', 'ContributionRecur', 'delete', null, CURDATE(), 1),
('new_emailaddress', 'New Email-address', 'Email', 'create', null, CURDATE(), 1), ('new_emailaddress', 'Email-address is added', 'Email', 'create', null, CURDATE(), 1),
('changed_emailaddress', 'Changed Email-address', 'Email', 'edit', null, CURDATE(), 1), ('changed_emailaddress', 'Email-address is changed', 'Email', 'edit', null, CURDATE(), 1),
('deleted_emailaddress', 'Deleted Email-address', 'Email', 'delete', null, CURDATE(), 1), ('deleted_emailaddress', 'Email-address is deleted', 'Email', 'delete', null, CURDATE(), 1),
('new_entity_tag', 'Entity Tagged', 'EntityTag', 'create', null, CURDATE(), 1), ('new_entity_tag', 'Tag added to entity (entity is tagged)', 'EntityTag', 'create', null, CURDATE(), 1),
('changed_entity_tag', 'Entity Tag Changed', 'EntityTag', 'edit', null, CURDATE(), 1), ('deleted_entity_tag', 'Tag removed from entity', 'EntityTag', 'delete', null, CURDATE(), 1),
('deleted_entity_tag', 'Entity Tag Removed', 'EntityTag', 'delete', null, CURDATE(), 1), ('new_event', 'Event is added', 'Event', 'create', null, CURDATE(), 1),
('new_event', 'New Event', 'Event', 'create', null, CURDATE(), 1), ('changed_event', 'Event is changed', 'Event', 'edit', null, CURDATE(), 1),
('changed_event', 'Changed Event', 'Event', 'edit', null, CURDATE(), 1), ('deleted_event', 'Event is deleted', 'Event', 'delete', null, CURDATE(), 1),
('deleted_event', 'Deleted Event', 'Event', 'delete', null, CURDATE(), 1), ('new_grant', 'Grant is added', 'Grant', 'create', null, CURDATE(), 1),
('new_grant', 'New Grant', 'Grant', 'create', null, CURDATE(), 1), ('changed_grant', 'Grant is changed', 'Grant', 'edit', null, CURDATE(), 1),
('changed_grant', 'Changed Grant', 'Grant', 'edit', null, CURDATE(), 1), ('deleted_grant', 'Grant is deleted', 'Grant', 'delete', null, CURDATE(), 1),
('deleted_grant', 'Deleted Grant', 'Grant', 'delete', null, CURDATE(), 1), ('new_group', 'Group is added', 'Group', 'create', null, CURDATE(), 1),
('new_group', 'New Group', 'Group', 'create', null, CURDATE(), 1), ('changed_group', 'Group is changed', 'Group', 'edit', null, CURDATE(), 1),
('changed_group', 'Changed Group', 'Group', 'edit', null, CURDATE(), 1), ('deleted_group', 'Group is deleted', 'Group', 'delete', null, CURDATE(), 1),
('deleted_group', 'Deleted Group', 'Group', 'delete', null, CURDATE(), 1), ('new_group_contact', 'Contact is added to Group', 'GroupContact', 'create', null, CURDATE(), 1),
('new_group_contact', 'Added Contact to Group', 'GroupContact', 'create', null, CURDATE(), 1), ('deleted_group_contact', 'Contact is removed from Group', 'GroupContact', 'delete', null, CURDATE(), 1),
('deleted_group_contact', 'Removed Contact from GroupContact', 'Group', 'delete', null, CURDATE(), 1), ('new_membership', 'Membership is added', 'Membership', 'create', null, CURDATE(), 1),
('new_membership', 'New Membership', 'Membership', 'create', null, CURDATE(), 1), ('changed_membership', 'Membership is changed', 'Membership', 'edit', null, CURDATE(), 1),
('changed_membership', 'Changed Membership', 'Membership', 'edit', null, CURDATE(), 1), ('deleted_membership', 'Membership is deleted', 'Membership', 'delete', null, CURDATE(), 1),
('deleted_membership', 'Deleted Membership', 'Membership', 'delete', null, CURDATE(), 1), ('new_membership_payment', 'Membership Payment is added', 'MembershipPayment', 'create', null, CURDATE(), 1),
('new_membership_payment', 'New Membership Payment', 'MembershipPayment', 'create', null, CURDATE(), 1), ('changed_membership_payment', 'Membership Payment is changed', 'MembershipPayment', 'edit', null, CURDATE(), 1),
('changed_membership_payment', 'Changed Membership Payment', 'MembershipPayment', 'edit', null, CURDATE(), 1), ('deleted_membership_payment', 'Membership Payment is deleted', 'MembershipPayment', 'delete', null, CURDATE(), 1);
('deleted_membership_payment', 'Deleted Membership Payment', 'MembershipPayment', 'delete', null, CURDATE(), 1);
INSERT INTO civirule_event (name, label, object_name, op, class_name, created_date, created_user_id) INSERT INTO civirule_event (name, label, object_name, op, class_name, created_date, created_user_id)
VALUES VALUES
('new_participant', 'New Event Participant', 'Participant', 'create', null, CURDATE(), 1), ('new_participant', 'Event Participant is added', 'Participant', 'create', null, CURDATE(), 1),
('changed_participant', 'Changed Event Participant', 'Participant', 'edit', null, CURDATE(), 1), ('changed_participant', 'Event Participant is changed', 'Participant', 'edit', null, CURDATE(), 1),
('deleted_participant', 'Deleted Event Participant', 'Participant', 'delete', null, CURDATE(), 1), ('deleted_participant', 'Event Participant is deleted', 'Participant', 'delete', null, CURDATE(), 1),
('new_participant_payment', 'New Payment for Event Participant', 'ParticipantPayment', 'create', null, CURDATE(), 1), ('new_participant_payment', 'Event Participant Payment is added', 'ParticipantPayment', 'create', null, CURDATE(), 1),
('changed_participant_payment', 'Changed Payment for Event Participant', 'ParticipantPayment', 'edit', null, CURDATE(), 1), ('changed_participant_payment', 'Event Participant Payment is changed', 'ParticipantPayment', 'edit', null, CURDATE(), 1),
('deleted_participant_payment', 'Deleted Payment for Event Participant', 'ParticipantPayment', 'delete', null, CURDATE(), 1), ('deleted_participant_payment', 'Event Participant is deleted', 'ParticipantPayment', 'delete', null, CURDATE(), 1),
('new_phone', 'New Phonenumber', 'Phone', 'create', null, CURDATE(), 1), ('new_phone', 'Phonenumber is added', 'Phone', 'create', null, CURDATE(), 1),
('changed_phone', 'Changed Phonenumber', 'Phone', 'edit', null, CURDATE(), 1), ('changed_phone', 'Phonenumber is changed', 'Phone', 'edit', null, CURDATE(), 1),
('deleted_phone', 'Deleted Phonenumber', 'Phone', 'delete', null, CURDATE(), 1), ('deleted_phone', 'Phonenumber is deleted', 'Phone', 'delete', null, CURDATE(), 1),
('new_pledge', 'New Pledge', 'Pledge', 'create', null, CURDATE(), 1), ('new_pledge', 'Pledge is added', 'Pledge', 'create', null, CURDATE(), 1),
('changed_pledge', 'Changed Pledge', 'Pledge', 'edit', null, CURDATE(), 1), ('changed_pledge', 'Pledge is changed', 'Pledge', 'edit', null, CURDATE(), 1),
('deleted_pledge', 'Deleted Pledge', 'Pledge', 'delete', null, CURDATE(), 1), ('deleted_pledge', 'Pledge is deleted', 'Pledge', 'delete', null, CURDATE(), 1),
('new_pledge_payment', 'New Pledge Payment', 'PledgePayment', 'create', null, CURDATE(), 1), ('new_pledge_payment', 'Pledge Payment is added', 'PledgePayment', 'create', null, CURDATE(), 1),
('changed_pledge_payment', 'Changed Pledge Payment', 'PledgePayment', 'edit', null, CURDATE(), 1), ('changed_pledge_payment', 'Pledge Payment is changed', 'PledgePayment', 'edit', null, CURDATE(), 1),
('deleted_pledge_payment', 'Deleted Pledge Payment', 'PledgePayment', 'delete', null, CURDATE(), 1), ('deleted_pledge_payment', 'Pledge Payment is deleted', 'PledgePayment', 'delete', null, CURDATE(), 1),
('new_relationship', 'New Relationship', 'Relationship', 'create', null, CURDATE(), 1), ('new_relationship', 'Relationship is added', 'Relationship', 'create', null, CURDATE(), 1),
('changed_relationship', 'Changed Relationship', 'Relationship', 'edit', null, CURDATE(), 1), ('changed_relationship', 'Relationship is changed', 'Relationship', 'edit', null, CURDATE(), 1),
('deleted_relationship', 'Deleted Relationship', 'Relationship', 'delete', null, CURDATE(), 1), ('deleted_relationship', 'Relationship is deleted', 'Relationship', 'delete', null, CURDATE(), 1),
('new_tag', 'New Tag', 'Tag', 'create', null, CURDATE(), 1), ('new_tag', 'Tag is added', 'Tag', 'create', null, CURDATE(), 1),
('changed_tag', 'Changed Tag', 'Tag', 'edit', null, CURDATE(), 1), ('changed_tag', 'Tag is changed', 'Tag', 'edit', null, CURDATE(), 1),
('deleted_tag', 'Deleted Tag', 'Tag', 'delete', null, CURDATE(), 1); ('deleted_tag', 'Tag is deleted', 'Tag', 'delete', null, CURDATE(), 1);
\ No newline at end of file \ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment