From d0699ceb1b27136d0c40f16b0ba5366adbe0a3db Mon Sep 17 00:00:00 2001
From: Erik Hommel <hommel@ee-atwork.nl>
Date: Tue, 13 Oct 2015 12:44:40 +0200
Subject: [PATCH] #42 update api
---
api/v3/CiviRuleRule/Create.php | 6 ++--
.../Create.php | 28 +++++++++----------
.../Get.php | 8 +++---
api/v3/Civirules/Cron.mgd.php | 2 +-
4 files changed, 22 insertions(+), 22 deletions(-)
rename api/v3/{CiviRuleEvent => CiviRuleTrigger}/Create.php (78%)
rename api/v3/{CiviRuleEvent => CiviRuleTrigger}/Get.php (58%)
diff --git a/api/v3/CiviRuleRule/Create.php b/api/v3/CiviRuleRule/Create.php
index 1c46f00..78924bb 100755
--- a/api/v3/CiviRuleRule/Create.php
+++ b/api/v3/CiviRuleRule/Create.php
@@ -11,7 +11,7 @@ function _civicrm_api3_civi_rule_rule_create_spec(&$spec) {
$spec['id']['api_required'] = 0;
$spec['label']['api_required'] = 0;
$spec['name']['api_required'] = 0;
- $spec['event_id']['api_required'] = 1;
+ $spec['trigger_id']['api_required'] = 1;
}
/**
@@ -28,8 +28,8 @@ function civicrm_api3_civi_rule_rule_create($params) {
if (!isset($params['id']) && empty($params['label'])) {
return civicrm_api3_create_error('Label can not be empty when adding a new CiviRule');
}
- if (empty($params['event_id'])) {
- return civicrm_api3_create_error('Event_id can not be empty');
+ if (empty($params['trigger_id'])) {
+ return civicrm_api3_create_error('Trigger_id can not be empty');
}
/*
* set created or modified date and user_id
diff --git a/api/v3/CiviRuleEvent/Create.php b/api/v3/CiviRuleTrigger/Create.php
similarity index 78%
rename from api/v3/CiviRuleEvent/Create.php
rename to api/v3/CiviRuleTrigger/Create.php
index e8c066d..867bbf3 100755
--- a/api/v3/CiviRuleEvent/Create.php
+++ b/api/v3/CiviRuleTrigger/Create.php
@@ -1,13 +1,13 @@
<?php
/**
- * CiviRuleEvent.Create API specification (optional)
+ * CiviRuleTrigger.Create API specification (optional)
* This is used for documentation and validation.
*
* @param array $spec description of fields supported by this API call
* @return void
* @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/
-function _civicrm_api3_civi_rule_event_create_spec(&$spec) {
+function _civicrm_api3_civi_rule_trigger_create_spec(&$spec) {
$spec['label']['api_required'] = 0;
$spec['name']['api_required'] = 0;
$spec['object_name']['api_required'] = 0;
@@ -16,14 +16,14 @@ function _civicrm_api3_civi_rule_event_create_spec(&$spec) {
}
/**
- * CiviRuleEvent.Create API
+ * CiviRuleTrigger.Create API
*
* @param array $params
* @return array API result descriptor
* @see civicrm_api3_create_success
* @see civicrm_api3_create_error
*/
-function civicrm_api3_civi_rule_event_create($params) {
+function civicrm_api3_civi_rule_trigger_create($params) {
$errorMessage = _validateParams($params);
if (!empty($errorMessage)) {
return civicrm_api3_create_error($errorMessage);
@@ -37,8 +37,8 @@ function civicrm_api3_civi_rule_event_create($params) {
$params['created_date'] = date('Ymd');
$params['created_user_id'] = $userId;
}
- $returnValues = CRM_Civirules_BAO_Event::add($params);
- return civicrm_api3_create_success($returnValues, $params, 'CiviRuleEvent', 'Create');
+ $returnValues = CRM_Civirules_BAO_Trigger::add($params);
+ return civicrm_api3_create_success($returnValues, $params, 'CiviRuleTrigger', 'Create');
}
/**
@@ -50,7 +50,7 @@ function civicrm_api3_civi_rule_event_create($params) {
function _validateParams($params) {
$errorMessage = '';
if (!isset($params['id']) && empty($params['label'])) {
- return ts('Label can not be empty when adding a new CiviRule Event');
+ return ts('Label can not be empty when adding a new CiviRule Trigger');
}
if (_checkClassNameObjectNameOperation($params) == FALSE) {
return ts('Either class_name or a combination of object_name and op is mandatory');
@@ -59,25 +59,25 @@ function _validateParams($params) {
$params['object_name'] = null;
$params['op'] = null;
if (!isset($params['class_name']) || empty($params['class_name'])) {
- return ts('For a cron type event the class_name is mandatory');
+ return ts('For a cron type trigger the class_name is mandatory');
}
}
if (isset($params['object_name']) && !empty($params['object_name'])) {
$extensionConfig = CRM_Civirules_Config::singleton();
- if (!in_array($params['object_name'], $extensionConfig->getValidEventObjectNames())) {
+ if (!in_array($params['object_name'], $extensionConfig->getValidTriggerObjectNames())) {
return ts('ObjectName passed in parameters ('.$params['object_name']
- .')is not a valid object for a CiviRule Event');
+ .')is not a valid object for a CiviRule Trigger');
}
}
if (isset($params['op']) && !empty($params['op'])) {
$extensionConfig = CRM_Civirules_Config::singleton();
- if (!in_array($params['op'], $extensionConfig->getValidEventOperations())) {
+ if (!in_array($params['op'], $extensionConfig->getValidTriggerOperations())) {
return ts('Operation passed in parameters ('.$params['op']
- .')is not a valid operation for a CiviRule Event');
+ .')is not a valid operation for a CiviRule Trigger');
}
}
- if (CRM_Civirules_BAO_Event::eventExists($params) == TRUE) {
- return ts('There is already an event for this class_name or combination of object_name and op');
+ if (CRM_Civirules_BAO_Trigger::triggerExists($params) == TRUE) {
+ return ts('There is already a trigger for this class_name or combination of object_name and op');
}
return $errorMessage;
diff --git a/api/v3/CiviRuleEvent/Get.php b/api/v3/CiviRuleTrigger/Get.php
similarity index 58%
rename from api/v3/CiviRuleEvent/Get.php
rename to api/v3/CiviRuleTrigger/Get.php
index 3693fdc..6a5aed1 100755
--- a/api/v3/CiviRuleEvent/Get.php
+++ b/api/v3/CiviRuleTrigger/Get.php
@@ -1,6 +1,6 @@
<?php
/**
- * CiviRuleEvent.Get API
+ * CiviRuleTrigger.Get API
*
* @param array $params
* @return array API result descriptor
@@ -8,8 +8,8 @@
* @see civicrm_api3_create_error
* @throws API_Exception
*/
-function civicrm_api3_civi_rule_event_get($params) {
- $returnValues = CRM_Civirules_BAO_Event::getValues($params);
- return civicrm_api3_create_success($returnValues, $params, 'CiviRuleEvent', 'Get');
+function civicrm_api3_civi_rule_trigger_get($params) {
+ $returnValues = CRM_Civirules_BAO_Trigger::getValues($params);
+ return civicrm_api3_create_success($returnValues, $params, 'CiviRuleTrigger', 'Get');
}
diff --git a/api/v3/Civirules/Cron.mgd.php b/api/v3/Civirules/Cron.mgd.php
index dacac0a..a890e4f 100644
--- a/api/v3/Civirules/Cron.mgd.php
+++ b/api/v3/Civirules/Cron.mgd.php
@@ -12,7 +12,7 @@ return array (
array (
'version' => 3,
'name' => 'Civirules cron',
- 'description' => 'Trigger civirules cron events',
+ 'description' => 'Trigger civirules cron triggers',
'run_frequency' => 'Daily',
'api_entity' => 'Civirules',
'api_action' => 'Cron',
--
GitLab