45 lines
1.4 KiB
PHP
45 lines
1.4 KiB
PHP
<?php
|
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
|
|
|
/**
|
|
* TwingleCampaign.Get API specification (optional)
|
|
* This is used for documentation and validation.
|
|
*
|
|
* @param array $spec description of fields supported by this API call
|
|
*
|
|
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
|
*/
|
|
function _civicrm_api3_twingle_campaign_Get_spec(&$spec) {
|
|
$spec['magicword']['api.required'] = 1;
|
|
}
|
|
|
|
/**
|
|
* TwingleCampaign.Get API
|
|
*
|
|
* @param array $params
|
|
*
|
|
* @return array
|
|
* API result descriptor
|
|
*
|
|
* @see civicrm_api3_create_success
|
|
*
|
|
* @throws API_Exception
|
|
*/
|
|
function civicrm_api3_twingle_campaign_Get($params) {
|
|
if (array_key_exists('magicword', $params) && $params['magicword'] == 'sesame') {
|
|
$returnValues = array(
|
|
// OK, return several data rows
|
|
12 => ['id' => 12, 'name' => 'Twelve'],
|
|
34 => ['id' => 34, 'name' => 'Thirty four'],
|
|
56 => ['id' => 56, 'name' => 'Fifty six'],
|
|
);
|
|
// ALTERNATIVE: $returnValues = []; // OK, success
|
|
// ALTERNATIVE: $returnValues = ["Some value"]; // OK, return a single value
|
|
|
|
// Spec: civicrm_api3_create_success($values = 1, $params = [], $entity = NULL, $action = NULL)
|
|
return civicrm_api3_create_success($returnValues, $params, 'TwingleCampaign', 'Get');
|
|
}
|
|
else {
|
|
throw new API_Exception(/*error_message*/ 'Everyone knows that the magicword is "sesame"', /*error_code*/ 'magicword_incorrect');
|
|
}
|
|
}
|