From: colemanw Date: Fri, 25 Aug 2023 20:23:16 +0000 (-0400) Subject: APIv3 - Delete api examples X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=44def6748293be659eeb90f51e906d545412abdd;p=civicrm-core.git APIv3 - Delete api examples --- diff --git a/CRM/Admin/Page/APIExplorer.php b/CRM/Admin/Page/APIExplorer.php index a7b2553900..9f1a26503e 100644 --- a/CRM/Admin/Page/APIExplorer.php +++ b/CRM/Admin/Page/APIExplorer.php @@ -87,44 +87,6 @@ class CRM_Admin_Page_APIExplorer extends CRM_Core_Page { return 'civicrm/api'; } - /** - * AJAX callback to fetch examples. - */ - public static function getExampleFile() { - if (!empty($_GET['entity']) && strpos($_GET['entity'], '.') === FALSE) { - $examples = []; - $paths = self::uniquePaths(); - foreach ($paths as $path) { - $dir = \CRM_Utils_File::addTrailingSlash($path) . 'api' . DIRECTORY_SEPARATOR . 'v3' . DIRECTORY_SEPARATOR . 'examples' . DIRECTORY_SEPARATOR . $_GET['entity']; - if (\CRM_Utils_File::isDir($dir)) { - foreach (scandir($dir) as $item) { - $item = str_replace('.ex.php', '', $item); - if ($item && strpos($item, '.') === FALSE) { - $examples[] = ['key' => $item, 'value' => $item]; - } - } - } - } - CRM_Utils_JSON::output($examples); - } - if (!empty($_GET['file']) && strpos($_GET['file'], '.') === FALSE) { - $paths = self::uniquePaths(); - $fileFound = FALSE; - foreach ($paths as $path) { - $fileName = \CRM_Utils_File::addTrailingSlash($path) . 'api' . DIRECTORY_SEPARATOR . 'v3' . DIRECTORY_SEPARATOR . 'examples' . DIRECTORY_SEPARATOR . $_GET['file'] . '.ex.php'; - if (!$fileFound && file_exists($fileName)) { - $fileFound = TRUE; - echo file_get_contents($fileName); - } - } - if (!$fileFound) { - echo "Not found."; - } - CRM_Utils_System::civiExit(); - } - CRM_Utils_System::permissionDenied(); - } - /** * Ajax callback to display code docs. */ diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 98d891c5e7..442ed20d1a 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -1579,11 +1579,7 @@ class CRM_Contact_BAO_Query { * 4 => null * ); * - * There are some examples of the syntax in - * https://github.com/civicrm/civicrm-core/tree/master/api/v3/examples/Relationship - * * More notes at CRM_Core_DAO::createSQLFilter - * * and a list of supported operators in CRM_Core_DAO * * @param array $formValues diff --git a/CRM/Core/xml/Menu/Misc.xml b/CRM/Core/xml/Menu/Misc.xml index 96584fc654..b67ef57988 100644 --- a/CRM/Core/xml/Menu/Misc.xml +++ b/CRM/Core/xml/Menu/Misc.xml @@ -107,11 +107,6 @@ access CiviCRM CiviCRM API v3 - - civicrm/ajax/apiexample - CRM_Admin_Page_APIExplorer::getExampleFile - access CiviCRM - civicrm/ajax/apidoc CRM_Admin_Page_APIExplorer::getDoc diff --git a/Civi/Test/Api3DocTrait.php b/Civi/Test/Api3DocTrait.php deleted file mode 100644 index 27440f70fa..0000000000 --- a/Civi/Test/Api3DocTrait.php +++ /dev/null @@ -1,211 +0,0 @@ -_apiversion; - $result = $this->callAPISuccess($entity, $action, $params); - $this->documentMe($entity, $action, $params, $result, $function, $file, $description, $exampleName); - return $result; - } - - /** - * Create test generated example in api/v3/examples. - * - * To turn this off (e.g. on the server) set - * define(DONT_DOCUMENT_TEST_CONFIG ,1); - * in your settings file - * - * @param string $entity - * @param string $action - * @param array $params - * Array as passed to civicrm_api function. - * @param array $result - * Array as received from the civicrm_api function. - * @param string $testFunction - * Calling function - generally __FUNCTION__. - * @param string $testFile - * Called from file - generally __FILE__. - * @param string $description - * Descriptive text for the example file. - * @param string $exampleName - * Name for this example file (CamelCase) - if omitted the action name will be substituted. - */ - private function documentMe($entity, $action, $params, $result, $testFunction, $testFile, $description = "", $exampleName = NULL) { - if ($params['version'] != 3 || (defined('DONT_DOCUMENT_TEST_CONFIG') && DONT_DOCUMENT_TEST_CONFIG)) { - return; - } - $entity = _civicrm_api_get_camel_name($entity); - $action = strtolower($action); - - if (empty($exampleName)) { - // Attempt to convert lowercase action name to CamelCase. - // This is clunky/imperfect due to the convention of all lowercase actions. - $exampleName = \CRM_Utils_String::convertStringToCamel($action); - $knownPrefixes = [ - 'Get', - 'Set', - 'Create', - 'Update', - 'Send', - ]; - foreach ($knownPrefixes as $prefix) { - if (strpos($exampleName, $prefix) === 0 && $prefix != $exampleName) { - $exampleName[strlen($prefix)] = strtoupper($exampleName[strlen($prefix)]); - } - } - } - - $this->tidyExampleResult($result); - if (isset($params['version'])) { - unset($params['version']); - } - // Format multiline description as array - $desc = []; - if (is_string($description) && strlen($description)) { - foreach (explode("\n", $description) as $line) { - $desc[] = trim($line); - } - } - $smarty = \CRM_Core_Smarty::singleton(); - $smarty->assign('testFunction', $testFunction); - $smarty->assign('function', _civicrm_api_get_entity_name_from_camel($entity) . "_$action"); - foreach ($params as $index => $param) { - if (is_string($param)) { - $params[$index] = addslashes($param); - } - } - $smarty->assign('params', $params); - $smarty->assign('entity', $entity); - $smarty->assign('testFile', basename($testFile)); - $smarty->assign('description', $desc); - $smarty->assign('result', $result); - $smarty->assign('action', $action); - - global $civicrm_root; - if (file_exists($civicrm_root . '/tests/templates/documentFunction.tpl')) { - if (!is_dir($civicrm_root . "/api/v3/examples/$entity")) { - mkdir($civicrm_root . "/api/v3/examples/$entity"); - } - $f = fopen($civicrm_root . "/api/v3/examples/$entity/$exampleName.ex.php", "w+b"); - $contents = $smarty->fetch($civicrm_root . '/tests/templates/documentFunction.tpl'); - $contents = \CRM_Core_CodeGen_Util_ArraySyntaxConverter::convert($contents); - fwrite($f, $contents); - fclose($f); - } - } - - /** - * Tidy up examples array so that fields that change often ..don't - * and debug related fields are unset - * - * @param array $result - */ - public function tidyExampleResult(&$result) { - if (!is_array($result)) { - return; - } - $fieldsToChange = [ - 'hash' => '67eac7789eaee00', - 'modified_date' => '2012-11-14 16:02:35', - 'created_date' => '2013-07-28 08:49:19', - 'create_date' => '20120130621222105', - 'application_received_date' => '20130728084957', - 'in_date' => '2013-07-28 08:50:19', - 'scheduled_date' => '20130728085413', - 'approval_date' => '20130728085413', - 'pledge_start_date_high' => '20130726090416', - 'start_date' => '2013-07-29 00:00:00', - 'event_start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'event_end_date' => '2013-08-04 00:00:00', - 'decision_date' => '20130805000000', - ]; - - $keysToUnset = ['xdebug', 'undefined_fields']; - foreach ($keysToUnset as $unwantedKey) { - if (isset($result[$unwantedKey])) { - unset($result[$unwantedKey]); - } - } - if (isset($result['values'])) { - if (!is_array($result['values'])) { - return; - } - $resultArray = &$result['values']; - } - elseif (is_array($result)) { - $resultArray = &$result; - } - else { - return; - } - - foreach ($resultArray as $index => &$values) { - if (!is_array($values)) { - continue; - } - foreach ($values as $key => &$value) { - if (substr($key, 0, 3) == 'api' && is_array($value)) { - if (isset($value['is_error'])) { - // we have a std nested result format - $this->tidyExampleResult($value); - } - else { - foreach ($value as &$nestedResult) { - // this is an alternative syntax for nested results a keyed array of results - $this->tidyExampleResult($nestedResult); - } - } - } - if (in_array($key, $keysToUnset)) { - unset($values[$key]); - break; - } - if (array_key_exists($key, $fieldsToChange) && !empty($value)) { - $value = $fieldsToChange[$key]; - } - if (is_string($value)) { - $value = addslashes($value); - } - } - } - } - -} diff --git a/Civi/Test/Api3TestTrait.php b/Civi/Test/Api3TestTrait.php index e00452ab97..10223289b5 100644 --- a/Civi/Test/Api3TestTrait.php +++ b/Civi/Test/Api3TestTrait.php @@ -142,6 +142,17 @@ trait Api3TestTrait { return $result; } + /** + * @deprecated + * @param string $entity + * @param string $action + * @param array $params + * @return array|int + */ + public function callAPIAndDocument($entity, $action, $params) { + return $this->callAPISuccess($entity, $action, $params); + } + /** * wrap api functions. * so we can ensure they succeed & throw exceptions without litterering the test with checks diff --git a/api/v3/examples/Activity/ContactRefCustomField.ex.php b/api/v3/examples/Activity/ContactRefCustomField.ex.php deleted file mode 100644 index e8e90c1d92..0000000000 --- a/api/v3/examples/Activity/ContactRefCustomField.ex.php +++ /dev/null @@ -1,117 +0,0 @@ - 1, - 'activity_type_id' => 'Test activity type', - 'subject' => 'test activity type id', - 'activity_date_time' => '2011-06-02 14:36:13', - 'status_id' => 2, - 'priority_id' => 1, - 'duration' => 120, - 'location' => 'Pennsylvania', - 'details' => 'a test activity', - 'custom_2' => '1', - ]; - - try { - $result = civicrm_api3('Activity', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'source_record_id' => '', - 'activity_type_id' => '9999', - 'subject' => 'test activity type id', - 'activity_date_time' => '20110602143613', - 'duration' => '120', - 'location' => 'Pennsylvania', - 'phone_id' => '', - 'phone_number' => '', - 'details' => 'a test activity', - 'status_id' => '2', - 'priority_id' => '1', - 'parent_id' => '', - 'is_test' => '', - 'medium_id' => '', - 'is_auto' => '', - 'relationship_id' => '', - 'is_current_revision' => '', - 'original_id' => '', - 'result' => '', - 'is_deleted' => '', - 'campaign_id' => '', - 'engagement_level' => '', - 'weight' => '', - 'is_star' => '', - 'created_date' => '', - 'modified_date' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityCreateCustomContactRefField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/ContactRefCustomFieldGet.ex.php b/api/v3/examples/Activity/ContactRefCustomFieldGet.ex.php deleted file mode 100644 index 6141ee6b2f..0000000000 --- a/api/v3/examples/Activity/ContactRefCustomFieldGet.ex.php +++ /dev/null @@ -1,107 +0,0 @@ - 1, - 'id' => 1, - ]; - - try { - $result = civicrm_api3('Activity', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'activity_type_id' => '9999', - 'subject' => 'test activity type id', - 'activity_date_time' => '2011-06-02 14:36:13', - 'duration' => '120', - 'location' => 'Pennsylvania', - 'details' => 'a test activity', - 'status_id' => '2', - 'priority_id' => '1', - 'is_test' => 0, - 'is_auto' => 0, - 'is_current_revision' => '1', - 'is_deleted' => 0, - 'is_star' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'custom_1' => 'defaultValue', - 'custom_2_id' => '1', - 'custom_2' => 'Anderson, Anthony', - 'source_contact_id' => '1', - 'source_contact_name' => 'Mr. Anthony Anderson II', - 'source_contact_sort_name' => 'Anderson, Anthony', - 'custom_1_1' => 'defaultValue', - 'custom_2_1' => 'Anderson, Anthony', - 'custom_2_1_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityCreateCustomContactRefField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/Create.ex.php b/api/v3/examples/Activity/Create.ex.php deleted file mode 100644 index 734f5fd106..0000000000 --- a/api/v3/examples/Activity/Create.ex.php +++ /dev/null @@ -1,115 +0,0 @@ - 1, - 'activity_type_id' => 'Test activity type', - 'subject' => 'test activity type id', - 'activity_date_time' => '2011-06-02 14:36:13', - 'status_id' => 2, - 'priority_id' => 1, - 'duration' => 120, - 'location' => 'Pennsylvania', - 'details' => 'a test activity', - 'custom_1' => 'custom string', - ]; - - try { - $result = civicrm_api3('Activity', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'source_record_id' => '', - 'activity_type_id' => '9999', - 'subject' => 'test activity type id', - 'activity_date_time' => '20110602143613', - 'duration' => '120', - 'location' => 'Pennsylvania', - 'phone_id' => '', - 'phone_number' => '', - 'details' => 'a test activity', - 'status_id' => '2', - 'priority_id' => '1', - 'parent_id' => '', - 'is_test' => '', - 'medium_id' => '', - 'is_auto' => '', - 'relationship_id' => '', - 'is_current_revision' => '', - 'original_id' => '', - 'result' => '', - 'is_deleted' => '', - 'campaign_id' => '', - 'engagement_level' => '', - 'weight' => '', - 'is_star' => '', - 'created_date' => '', - 'modified_date' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityCreateCustomSubType" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/DateTimeHigh.ex.php b/api/v3/examples/Activity/DateTimeHigh.ex.php deleted file mode 100644 index c548c40eb7..0000000000 --- a/api/v3/examples/Activity/DateTimeHigh.ex.php +++ /dev/null @@ -1,89 +0,0 @@ - 1, - 'filter.activity_date_time_high' => '20120101000000', - 'sequential' => 1, - 'return' => 'activity_date_time', - ]; - - try { - $result = civicrm_api3('Activity', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'activity_date_time' => '2011-01-01 00:00:00', - 'source_contact_id' => '1', - 'source_contact_name' => 'Mr. Anthony Anderson II', - 'source_contact_sort_name' => 'Anderson, Anthony', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetFilterMaxDate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/DateTimeLow.ex.php b/api/v3/examples/Activity/DateTimeLow.ex.php deleted file mode 100644 index a3edbf46d1..0000000000 --- a/api/v3/examples/Activity/DateTimeLow.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - '20120101000000', - 'sequential' => 1, - 'return' => 'activity_date_time', - ]; - - try { - $result = civicrm_api3('Activity', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '0' => [ - 'id' => '2', - 'activity_date_time' => '2012-02-16 00:00:00', - 'source_contact_id' => '1', - 'source_contact_name' => 'Mr. Anthony Anderson II', - 'source_contact_sort_name' => 'Anderson, Anthony', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetFilterMaxDate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/Delete.ex.php b/api/v3/examples/Activity/Delete.ex.php deleted file mode 100644 index 012d906baa..0000000000 --- a/api/v3/examples/Activity/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Activity', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteActivity" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/Get.ex.php b/api/v3/examples/Activity/Get.ex.php deleted file mode 100644 index 8317521e9f..0000000000 --- a/api/v3/examples/Activity/Get.ex.php +++ /dev/null @@ -1,102 +0,0 @@ - 9999, - 'sequential' => 1, - 'return.custom_1' => 1, - ]; - - try { - $result = civicrm_api3('Activity', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'activity_type_id' => '9999', - 'subject' => 'test activity type id', - 'activity_date_time' => '2011-06-02 14:36:13', - 'duration' => '120', - 'location' => 'Pennsylvania', - 'details' => 'a test activity', - 'status_id' => '2', - 'priority_id' => '1', - 'is_test' => 0, - 'is_auto' => 0, - 'is_current_revision' => '1', - 'is_deleted' => 0, - 'is_star' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'custom_1' => 'custom string', - 'source_contact_id' => '1', - 'source_contact_name' => 'Mr. Anthony Anderson II', - 'source_contact_sort_name' => 'Anderson, Anthony', - 'custom_1_1' => 'custom string', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityGetGoodIDCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/GetFields.ex.php b/api/v3/examples/Activity/GetFields.ex.php deleted file mode 100644 index 7800ac1d31..0000000000 --- a/api/v3/examples/Activity/GetFields.ex.php +++ /dev/null @@ -1,684 +0,0 @@ - 'create', - ]; - - try { - $result = civicrm_api3('Activity', 'getfields', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_getfields_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 31, - 'values' => [ - 'source_record_id' => [ - 'name' => 'source_record_id', - 'type' => 1, - 'title' => 'Source Record', - 'description' => 'Artificial FK to original transaction (e.g. contribution) IF it is not an Activity. Table can be figured out through activity_type_id, and further through component registry.', - 'where' => 'civicrm_activity.source_record_id', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'readonly' => TRUE, - 'add' => '2.0', - 'is_core_field' => TRUE, - ], - 'activity_type_id' => [ - 'name' => 'activity_type_id', - 'type' => 1, - 'title' => 'Activity Type ID', - 'description' => 'FK to civicrm_option_value.id, that has to be valid, registered activity type.', - 'required' => TRUE, - 'import' => TRUE, - 'where' => 'civicrm_activity.activity_type_id', - 'headerPattern' => '/(activity.)?type(.id$)/i', - 'export' => TRUE, - 'default' => '1', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'label' => 'Activity Type', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'activity_type', - 'optionEditPath' => 'civicrm/admin/options/activity_type', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'activity_date_time' => [ - 'name' => 'activity_date_time', - 'type' => 12, - 'title' => 'Activity Date', - 'description' => 'Date and time this activity is scheduled to occur. Formerly named scheduled_date_time.', - 'required' => '', - 'import' => TRUE, - 'where' => 'civicrm_activity.activity_date_time', - 'headerPattern' => '/(activity.)?date(.time$)?/i', - 'export' => TRUE, - 'default' => 'CURRENT_TIMESTAMP', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select Date', - 'formatType' => 'activityDateTime', - ], - 'add' => '2.0', - 'is_core_field' => TRUE, - 'api.default' => 'now', - ], - 'phone_id' => [ - 'name' => 'phone_id', - 'type' => 1, - 'title' => 'Phone ID (called)', - 'description' => 'Phone ID of the number called (optional - used if an existing phone number is selected).', - 'where' => 'civicrm_activity.phone_id', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'FKClassName' => 'CRM_Core_DAO_Phone', - 'html' => [ - 'type' => 'EntityRef', - 'label' => 'Phone (called)', - 'size' => 6, - 'maxlength' => 14, - ], - 'add' => '2.0', - 'is_core_field' => TRUE, - 'FKApiName' => 'Phone', - ], - 'phone_number' => [ - 'name' => 'phone_number', - 'type' => 2, - 'title' => 'Phone (called) Number', - 'description' => 'Phone number in case the number does not exist in the civicrm_phone table.', - 'maxlength' => 64, - 'size' => 30, - 'where' => 'civicrm_activity.phone_number', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 64, - 'size' => 30, - ], - 'add' => '2.0', - 'is_core_field' => TRUE, - ], - 'priority_id' => [ - 'name' => 'priority_id', - 'type' => 1, - 'title' => 'Priority', - 'description' => 'ID of the priority given to this activity. Foreign key to civicrm_option_value.', - 'import' => TRUE, - 'where' => 'civicrm_activity.priority_id', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'priority', - 'optionEditPath' => 'civicrm/admin/options/priority', - ], - 'add' => '2.0', - 'is_core_field' => TRUE, - ], - 'parent_id' => [ - 'name' => 'parent_id', - 'type' => 1, - 'title' => 'Parent Activity ID', - 'description' => 'Parent meeting ID (if this is a follow-up item). This is not currently implemented', - 'where' => 'civicrm_activity.parent_id', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'FKClassName' => 'CRM_Activity_DAO_Activity', - 'html' => [ - 'label' => 'Parent Activity', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'FKApiName' => 'Activity', - ], - 'is_auto' => [ - 'name' => 'is_auto', - 'type' => 16, - 'title' => 'Auto', - 'where' => 'civicrm_activity.is_auto', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'add' => '2.2', - 'is_core_field' => TRUE, - ], - 'relationship_id' => [ - 'name' => 'relationship_id', - 'type' => 1, - 'title' => 'Relationship ID', - 'description' => 'FK to Relationship ID', - 'where' => 'civicrm_activity.relationship_id', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_Relationship', - 'html' => [ - 'label' => 'Relationship', - 'size' => 6, - 'maxlength' => 14, - ], - 'add' => '2.2', - 'is_core_field' => TRUE, - 'FKApiName' => 'Relationship', - ], - 'is_current_revision' => [ - 'name' => 'is_current_revision', - 'type' => 16, - 'title' => 'Is this activity a current revision in versioning chain?', - 'import' => TRUE, - 'where' => 'civicrm_activity.is_current_revision', - 'headerPattern' => '/(is.)?(current.)?(revision|version(ing)?)/i', - 'export' => TRUE, - 'default' => '1', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'add' => '2.2', - 'is_core_field' => TRUE, - ], - 'original_id' => [ - 'name' => 'original_id', - 'type' => 1, - 'title' => 'Original Activity ID', - 'description' => 'Activity ID of the first activity record in versioning chain.', - 'where' => 'civicrm_activity.original_id', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'FKClassName' => 'CRM_Activity_DAO_Activity', - 'html' => [ - 'label' => 'Original Activity', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '2.2', - 'is_core_field' => TRUE, - 'FKApiName' => 'Activity', - ], - 'weight' => [ - 'name' => 'weight', - 'type' => 1, - 'title' => 'Order', - 'where' => 'civicrm_activity.weight', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'add' => '4.1', - 'is_core_field' => TRUE, - ], - 'is_star' => [ - 'name' => 'is_star', - 'type' => 16, - 'title' => 'Is Starred', - 'description' => 'Activity marked as favorite.', - 'import' => TRUE, - 'where' => 'civicrm_activity.is_star', - 'headerPattern' => '/(activity.)?(star|favorite)/i', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Checkbox', - ], - 'add' => '4.7', - 'is_core_field' => TRUE, - ], - 'id' => [ - 'name' => 'id', - 'type' => 1, - 'title' => 'Activity ID', - 'description' => 'Unique Other Activity ID', - 'required' => TRUE, - 'import' => TRUE, - 'where' => 'civicrm_activity.id', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Number', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_id', - 'api.aliases' => [ - '0' => 'activity_id', - ], - ], - 'subject' => [ - 'name' => 'subject', - 'type' => 2, - 'title' => 'Subject', - 'description' => 'The subject/purpose/short description of the activity.', - 'maxlength' => 255, - 'size' => 45, - 'import' => TRUE, - 'where' => 'civicrm_activity.subject', - 'headerPattern' => '/(activity.)?subject/i', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 255, - 'size' => 45, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_subject', - ], - 'duration' => [ - 'name' => 'duration', - 'type' => 1, - 'title' => 'Duration', - 'description' => 'Planned or actual duration of activity expressed in minutes. Conglomerate of former duration_hours and duration_minutes.', - 'import' => TRUE, - 'where' => 'civicrm_activity.duration', - 'headerPattern' => '/(activity.)?duration(s)?$/i', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Number', - 'size' => 6, - 'maxlength' => 14, - ], - 'add' => '2.0', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_duration', - ], - 'location' => [ - 'name' => 'location', - 'type' => 2, - 'title' => 'Location', - 'description' => 'Location of the activity (optional, open text).', - 'maxlength' => 255, - 'size' => 45, - 'import' => TRUE, - 'where' => 'civicrm_activity.location', - 'headerPattern' => '/(activity.)?location$/i', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 255, - 'size' => 45, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_location', - ], - 'details' => [ - 'name' => 'details', - 'type' => 32, - 'title' => 'Details', - 'description' => 'Details about the activity (agenda, notes, etc).', - 'import' => TRUE, - 'where' => 'civicrm_activity.details', - 'headerPattern' => '/(activity.)?detail(s)?$/i', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'RichTextEditor', - 'rows' => 2, - 'cols' => 80, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_details', - ], - 'status_id' => [ - 'name' => 'status_id', - 'type' => 1, - 'title' => 'Activity Status', - 'description' => 'ID of the status this activity is currently in. Foreign key to civicrm_option_value.', - 'import' => TRUE, - 'where' => 'civicrm_activity.status_id', - 'headerPattern' => '/(activity.)?status(.label$)?/i', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'activity_status', - 'optionEditPath' => 'civicrm/admin/options/activity_status', - ], - 'add' => '2.0', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_status_id', - 'api.aliases' => [ - '0' => 'activity_status', - ], - ], - 'is_test' => [ - 'name' => 'is_test', - 'type' => 16, - 'title' => 'Test', - 'import' => TRUE, - 'where' => 'civicrm_activity.is_test', - 'headerPattern' => '/(is.)?test(.activity)?/i', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - ], - 'add' => '2.0', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_is_test', - ], - 'medium_id' => [ - 'name' => 'medium_id', - 'type' => 1, - 'title' => 'Activity Medium', - 'description' => 'Activity Medium, Implicit FK to civicrm_option_value where option_group = encounter_medium.', - 'where' => 'civicrm_activity.medium_id', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'encounter_medium', - 'optionEditPath' => 'civicrm/admin/options/encounter_medium', - ], - 'add' => '2.2', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_medium_id', - ], - 'result' => [ - 'name' => 'result', - 'type' => 2, - 'title' => 'Result', - 'description' => 'Currently being used to store result id for survey activity, FK to option value.', - 'maxlength' => 255, - 'size' => 45, - 'where' => 'civicrm_activity.result', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'add' => '3.3', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_result', - ], - 'is_deleted' => [ - 'name' => 'is_deleted', - 'type' => 16, - 'title' => 'Activity is in the Trash', - 'import' => TRUE, - 'where' => 'civicrm_activity.is_deleted', - 'headerPattern' => '/(activity.)?(trash|deleted)/i', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - ], - 'add' => '2.2', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_is_deleted', - ], - 'campaign_id' => [ - 'name' => 'campaign_id', - 'type' => 1, - 'title' => 'Campaign ID', - 'description' => 'The campaign for which this activity has been triggered.', - 'import' => TRUE, - 'where' => 'civicrm_activity.campaign_id', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'FKClassName' => 'CRM_Campaign_DAO_Campaign', - 'component' => 'CiviCampaign', - 'html' => [ - 'type' => 'EntityRef', - 'label' => 'Campaign', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'table' => 'civicrm_campaign', - 'keyColumn' => 'id', - 'labelColumn' => 'title', - 'prefetch' => 'FALSE', - ], - 'add' => '3.4', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_campaign_id', - 'FKApiName' => 'Campaign', - ], - 'engagement_level' => [ - 'name' => 'engagement_level', - 'type' => 1, - 'title' => 'Engagement Index', - 'description' => 'Assign a specific level of engagement to this activity. Used for tracking constituents in ladder of engagement.', - 'import' => TRUE, - 'where' => 'civicrm_activity.engagement_level', - 'export' => TRUE, - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'engagement_index', - 'optionEditPath' => 'civicrm/admin/options/engagement_index', - ], - 'add' => '3.4', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_engagement_level', - ], - 'created_date' => [ - 'name' => 'created_date', - 'type' => 256, - 'title' => 'Created Date', - 'description' => 'When was the activity was created.', - 'required' => '', - 'where' => 'civicrm_activity.created_date', - 'export' => TRUE, - 'default' => 'CURRENT_TIMESTAMP', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select Date', - 'label' => 'Created Date', - ], - 'add' => '4.7', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_created_date', - ], - 'modified_date' => [ - 'name' => 'modified_date', - 'type' => 256, - 'title' => 'Modified Date', - 'description' => 'When was the activity (or closely related entity) was created or modified or deleted.', - 'required' => '', - 'where' => 'civicrm_activity.modified_date', - 'export' => TRUE, - 'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP', - 'table_name' => 'civicrm_activity', - 'entity' => 'Activity', - 'bao' => 'CRM_Activity_BAO_Activity', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select Date', - 'label' => 'Modified Date', - ], - 'readonly' => TRUE, - 'add' => '4.7', - 'is_core_field' => TRUE, - 'uniqueName' => 'activity_modified_date', - ], - 'assignee_contact_id' => [ - 'name' => 'assignee_id', - 'title' => 'Activity Assignee', - 'description' => 'Contact(s) assigned to this activity.', - 'type' => 1, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'FKApiName' => 'Contact', - ], - 'target_contact_id' => [ - 'name' => 'target_id', - 'title' => 'Activity Target', - 'description' => 'Contact(s) participating in this activity.', - 'type' => 1, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'FKApiName' => 'Contact', - ], - 'source_contact_id' => [ - 'name' => 'source_contact_id', - 'title' => 'Activity Source Contact', - 'description' => 'Person who created this activity. Defaults to current user.', - 'type' => 1, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'api.default' => 'user_contact_id', - 'FKApiName' => 'Contact', - 'api.required' => TRUE, - ], - 'case_id' => [ - 'name' => 'case_id', - 'title' => 'Case ID', - 'description' => 'For creating an activity as part of a case.', - 'type' => 1, - 'FKClassName' => 'CRM_Case_DAO_Case', - 'FKApiName' => 'Case', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetFields" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/GetTargetAndAssignee.ex.php b/api/v3/examples/Activity/GetTargetAndAssignee.ex.php deleted file mode 100644 index 2e62af1a5b..0000000000 --- a/api/v3/examples/Activity/GetTargetAndAssignee.ex.php +++ /dev/null @@ -1,118 +0,0 @@ - 1, - 'subject' => 'Make-it-Happen Meeting', - 'activity_date_time' => '20110316', - 'duration' => 120, - 'location' => 'Pennsylvania', - 'details' => 'a test activity', - 'status_id' => 1, - 'activity_type_id' => 1, - 'priority_id' => 1, - 'target_contact_id' => 1, - 'assignee_contact_id' => 1, - ]; - - try { - $result = civicrm_api3('Activity', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'source_record_id' => '', - 'activity_type_id' => '1', - 'subject' => 'Make-it-Happen Meeting', - 'activity_date_time' => '20110316000000', - 'duration' => '120', - 'location' => 'Pennsylvania', - 'phone_id' => '', - 'phone_number' => '', - 'details' => 'a test activity', - 'status_id' => '1', - 'priority_id' => '1', - 'parent_id' => '', - 'is_test' => '', - 'medium_id' => '', - 'is_auto' => '', - 'relationship_id' => '', - 'is_current_revision' => '', - 'original_id' => '', - 'result' => '', - 'is_deleted' => '', - 'campaign_id' => '', - 'engagement_level' => '', - 'weight' => '', - 'is_star' => '', - 'created_date' => '', - 'modified_date' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityReturnTargetAssignee" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/GetTargetandAssigneeName.ex.php b/api/v3/examples/Activity/GetTargetandAssigneeName.ex.php deleted file mode 100644 index fa0f47211c..0000000000 --- a/api/v3/examples/Activity/GetTargetandAssigneeName.ex.php +++ /dev/null @@ -1,102 +0,0 @@ - 1, - 'return' => [ - '0' => 'source_contact_name', - '1' => 'target_contact_name', - '2' => 'assignee_contact_name', - '3' => 'subject', - ], - ]; - - try { - $result = civicrm_api3('Activity', 'getsingle', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_getsingle_expectedresult() { - - $expectedResult = [ - 'id' => '1', - 'subject' => 'Make-it-Happen Meeting', - 'assignee_contact_id' => [], - 'assignee_contact_name' => [ - '5' => 'C Shore', - ], - 'assignee_contact_sort_name' => [ - '5' => 'Shore, C', - ], - 'source_contact_id' => '6', - 'source_contact_name' => 'D Bug', - 'source_contact_sort_name' => 'Bug, D', - 'target_contact_id' => [ - '1' => '4', - ], - 'target_contact_name' => [ - '3' => 'A Cat', - '4' => 'B Good', - ], - 'target_contact_sort_name' => [ - '3' => 'Cat, A', - '4' => 'Good, B', - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityReturnTargetAssigneeName" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Activity/ReturnAssigneeContact.ex.php b/api/v3/examples/Activity/ReturnAssigneeContact.ex.php deleted file mode 100644 index 8fa66eb2b5..0000000000 --- a/api/v3/examples/Activity/ReturnAssigneeContact.ex.php +++ /dev/null @@ -1,182 +0,0 @@ - 1, - 'sequential' => 1, - 'return.assignee_contact_id' => 1, - 'api.contact.get' => [ - 'id' => '$value.source_contact_id', - ], - 'return' => [ - '0' => 'activity_type_id', - '1' => 'subject', - ], - ]; - - try { - $result = civicrm_api3('Activity', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'activity_type_id' => '9999', - 'subject' => 'test activity type id', - 'source_contact_id' => '1', - 'source_contact_name' => 'Mr. Anthony Anderson II', - 'source_contact_sort_name' => 'Anderson, Anthony', - 'assignee_contact_id' => [ - '0' => '3', - ], - 'assignee_contact_name' => [ - '3' => 'The Rock roccky', - ], - 'assignee_contact_sort_name' => [ - '3' => 'roccky, The Rock', - ], - 'api.contact.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'contact_id' => '1', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Anderson, Anthony', - 'display_name' => 'Mr. Anthony Anderson II', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => 'Anthony', - 'middle_name' => 'J.', - 'last_name' => 'Anderson', - 'prefix_id' => '3', - 'suffix_id' => '3', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => '', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '1', - 'email' => 'anthony_anderson@civicrm.org', - 'on_hold' => 0, - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => 'Mr.', - 'individual_suffix' => 'II', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '1', - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityGetGoodID1" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ActivityContact/Create.ex.php b/api/v3/examples/ActivityContact/Create.ex.php deleted file mode 100644 index 925723407e..0000000000 --- a/api/v3/examples/ActivityContact/Create.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 3, - 'activity_id' => 1, - 'record_type_id' => 2, - ]; - - try { - $result = civicrm_api3('ActivityContact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_contact_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 4, - 'values' => [ - '4' => [ - 'id' => '4', - 'activity_id' => '1', - 'contact_id' => '3', - 'record_type_id' => '2', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateActivityContact" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ActivityContact/Delete.ex.php b/api/v3/examples/ActivityContact/Delete.ex.php deleted file mode 100644 index e37958d6f1..0000000000 --- a/api/v3/examples/ActivityContact/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 14, - ]; - - try { - $result = civicrm_api3('ActivityContact', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_contact_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteActivityContact" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ActivityType/Create.ex.php b/api/v3/examples/ActivityType/Create.ex.php deleted file mode 100644 index ca60925c1d..0000000000 --- a/api/v3/examples/ActivityType/Create.ex.php +++ /dev/null @@ -1,106 +0,0 @@ - '2', - 'label' => 'send out letters', - 'filter' => 0, - 'is_active' => 1, - 'is_optgroup' => 1, - 'is_default' => 0, - ]; - - try { - $result = civicrm_api3('ActivityType', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_type_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 859, - 'values' => [ - '859' => [ - 'id' => '859', - 'option_group_id' => '2', - 'label' => 'send out letters', - 'value' => '55', - 'name' => 'send out letters', - 'grouping' => '', - 'filter' => 0, - 'is_default' => 0, - 'weight' => '2', - 'description' => '', - 'is_optgroup' => '1', - 'is_reserved' => '', - 'is_active' => '1', - 'component_id' => '', - 'domain_id' => '', - 'visibility_id' => '', - 'icon' => '', - 'color' => '', - ], - ], - 'deprecated' => 'The ActivityType api is deprecated. Please use the OptionValue api instead.', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityTypeCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ActivityType/Get.ex.php b/api/v3/examples/ActivityType/Get.ex.php deleted file mode 100644 index 7ad7b6c026..0000000000 --- a/api/v3/examples/ActivityType/Get.ex.php +++ /dev/null @@ -1,113 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function activity_type_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 35, - 'values' => [ - '1' => 'Meeting', - '2' => 'Phone Call', - '3' => 'Email', - '4' => 'Outbound SMS', - '5' => 'Event Registration', - '6' => 'Contribution', - '7' => 'Membership Signup', - '8' => 'Membership Renewal', - '9' => 'Tell a Friend', - '10' => 'Pledge Acknowledgment', - '11' => 'Pledge Reminder', - '12' => 'Inbound Email', - '17' => 'Membership Renewal Reminder', - '19' => 'Bulk Email', - '22' => 'Print/Merge Document', - '34' => 'Mass SMS', - '35' => 'Change Membership Status', - '36' => 'Change Membership Type', - '37' => 'Cancel Recurring Contribution', - '38' => 'Update Recurring Contribution Billing Details', - '39' => 'Update Recurring Contribution', - '40' => 'Reminder Sent', - '41' => 'Export Accounting Batch', - '42' => 'Create Batch', - '43' => 'Edit Batch', - '44' => 'SMS delivery', - '45' => 'Inbound SMS', - '46' => 'Payment', - '47' => 'Refund', - '48' => 'Change Registration', - '49' => 'Downloaded Invoice', - '50' => 'Emailed Invoice', - '51' => 'Contact Merged', - '52' => 'Contact Deleted by Merge', - '54' => 'Failed Payment', - ], - 'deprecated' => 'The ActivityType api is deprecated. Please use the OptionValue api instead.', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityTypeGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Address/AddressLike.ex.php b/api/v3/examples/Address/AddressLike.ex.php deleted file mode 100644 index a3cd6c204a..0000000000 --- a/api/v3/examples/Address/AddressLike.ex.php +++ /dev/null @@ -1,87 +0,0 @@ - [ - 'LIKE' => '%mb%', - ], - 'sequential' => 1, - 'return' => 'street_address', - ]; - - try { - $result = civicrm_api3('Address', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function address_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '0' => [ - 'id' => '2', - 'street_address' => 'Ambachtstraat 23', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetAddressLikeSuccess" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Address/AddressParse.ex.php b/api/v3/examples/Address/AddressParse.ex.php deleted file mode 100644 index 8348056867..0000000000 --- a/api/v3/examples/Address/AddressParse.ex.php +++ /dev/null @@ -1,95 +0,0 @@ - 1, - 'street_address' => '54A Excelsior Ave. Apt 1C', - 'location_type_id' => 8, - 'contact_id' => 3, - ]; - - try { - $result = civicrm_api3('Address', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function address_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'contact_id' => '3', - 'location_type_id' => '8', - 'is_primary' => '1', - 'is_billing' => 0, - 'street_address' => '54A Excelsior Ave. Apt 1C', - 'street_number' => '54', - 'street_number_suffix' => 'A', - 'street_name' => 'Excelsior Ave.', - 'street_unit' => 'Apt 1C', - 'manual_geo_code' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateAddressParsing" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Address/AddressSort.ex.php b/api/v3/examples/Address/AddressSort.ex.php deleted file mode 100644 index 377645a7f6..0000000000 --- a/api/v3/examples/Address/AddressSort.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - [ - 'sort' => 'street_address DESC', - 'limit' => 2, - ], - 'sequential' => 1, - 'return' => 'street_address', - ]; - - try { - $result = civicrm_api3('Address', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function address_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '0' => [ - 'id' => '3', - 'street_address' => 'yzy', - ], - '1' => [ - 'id' => '2', - 'street_address' => 'Ambachtstraat 23', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetAddressSort" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Address/Create.ex.php b/api/v3/examples/Address/Create.ex.php deleted file mode 100644 index 5315e21774..0000000000 --- a/api/v3/examples/Address/Create.ex.php +++ /dev/null @@ -1,98 +0,0 @@ - 3, - 'street_name' => 'Ambachtstraat', - 'street_number' => '23', - 'street_address' => 'Ambachtstraat 23', - 'postal_code' => '6971 BN', - 'country_id' => '1152', - 'city' => 'Brummen', - 'is_primary' => 1, - ]; - - try { - $result = civicrm_api3('Address', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function address_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'contact_id' => '3', - 'location_type_id' => '1', - 'is_primary' => '1', - 'is_billing' => 0, - 'street_address' => 'Ambachtstraat 23', - 'street_number' => '23', - 'street_name' => 'Ambachtstraat', - 'city' => 'Brummen', - 'postal_code' => '6971 BN', - 'country_id' => '1152', - 'manual_geo_code' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateAddressDefaultLocation" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Address/Delete.ex.php b/api/v3/examples/Address/Delete.ex.php deleted file mode 100644 index b5583029df..0000000000 --- a/api/v3/examples/Address/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 2, - ]; - - try { - $result = civicrm_api3('Address', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function address_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteAddress" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Address/Get.ex.php b/api/v3/examples/Address/Get.ex.php deleted file mode 100644 index 26de9b1fba..0000000000 --- a/api/v3/examples/Address/Get.ex.php +++ /dev/null @@ -1,89 +0,0 @@ - 3, - 'street_name' => 'Ambachtstraat', - 'return' => [ - '0' => 'location_type_id', - '1' => 'is_primary', - '2' => 'street_address', - ], - ]; - - try { - $result = civicrm_api3('Address', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function address_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'location_type_id' => '27', - 'is_primary' => '1', - 'street_address' => 'Ambachtstraat 23', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetAddress" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Address/GetOptions.ex.php b/api/v3/examples/Address/GetOptions.ex.php deleted file mode 100644 index 15ca3de74b..0000000000 --- a/api/v3/examples/Address/GetOptions.ex.php +++ /dev/null @@ -1,81 +0,0 @@ - 'location_type_id', - ]; - - try { - $result = civicrm_api3('Address', 'getoptions', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function address_getoptions_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 5, - 'values' => [ - '5' => 'Billing', - '1' => 'Home', - '3' => 'Main', - '4' => 'Other', - '2' => 'Work', - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testLocationTypeGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ConstantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Batch/Create.ex.php b/api/v3/examples/Batch/Create.ex.php deleted file mode 100644 index 1148869837..0000000000 --- a/api/v3/examples/Batch/Create.ex.php +++ /dev/null @@ -1,101 +0,0 @@ - 'New_Batch_04', - 'title' => 'New Batch 04', - 'description' => 'This is description for New Batch 04', - 'total' => '400.44', - 'item_count' => 4, - 'id' => 5, - ]; - - try { - $result = civicrm_api3('Batch', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function batch_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 5, - 'values' => [ - '5' => [ - 'id' => '5', - 'name' => 'New_Batch_04', - 'title' => 'New Batch 04', - 'description' => 'This is description for New Batch 04', - 'created_id' => '', - 'created_date' => '', - 'modified_id' => '', - 'modified_date' => '', - 'saved_search_id' => '', - 'status_id' => '', - 'type_id' => '', - 'mode_id' => '', - 'total' => '400.44', - 'item_count' => '4', - 'payment_instrument_id' => '', - 'exported_date' => '', - 'data' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testUpdate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/BatchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Batch/Delete.ex.php b/api/v3/examples/Batch/Delete.ex.php deleted file mode 100644 index eb525d6271..0000000000 --- a/api/v3/examples/Batch/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 8, - ]; - - try { - $result = civicrm_api3('Batch', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function batch_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testBatchDeleteCorrectSyntax" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/BatchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Batch/Get.ex.php b/api/v3/examples/Batch/Get.ex.php deleted file mode 100644 index 3c46694d2f..0000000000 --- a/api/v3/examples/Batch/Get.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Batch', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function batch_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => 'Batch_433397', - 'title' => 'Batch_433397', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'status_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/BatchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Batch/Update.ex.php b/api/v3/examples/Batch/Update.ex.php deleted file mode 100644 index aa1a825a55..0000000000 --- a/api/v3/examples/Batch/Update.ex.php +++ /dev/null @@ -1,101 +0,0 @@ - 'New_Batch_04', - 'title' => 'New Batch 04', - 'description' => 'This is description for New Batch 04', - 'total' => '400.44', - 'item_count' => 4, - 'id' => 3, - ]; - - try { - $result = civicrm_api3('batch', 'update', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function batch_update_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'name' => 'New_Batch_04', - 'title' => 'New Batch 04', - 'description' => 'This is description for New Batch 04', - 'created_id' => '', - 'created_date' => '', - 'modified_id' => '', - 'modified_date' => '', - 'saved_search_id' => '', - 'status_id' => '', - 'type_id' => '', - 'mode_id' => '', - 'total' => '400.44', - 'item_count' => '4', - 'payment_instrument_id' => '', - 'exported_date' => '', - 'data' => '', - ], - ], - ]; - - return $expectedResult; -} - -/** -* This example has been generated from the API test suite. -* The test that created it is called -* testUpdate -* and can be found in -* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/BatchTest.php. -* -* You can see the outcome of the API tests at -* https://test.civicrm.org/job/CiviCRM-master-git/ -* -* To Learn about the API read -* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API -* -* Browse the api on your own site with the api explorer -* http://MYSITE.ORG/path/to/civicrm/api -* -* Read more about testing here -* http://wiki.civicrm.org/confluence/display/CRM/Testing -* -* API Standards documentation: -* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards -*/ diff --git a/api/v3/examples/Campaign/Create.ex.php b/api/v3/examples/Campaign/Create.ex.php deleted file mode 100644 index 70ec4f9881..0000000000 --- a/api/v3/examples/Campaign/Create.ex.php +++ /dev/null @@ -1,101 +0,0 @@ - 'campaign title', - 'description' => 'Call people, ask for money', - 'created_date' => 'first sat of July 2008', - ]; - - try { - $result = civicrm_api3('Campaign', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function campaign_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => 'campaign_title', - 'title' => 'campaign title', - 'description' => 'Call people, ask for money', - 'start_date' => '', - 'end_date' => '', - 'campaign_type_id' => '', - 'status_id' => '', - 'external_identifier' => '', - 'parent_id' => '', - 'is_active' => '1', - 'created_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'last_modified_id' => '', - 'last_modified_date' => '', - 'goal_general' => '', - 'goal_revenue' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateCampaign" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CampaignTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Campaign/Delete.ex.php b/api/v3/examples/Campaign/Delete.ex.php deleted file mode 100644 index d828dc8d6f..0000000000 --- a/api/v3/examples/Campaign/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 5, - ]; - - try { - $result = civicrm_api3('Campaign', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function campaign_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteCampaign" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CampaignTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Campaign/Get.ex.php b/api/v3/examples/Campaign/Get.ex.php deleted file mode 100644 index c7e1c27982..0000000000 --- a/api/v3/examples/Campaign/Get.ex.php +++ /dev/null @@ -1,87 +0,0 @@ - 'campaign title', - 'description' => 'Call people, ask for money', - 'created_date' => 'first sat of July 2008', - ]; - - try { - $result = civicrm_api3('Campaign', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function campaign_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'name' => 'campaign_title', - 'title' => 'campaign title', - 'description' => 'Call people, ask for money', - 'is_active' => '1', - 'created_date' => '2013-07-28 08:49:19', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetCampaign" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CampaignTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Case/Create.ex.php b/api/v3/examples/Case/Create.ex.php deleted file mode 100644 index 6f3d1abfe0..0000000000 --- a/api/v3/examples/Case/Create.ex.php +++ /dev/null @@ -1,92 +0,0 @@ - 1, - 'subject' => 'Test case', - 'contact_id' => 17, - 'custom_1' => 'custom string', - ]; - - try { - $result = civicrm_api3('Case', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function case_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'case_type_id' => '1', - 'subject' => 'Test case', - 'start_date' => '2013-07-29 00:00:00', - 'end_date' => '', - 'details' => '', - 'status_id' => '1', - 'is_deleted' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCaseCreateCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CaseTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/CaseContact/Create.ex.php b/api/v3/examples/CaseContact/Create.ex.php deleted file mode 100644 index b17fd8f5a3..0000000000 --- a/api/v3/examples/CaseContact/Create.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 2, - 'contact_id' => 20, - ]; - - try { - $result = civicrm_api3('CaseContact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function case_contact_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'case_id' => '2', - 'contact_id' => '20', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCaseContactCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CaseContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/CaseContact/Get.ex.php b/api/v3/examples/CaseContact/Get.ex.php deleted file mode 100644 index 6cf38ad0ee..0000000000 --- a/api/v3/examples/CaseContact/Get.ex.php +++ /dev/null @@ -1,82 +0,0 @@ - 19, - ]; - - try { - $result = civicrm_api3('CaseContact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function case_contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'case_id' => '2', - 'contact_id' => '19', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCaseContactGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CaseContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Constant/Get.ex.php b/api/v3/examples/Constant/Get.ex.php deleted file mode 100644 index 2ac3a47dbc..0000000000 --- a/api/v3/examples/Constant/Get.ex.php +++ /dev/null @@ -1,115 +0,0 @@ - 'activityType', - ]; - - try { - $result = civicrm_api3('Constant', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function constant_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 35, - 'values' => [ - '1' => 'Meeting', - '2' => 'Phone Call', - '3' => 'Email', - '4' => 'Outbound SMS', - '5' => 'Event Registration', - '6' => 'Contribution', - '7' => 'Membership Signup', - '8' => 'Membership Renewal', - '9' => 'Tell a Friend', - '10' => 'Pledge Acknowledgment', - '11' => 'Pledge Reminder', - '12' => 'Inbound Email', - '17' => 'Membership Renewal Reminder', - '19' => 'Bulk Email', - '22' => 'Print/Merge Document', - '34' => 'Mass SMS', - '35' => 'Change Membership Status', - '36' => 'Change Membership Type', - '37' => 'Cancel Recurring Contribution', - '38' => 'Update Recurring Contribution Billing Details', - '39' => 'Update Recurring Contribution', - '40' => 'Reminder Sent', - '41' => 'Export Accounting Batch', - '42' => 'Create Batch', - '43' => 'Edit Batch', - '44' => 'SMS delivery', - '45' => 'Inbound SMS', - '46' => 'Payment', - '47' => 'Refund', - '48' => 'Change Registration', - '49' => 'Downloaded Invoice', - '50' => 'Emailed Invoice', - '51' => 'Contact Merged', - '52' => 'Contact Deleted by Merge', - '54' => 'Failed Payment', - ], - 'deprecated' => 'The Constant api is deprecated as of CiviCRM 4.4. Please use the getoptions api action instead.', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testActivityType" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ConstantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/APIChainedArray.ex.php b/api/v3/examples/Contact/APIChainedArray.ex.php deleted file mode 100644 index 26085a0a4f..0000000000 --- a/api/v3/examples/Contact/APIChainedArray.ex.php +++ /dev/null @@ -1,235 +0,0 @@ - 3, - 'api.website.get' => [], - 'api.Contribution.get' => [ - 'total_amount' => '120.00', - ], - 'api.CustomValue.get' => 1, - 'api.Note.get' => 1, - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'xyz3, abc3', - 'display_name' => 'abc3 xyz3', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => 'abc3', - 'middle_name' => '', - 'last_name' => 'xyz3', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => '', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '3', - 'email' => 'man3@yahoo.com', - 'on_hold' => 0, - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => '', - 'individual_suffix' => '', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '3', - 'api.website.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'contact_id' => '3', - 'url' => 'https://civicrm.org', - ], - ], - ], - 'api.Contribution.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '0' => [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'xyz3, abc3', - 'display_name' => 'abc3 xyz3', - 'contribution_id' => '2', - 'currency' => 'USD', - 'contribution_recur_id' => '', - 'contribution_status_id' => '1', - 'contribution_campaign_id' => '', - 'payment_instrument_id' => '1', - 'receive_date' => '2011-01-01 00:00:00', - 'non_deductible_amount' => '10.00', - 'total_amount' => '120.00', - 'fee_amount' => '50.00', - 'net_amount' => '90.00', - 'trxn_id' => '12335', - 'invoice_id' => '67830', - 'invoice_number' => '', - 'contribution_cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'contribution_source' => 'SSF', - 'amount_level' => '', - 'is_test' => 0, - 'is_pay_later' => 0, - 'contribution_check_number' => '', - 'is_template' => 0, - 'financial_account_id' => '1', - 'accounting_code' => '4200', - 'campaign_id' => '', - 'contribution_campaign_title' => '', - 'financial_type_id' => '1', - 'financial_type' => 'Donation', - 'contribution_note' => '', - 'contribution_batch' => '', - 'contribution_recur_status' => 'Completed', - 'payment_instrument' => 'Credit Card', - 'contribution_status' => 'Completed', - 'check_number' => '', - 'instrument_id' => '1', - 'cancel_date' => '', - 'id' => '2', - 'contribution_type_id' => '1', - ], - ], - ], - 'api.CustomValue.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => [], - ], - 'api.Note.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => [], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetIndividualWithChainedArrays" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/APIChainedArrayFormats.ex.php b/api/v3/examples/Contact/APIChainedArrayFormats.ex.php deleted file mode 100644 index 1372a9a0c6..0000000000 --- a/api/v3/examples/Contact/APIChainedArrayFormats.ex.php +++ /dev/null @@ -1,171 +0,0 @@ - 3, - 'api.website.getValue' => [ - 'return' => 'url', - ], - 'api.Contribution.getCount' => [], - 'api.CustomValue.get' => 1, - 'api.Note.get' => 1, - 'api.Membership.getCount' => [], - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'xyz3, abc3', - 'display_name' => 'abc3 xyz3', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => 'abc3', - 'middle_name' => '', - 'last_name' => 'xyz3', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => '', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '3', - 'email' => 'man3@yahoo.com', - 'on_hold' => 0, - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => '', - 'individual_suffix' => '', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '3', - 'api.website.getValue' => 'https://civicrm.org', - 'api.Contribution.getCount' => 2, - 'api.CustomValue.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => [], - ], - 'api.Note.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => [], - ], - 'api.Membership.getCount' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetIndividualWithChainedArraysFormats" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/APIChainedArrayMultipleCustom.ex.php b/api/v3/examples/Contact/APIChainedArrayMultipleCustom.ex.php deleted file mode 100644 index f99ba59e90..0000000000 --- a/api/v3/examples/Contact/APIChainedArrayMultipleCustom.ex.php +++ /dev/null @@ -1,213 +0,0 @@ - 3, - 'api.website.getValue' => [ - 'return' => 'url', - ], - 'api.Contribution.getCount' => [], - 'api.CustomValue.get' => 1, - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'xyz3, abc3', - 'display_name' => 'abc3 xyz3', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => 'abc3', - 'middle_name' => '', - 'last_name' => 'xyz3', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => '', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '3', - 'email' => 'man3@yahoo.com', - 'on_hold' => 0, - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => '', - 'individual_suffix' => '', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '3', - 'api.website.getValue' => 'https://civicrm.org', - 'api.Contribution.getCount' => 2, - 'api.CustomValue.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 7, - 'values' => [ - '0' => [ - 'entity_id' => '3', - 'entity_table' => 'Contact', - 'latest' => 'value 4', - 'id' => '1', - ], - '1' => [ - 'entity_id' => '3', - 'entity_table' => 'Contact', - 'latest' => 'value 3', - 'id' => '2', - '1' => 'value 2', - '2' => 'value 3', - ], - '2' => [ - 'entity_id' => '3', - 'entity_table' => 'Contact', - 'latest' => '', - 'id' => '3', - '1' => 'warm beer', - '2' => '', - ], - '3' => [ - 'entity_id' => '3', - 'entity_table' => 'Contact', - 'latest' => '', - 'id' => '4', - '1' => '', - '2' => '', - ], - '4' => [ - 'entity_id' => '3', - 'entity_table' => 'Contact', - 'latest' => 'defaultValue', - 'id' => '5', - '1' => 'defaultValue', - ], - '5' => [ - 'entity_id' => '3', - 'entity_table' => 'Contact', - 'latest' => 'vegemite', - 'id' => '6', - '1' => 'vegemite', - ], - '6' => [ - 'entity_id' => '3', - 'entity_table' => 'Contact', - 'latest' => '', - 'id' => '7', - '1' => '', - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetIndividualWithChainedArraysAndMultipleCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.ex.php b/api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.ex.php deleted file mode 100644 index 5fb2e587e5..0000000000 --- a/api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.ex.php +++ /dev/null @@ -1,146 +0,0 @@ - 'batman', - 'contact_type' => 'Individual', - 'api.tag.create' => [ - 'name' => '$value.id', - 'description' => '$value.display_name', - 'format.only_id' => 1, - ], - 'api.entity_tag.create' => [ - 'tag_id' => '$value.api.tag.create', - ], - ]; - - try { - $result = civicrm_api3('Contact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'sort_name' => 'batman', - 'display_name' => 'batman', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'hash' => '67eac7789eaee00', - 'api_key' => '', - 'first_name' => '', - 'middle_name' => '', - 'last_name' => '', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'email_greeting_id' => '1', - 'email_greeting_custom' => '', - 'email_greeting_display' => '', - 'postal_greeting_id' => '1', - 'postal_greeting_custom' => '', - 'postal_greeting_display' => '', - 'addressee_id' => '1', - 'addressee_custom' => '', - 'addressee_display' => '', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'primary_contact_id' => '', - 'organization_name' => '', - 'sic_code' => '', - 'user_unique_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'api.tag.create' => 6, - 'api.entity_tag.create' => [ - 'is_error' => 0, - 'not_added' => 1, - 'added' => 1, - 'total_count' => 2, - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testChainingValuesCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/ChainTwoWebsites.ex.php b/api/v3/examples/Contact/ChainTwoWebsites.ex.php deleted file mode 100644 index 5e81a2ed56..0000000000 --- a/api/v3/examples/Contact/ChainTwoWebsites.ex.php +++ /dev/null @@ -1,222 +0,0 @@ - 'abc3', - 'last_name' => 'xyz3', - 'contact_type' => 'Individual', - 'email' => 'man3@yahoo.com', - 'api.contribution.create' => [ - 'receive_date' => '2010-01-01', - 'total_amount' => '100', - 'financial_type_id' => 1, - 'payment_instrument_id' => 1, - 'non_deductible_amount' => '10', - 'fee_amount' => '50', - 'net_amount' => '90', - 'trxn_id' => 15345, - 'invoice_id' => 67990, - 'source' => 'SSF', - 'contribution_status_id' => 1, - 'skipCleanMoney' => 1, - ], - 'api.website.create' => [ - 'url' => 'https://civicrm.org', - ], - 'api.website.create.2' => [ - 'url' => 'https://chained.org', - ], - ]; - - try { - $result = civicrm_api3('Contact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'sort_name' => 'xyz3, abc3', - 'display_name' => 'abc3 xyz3', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'hash' => '67eac7789eaee00', - 'api_key' => '', - 'first_name' => 'abc3', - 'middle_name' => '', - 'last_name' => 'xyz3', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'email_greeting_id' => '1', - 'email_greeting_custom' => '', - 'email_greeting_display' => '', - 'postal_greeting_id' => '1', - 'postal_greeting_custom' => '', - 'postal_greeting_display' => '', - 'addressee_id' => '1', - 'addressee_custom' => '', - 'addressee_display' => '', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'primary_contact_id' => '', - 'organization_name' => '', - 'sic_code' => '', - 'user_unique_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'api.contribution.create' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'contact_id' => '3', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '1', - 'receive_date' => '20100101000000', - 'non_deductible_amount' => '10', - 'total_amount' => '100', - 'fee_amount' => '50', - 'net_amount' => '90', - 'trxn_id' => '15345', - 'invoice_id' => '67990', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '1', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - ], - ], - ], - 'api.website.create' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'contact_id' => '3', - 'url' => 'https://civicrm.org', - 'website_type_id' => '', - ], - ], - ], - 'api.website.create.2' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '0' => [ - 'id' => '2', - 'contact_id' => '3', - 'url' => 'https://chained.org', - 'website_type_id' => '', - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateIndividualWithContributionDottedSyntax" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/ChainTwoWebsitesSyntax2.ex.php b/api/v3/examples/Contact/ChainTwoWebsitesSyntax2.ex.php deleted file mode 100644 index 09812436aa..0000000000 --- a/api/v3/examples/Contact/ChainTwoWebsitesSyntax2.ex.php +++ /dev/null @@ -1,227 +0,0 @@ - 'abc3', - 'last_name' => 'xyz3', - 'contact_type' => 'Individual', - 'email' => 'man3@yahoo.com', - 'api.contribution.create' => [ - 'receive_date' => '2010-01-01', - 'total_amount' => '100', - 'financial_type_id' => 1, - 'payment_instrument_id' => 1, - 'non_deductible_amount' => '10', - 'fee_amount' => '50', - 'net_amount' => '90', - 'trxn_id' => 12345, - 'invoice_id' => 67890, - 'source' => 'SSF', - 'contribution_status_id' => 1, - 'skipCleanMoney' => 1, - ], - 'api.website.create' => [ - '0' => [ - 'url' => 'https://civicrm.org', - ], - '1' => [ - 'url' => 'https://chained.org', - 'website_type_id' => 2, - ], - ], - ]; - - try { - $result = civicrm_api3('Contact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'sort_name' => 'xyz3, abc3', - 'display_name' => 'abc3 xyz3', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'hash' => '67eac7789eaee00', - 'api_key' => '', - 'first_name' => 'abc3', - 'middle_name' => '', - 'last_name' => 'xyz3', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'email_greeting_id' => '1', - 'email_greeting_custom' => '', - 'email_greeting_display' => '', - 'postal_greeting_id' => '1', - 'postal_greeting_custom' => '', - 'postal_greeting_display' => '', - 'addressee_id' => '1', - 'addressee_custom' => '', - 'addressee_display' => '', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'primary_contact_id' => '', - 'organization_name' => '', - 'sic_code' => '', - 'user_unique_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'api.contribution.create' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'contact_id' => '3', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '1', - 'receive_date' => '20100101000000', - 'non_deductible_amount' => '10', - 'total_amount' => '100', - 'fee_amount' => '50', - 'net_amount' => '90', - 'trxn_id' => '12345', - 'invoice_id' => '67890', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '1', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - ], - ], - ], - 'api.website.create' => [ - '0' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'contact_id' => '3', - 'url' => 'https://civicrm.org', - 'website_type_id' => '', - ], - ], - ], - '1' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '0' => [ - 'id' => '2', - 'contact_id' => '3', - 'url' => 'https://chained.org', - 'website_type_id' => '2', - ], - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateIndividualWithContributionChainedArrays" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/ContactIDOfLoggedInUserContactAPI.ex.php b/api/v3/examples/Contact/ContactIDOfLoggedInUserContactAPI.ex.php deleted file mode 100644 index 9f7c7c21b6..0000000000 --- a/api/v3/examples/Contact/ContactIDOfLoggedInUserContactAPI.ex.php +++ /dev/null @@ -1,148 +0,0 @@ - 'user_contact_id', - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'User 707727958, Logged In', - 'display_name' => 'Mr. Logged In User 707727958 II', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => 'Logged In', - 'middle_name' => 'J.', - 'last_name' => 'User 707727958', - 'prefix_id' => '3', - 'suffix_id' => '3', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => '', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '3', - 'email' => 'anthony_anderson@civicrm.org', - 'on_hold' => 0, - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => 'Mr.', - 'individual_suffix' => 'II', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '3', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testLoggedInUserAPISupportToken" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/Create.ex.php b/api/v3/examples/Contact/Create.ex.php deleted file mode 100644 index d8a5f6478d..0000000000 --- a/api/v3/examples/Contact/Create.ex.php +++ /dev/null @@ -1,132 +0,0 @@ - 'abc1', - 'contact_type' => 'Individual', - 'last_name' => 'xyz1', - 'custom_1' => 'custom string', - ]; - - try { - $result = civicrm_api3('Contact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'sort_name' => 'xyz1, abc1', - 'display_name' => 'abc1 xyz1', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'hash' => '67eac7789eaee00', - 'api_key' => '', - 'first_name' => 'abc1', - 'middle_name' => '', - 'last_name' => 'xyz1', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'email_greeting_id' => '1', - 'email_greeting_custom' => '', - 'email_greeting_display' => '', - 'postal_greeting_id' => '1', - 'postal_greeting_custom' => '', - 'postal_greeting_display' => '', - 'addressee_id' => '1', - 'addressee_custom' => '', - 'addressee_display' => '', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'primary_contact_id' => '', - 'organization_name' => '', - 'sic_code' => '', - 'user_unique_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateWithCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/CreateParticipantPayment.ex.php b/api/v3/examples/Contact/CreateParticipantPayment.ex.php deleted file mode 100644 index 307a4d1903..0000000000 --- a/api/v3/examples/Contact/CreateParticipantPayment.ex.php +++ /dev/null @@ -1,161 +0,0 @@ - 'Individual', - 'display_name' => 'dlobo', - 'api.participant' => [ - 'event_id' => 41, - 'status_id' => 1, - 'role_id' => 1, - 'format.only_id' => 1, - ], - 'api.contribution.create' => [ - 'financial_type_id' => 1, - 'total_amount' => 100, - 'format.only_id' => 1, - ], - 'api.participant_payment.create' => [ - 'contribution_id' => '$value.api.contribution.create', - 'participant_id' => '$value.api.participant', - ], - ]; - - try { - $result = civicrm_api3('Contact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 7, - 'values' => [ - '7' => [ - 'id' => '7', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'sort_name' => 'dlobo', - 'display_name' => 'dlobo', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'hash' => '67eac7789eaee00', - 'api_key' => '', - 'first_name' => '', - 'middle_name' => '', - 'last_name' => '', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'email_greeting_id' => '1', - 'email_greeting_custom' => '', - 'email_greeting_display' => '', - 'postal_greeting_id' => '1', - 'postal_greeting_custom' => '', - 'postal_greeting_display' => '', - 'addressee_id' => '1', - 'addressee_custom' => '', - 'addressee_display' => '', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'primary_contact_id' => '', - 'organization_name' => '', - 'sic_code' => '', - 'user_unique_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'api.participant' => 4, - 'api.contribution.create' => 1, - 'api.participant_payment.create' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'participant_id' => '4', - 'contribution_id' => '1', - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateParticipantWithPayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/CustomFieldGet.ex.php b/api/v3/examples/Contact/CustomFieldGet.ex.php deleted file mode 100644 index bac9895300..0000000000 --- a/api/v3/examples/Contact/CustomFieldGet.ex.php +++ /dev/null @@ -1,86 +0,0 @@ - 1, - 'id' => 3, - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'contact_id' => '3', - 'civicrm_value_testgetwithcu_1_id' => '1', - 'custom_1' => 'custom string', - 'id' => '3', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetWithCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.ex.php b/api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.ex.php deleted file mode 100644 index 0c07d8763f..0000000000 --- a/api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.ex.php +++ /dev/null @@ -1,86 +0,0 @@ - 'custom_1', - 'id' => 3, - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'contact_id' => '3', - 'civicrm_value_testgetwithcu_1_id' => '1', - 'custom_1' => 'custom string', - 'id' => '3', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetWithCustomReturnSyntax" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/Delete.ex.php b/api/v3/examples/Contact/Delete.ex.php deleted file mode 100644 index 5041f0ba82..0000000000 --- a/api/v3/examples/Contact/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('Contact', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/FormatIsSuccess_Fail.ex.php b/api/v3/examples/Contact/FormatIsSuccess_Fail.ex.php deleted file mode 100644 index b89dcd7dc9..0000000000 --- a/api/v3/examples/Contact/FormatIsSuccess_Fail.ex.php +++ /dev/null @@ -1,74 +0,0 @@ - 500, - 'format.is_success' => 1, - ]; - - try { - $result = civicrm_api3('Contact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_create_expectedresult() { - - $expectedResult = 0; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactCreateFormatIsSuccessFalse" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/FormatIsSuccess_True.ex.php b/api/v3/examples/Contact/FormatIsSuccess_True.ex.php deleted file mode 100644 index 8322e4af31..0000000000 --- a/api/v3/examples/Contact/FormatIsSuccess_True.ex.php +++ /dev/null @@ -1,74 +0,0 @@ - 3, - 'format.is_success' => 1, - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = 1; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactGetFormatIsSuccessTrue" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/FormatOnlyID.ex.php b/api/v3/examples/Contact/FormatOnlyID.ex.php deleted file mode 100644 index 215e1b3990..0000000000 --- a/api/v3/examples/Contact/FormatOnlyID.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - 'format.only_id' => 1, - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = 3; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactGetFormatIDOnly" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/FormatSingleValue.ex.php b/api/v3/examples/Contact/FormatSingleValue.ex.php deleted file mode 100644 index 4ef40d85e2..0000000000 --- a/api/v3/examples/Contact/FormatSingleValue.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - 'return' => 'display_name', - ]; - - try { - $result = civicrm_api3('Contact', 'getvalue', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getvalue_expectedresult() { - - $expectedResult = 'Mr. Test Contact II'; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactGetFormatSingleValue" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/Get.ex.php b/api/v3/examples/Contact/Get.ex.php deleted file mode 100644 index 168d15d1c6..0000000000 --- a/api/v3/examples/Contact/Get.ex.php +++ /dev/null @@ -1,146 +0,0 @@ - 'man2@yahoo.com', - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'man2@yahoo.com', - 'display_name' => 'man2@yahoo.com', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => '', - 'middle_name' => '', - 'last_name' => '', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => '', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '3', - 'email' => 'man2@yahoo.com', - 'on_hold' => 0, - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => '', - 'individual_suffix' => '', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '3', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactGetEmail" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GetActions.ex.php b/api/v3/examples/Contact/GetActions.ex.php deleted file mode 100644 index d531d17f62..0000000000 --- a/api/v3/examples/Contact/GetActions.ex.php +++ /dev/null @@ -1,110 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getactions_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 29, - 'values' => [ - '0' => 'create', - '1' => 'delete', - '2' => 'duplicatecheck', - '3' => 'example_action1', - '4' => 'example_action2', - '5' => 'get', - '6' => 'get_merge_conflicts', - '7' => 'getactions', - '8' => 'getcount', - '9' => 'getfield', - '10' => 'getfields', - '11' => 'getlist', - '12' => 'getmergedfrom', - '13' => 'getmergedto', - '14' => 'getoptions', - '15' => 'getquick', - '16' => 'getrefcount', - '17' => 'getsingle', - '18' => 'getunique', - '19' => 'getvalue', - '20' => 'merge', - '21' => 'proximity', - '22' => 'replace', - '23' => 'setvalue', - '24' => 'type_create', - '25' => 'type_delete', - '26' => 'type_get', - '27' => 'update', - '28' => 'validate', - ], - 'deprecated' => [ - 'getquick' => 'The "getquick" action is deprecated in favor of "getlist".', - 'setvalue' => 'The "setvalue" action is deprecated. Use "create" with an id instead.', - 'update' => 'The "update" action is deprecated. Use "create" with an id instead.', - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetActions" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GetCountContact.ex.php b/api/v3/examples/Contact/GetCountContact.ex.php deleted file mode 100644 index 44e4562672..0000000000 --- a/api/v3/examples/Contact/GetCountContact.ex.php +++ /dev/null @@ -1,73 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('Contact', 'getcount', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getcount_expectedresult() { - - $expectedResult = 1; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactGetFormatCountOnly" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GetFieldsOptions.ex.php b/api/v3/examples/Contact/GetFieldsOptions.ex.php deleted file mode 100644 index cf984e1d4e..0000000000 --- a/api/v3/examples/Contact/GetFieldsOptions.ex.php +++ /dev/null @@ -1,1334 +0,0 @@ - [ - 'get_options' => 'custom_1', - ], - 'action' => 'create', - ]; - - try { - $result = civicrm_api3('Contact', 'getfields', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getfields_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 56, - 'values' => [ - 'id' => [ - 'name' => 'id', - 'type' => 1, - 'title' => 'Contact ID', - 'description' => 'Unique Contact ID', - 'required' => TRUE, - 'import' => TRUE, - 'where' => 'civicrm_contact.id', - 'headerPattern' => '/internal|contact?|id$/i', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Number', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.aliases' => [ - '0' => 'contact_id', - ], - ], - 'contact_type' => [ - 'name' => 'contact_type', - 'type' => 2, - 'title' => 'Contact Type', - 'description' => 'Type of Contact.', - 'maxlength' => 64, - 'size' => 30, - 'where' => 'civicrm_contact.contact_type', - 'export' => TRUE, - 'contactType' => '', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'maxlength' => 64, - 'size' => 30, - ], - 'pseudoconstant' => [ - 'table' => 'civicrm_contact_type', - 'keyColumn' => 'name', - 'labelColumn' => 'label', - 'condition' => 'parent_id IS NULL', - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.required' => 1, - ], - 'contact_sub_type' => [ - 'name' => 'contact_sub_type', - 'type' => 2, - 'title' => 'Contact Subtype', - 'description' => 'May be used to over-ride contact view and edit templates.', - 'maxlength' => 255, - 'size' => 45, - 'import' => TRUE, - 'where' => 'civicrm_contact.contact_sub_type', - 'headerPattern' => '/C(ontact )?(subtype|sub-type|sub type)/i', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'serialize' => 1, - 'html' => [ - 'type' => 'Select', - 'maxlength' => 255, - 'size' => 45, - ], - 'pseudoconstant' => [ - 'table' => 'civicrm_contact_type', - 'keyColumn' => 'name', - 'labelColumn' => 'label', - 'condition' => 'parent_id IS NOT NULL', - ], - 'add' => '1.5', - 'is_core_field' => TRUE, - ], - 'do_not_email' => [ - 'name' => 'do_not_email', - 'type' => 16, - 'title' => 'Do Not Email', - 'import' => TRUE, - 'where' => 'civicrm_contact.do_not_email', - 'headerPattern' => '/d(o )?(not )?(email)/i', - 'dataPattern' => '/^\\d{1,}$/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - 'label' => 'Do Not Email', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'do_not_phone' => [ - 'name' => 'do_not_phone', - 'type' => 16, - 'title' => 'Do Not Phone', - 'import' => TRUE, - 'where' => 'civicrm_contact.do_not_phone', - 'headerPattern' => '/d(o )?(not )?(call|phone)/i', - 'dataPattern' => '/^\\d{1,}$/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - 'label' => 'Do Not Phone', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'do_not_mail' => [ - 'name' => 'do_not_mail', - 'type' => 16, - 'title' => 'Do Not Mail', - 'import' => TRUE, - 'where' => 'civicrm_contact.do_not_mail', - 'headerPattern' => '/^(d(o\\s)?n(ot\\s)?mail)|(\\w*)?bulk\\s?(\\w*)$/i', - 'dataPattern' => '/^\\d{1,}$/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - 'label' => 'Do Not Mail', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'do_not_sms' => [ - 'name' => 'do_not_sms', - 'type' => 16, - 'title' => 'Do Not Sms', - 'import' => TRUE, - 'where' => 'civicrm_contact.do_not_sms', - 'headerPattern' => '/d(o )?(not )?(sms)/i', - 'dataPattern' => '/^\\d{1,}$/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - 'label' => 'Do Not Sms', - ], - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'do_not_trade' => [ - 'name' => 'do_not_trade', - 'type' => 16, - 'title' => 'Do Not Trade', - 'import' => TRUE, - 'where' => 'civicrm_contact.do_not_trade', - 'headerPattern' => '/d(o )?(not )?(trade)/i', - 'dataPattern' => '/^\\d{1,}$/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - 'label' => 'Do Not Trade', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'is_opt_out' => [ - 'name' => 'is_opt_out', - 'type' => 16, - 'title' => 'No Bulk Emails (User Opt Out)', - 'description' => 'Has the contact opted out from receiving all bulk email from the organization or site domain?', - 'required' => TRUE, - 'import' => TRUE, - 'where' => 'civicrm_contact.is_opt_out', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - 'label' => 'Is Opt Out', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'legal_identifier' => [ - 'name' => 'legal_identifier', - 'type' => 2, - 'title' => 'Legal Identifier', - 'description' => 'May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID.', - 'maxlength' => 32, - 'size' => 20, - 'import' => TRUE, - 'where' => 'civicrm_contact.legal_identifier', - 'headerPattern' => '/legal\\s?id/i', - 'dataPattern' => '/\\w+?\\d{5,}/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Legal Identifier', - 'maxlength' => 32, - 'size' => 20, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'external_identifier' => [ - 'name' => 'external_identifier', - 'type' => 2, - 'title' => 'External Identifier', - 'description' => 'Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations.', - 'maxlength' => 64, - 'size' => 8, - 'import' => TRUE, - 'where' => 'civicrm_contact.external_identifier', - 'headerPattern' => '/external\\s?id/i', - 'dataPattern' => '/^\\d{11,}$/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'External Identifier', - 'maxlength' => 64, - 'size' => 8, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'sort_name' => [ - 'name' => 'sort_name', - 'type' => 2, - 'title' => 'Sort Name', - 'description' => 'Name used for sorting different contact types', - 'maxlength' => 128, - 'size' => 30, - 'where' => 'civicrm_contact.sort_name', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 128, - 'size' => 30, - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'display_name' => [ - 'name' => 'display_name', - 'type' => 2, - 'title' => 'Display Name', - 'description' => 'Formatted name representing preferred format for display/print/other output.', - 'maxlength' => 128, - 'size' => 30, - 'where' => 'civicrm_contact.display_name', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 128, - 'size' => 30, - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'nick_name' => [ - 'name' => 'nick_name', - 'type' => 2, - 'title' => 'Nickname', - 'description' => 'Nickname.', - 'maxlength' => 128, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.nick_name', - 'headerPattern' => '/n(ick\\s)name|nick$/i', - 'dataPattern' => '/^\\w+$/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 128, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'legal_name' => [ - 'name' => 'legal_name', - 'type' => 2, - 'title' => 'Legal Name', - 'description' => 'Legal Name.', - 'maxlength' => 128, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.legal_name', - 'headerPattern' => '/^legal|(l(egal\\s)?name)$/i', - 'export' => TRUE, - 'contactType' => 'Organization', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Legal Name', - 'maxlength' => 128, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'image_URL' => [ - 'name' => 'image_URL', - 'type' => 32, - 'title' => 'Image Url', - 'description' => 'optional URL for preferred image (photo, logo, etc.) to display for this contact.', - 'import' => TRUE, - 'where' => 'civicrm_contact.image_URL', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'File', - 'label' => 'Image URL', - 'rows' => 2, - 'cols' => 80, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'preferred_communication_method' => [ - 'name' => 'preferred_communication_method', - 'type' => 2, - 'title' => 'Preferred Communication Method', - 'description' => 'What is the preferred mode of communication.', - 'maxlength' => 255, - 'size' => 45, - 'import' => TRUE, - 'where' => 'civicrm_contact.preferred_communication_method', - 'headerPattern' => '/^p(ref\\w*\\s)?c(omm\\w*)|( meth\\w*)$/i', - 'dataPattern' => '/^\\w+$/', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'serialize' => 1, - 'html' => [ - 'type' => 'Select', - 'maxlength' => 255, - 'size' => 45, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'preferred_communication_method', - 'optionEditPath' => 'civicrm/admin/options/preferred_communication_method', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'preferred_language' => [ - 'name' => 'preferred_language', - 'type' => 2, - 'title' => 'Preferred Language', - 'description' => 'Which language is preferred for communication. FK to languages in civicrm_option_value.', - 'maxlength' => 5, - 'size' => 6, - 'import' => TRUE, - 'where' => 'civicrm_contact.preferred_language', - 'headerPattern' => '/^lang/i', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'maxlength' => 5, - 'size' => 6, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'languages', - 'keyColumn' => 'name', - 'optionEditPath' => 'civicrm/admin/options/languages', - ], - 'add' => '3.2', - 'is_core_field' => TRUE, - ], - 'hash' => [ - 'name' => 'hash', - 'type' => 2, - 'title' => 'Contact Hash', - 'description' => 'Key for validating requests related to this contact.', - 'maxlength' => 32, - 'size' => 20, - 'where' => 'civicrm_contact.hash', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'api_key' => [ - 'name' => 'api_key', - 'type' => 2, - 'title' => 'Api Key', - 'description' => 'API Key for validating requests related to this contact.', - 'maxlength' => 32, - 'size' => 20, - 'where' => 'civicrm_contact.api_key', - 'permission' => [ - '0' => [ - '0' => 'administer CiviCRM', - '1' => 'edit api keys', - ], - ], - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'label' => 'API KEY', - 'maxlength' => 32, - 'size' => 20, - ], - 'readonly' => TRUE, - 'add' => '2.2', - 'is_core_field' => TRUE, - ], - 'first_name' => [ - 'name' => 'first_name', - 'type' => 2, - 'title' => 'First Name', - 'description' => 'First Name.', - 'maxlength' => 64, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.first_name', - 'headerPattern' => '/^first|(f(irst\\s)?name)$/i', - 'dataPattern' => '/^\\w+$/', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'First Name', - 'maxlength' => 64, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'middle_name' => [ - 'name' => 'middle_name', - 'type' => 2, - 'title' => 'Middle Name', - 'description' => 'Middle Name.', - 'maxlength' => 64, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.middle_name', - 'headerPattern' => '/^middle|(m(iddle\\s)?name)$/i', - 'dataPattern' => '/^\\w+$/', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Middle Name', - 'maxlength' => 64, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'last_name' => [ - 'name' => 'last_name', - 'type' => 2, - 'title' => 'Last Name', - 'description' => 'Last Name.', - 'maxlength' => 64, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.last_name', - 'headerPattern' => '/^last|(l(ast\\s)?name)$/i', - 'dataPattern' => '/^\\w+(\\s\\w+)?+$/', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Last Name', - 'maxlength' => 64, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'prefix_id' => [ - 'name' => 'prefix_id', - 'type' => 1, - 'title' => 'Individual Prefix', - 'description' => 'Prefix or Title for name (Ms, Mr...). FK to prefix ID', - 'import' => TRUE, - 'where' => 'civicrm_contact.prefix_id', - 'headerPattern' => '/^(prefix|title)/i', - 'dataPattern' => '/^(mr|ms|mrs|sir|dr)\\.?$/i', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'individual_prefix', - 'optionEditPath' => 'civicrm/admin/options/individual_prefix', - ], - 'add' => '1.2', - 'is_core_field' => TRUE, - 'api.aliases' => [ - '0' => 'individual_prefix', - '1' => 'individual_prefix_id', - ], - ], - 'suffix_id' => [ - 'name' => 'suffix_id', - 'type' => 1, - 'title' => 'Individual Suffix', - 'description' => 'Suffix for name (Jr, Sr...). FK to suffix ID', - 'import' => TRUE, - 'where' => 'civicrm_contact.suffix_id', - 'headerPattern' => '/^suffix$/i', - 'dataPattern' => '/^(sr|jr)\\.?|i{2,}$/', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'individual_suffix', - 'optionEditPath' => 'civicrm/admin/options/individual_suffix', - ], - 'add' => '1.2', - 'is_core_field' => TRUE, - 'api.aliases' => [ - '0' => 'individual_suffix', - '1' => 'individual_suffix_id', - ], - ], - 'formal_title' => [ - 'name' => 'formal_title', - 'type' => 2, - 'title' => 'Formal Title', - 'description' => 'Formal (academic or similar) title in front of name. (Prof., Dr. etc.)', - 'maxlength' => 64, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.formal_title', - 'headerPattern' => '/^title/i', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Formal Title', - 'maxlength' => 64, - 'size' => 30, - ], - 'add' => '4.5', - 'is_core_field' => TRUE, - ], - 'communication_style_id' => [ - 'name' => 'communication_style_id', - 'type' => 1, - 'title' => 'Communication Style', - 'description' => 'Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value.', - 'import' => TRUE, - 'where' => 'civicrm_contact.communication_style_id', - 'headerPattern' => '/style/i', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'communication_style', - 'optionEditPath' => 'civicrm/admin/options/communication_style', - ], - 'add' => '4.4', - 'is_core_field' => TRUE, - ], - 'email_greeting_id' => [ - 'name' => 'email_greeting_id', - 'type' => 1, - 'title' => 'Email Greeting ID', - 'description' => 'FK to civicrm_option_value.id, that has to be valid registered Email Greeting.', - 'where' => 'civicrm_contact.email_greeting_id', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'email_greeting', - 'optionEditPath' => 'civicrm/admin/options/email_greeting', - ], - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'email_greeting_custom' => [ - 'name' => 'email_greeting_custom', - 'type' => 2, - 'title' => 'Email Greeting Custom', - 'description' => 'Custom Email Greeting.', - 'maxlength' => 128, - 'size' => 45, - 'import' => TRUE, - 'where' => 'civicrm_contact.email_greeting_custom', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Email Greeting Custom', - 'maxlength' => 128, - 'size' => 45, - ], - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'email_greeting_display' => [ - 'name' => 'email_greeting_display', - 'type' => 2, - 'title' => 'Email Greeting', - 'description' => 'Cache Email Greeting.', - 'maxlength' => 255, - 'size' => 45, - 'where' => 'civicrm_contact.email_greeting_display', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'readonly' => TRUE, - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'postal_greeting_id' => [ - 'name' => 'postal_greeting_id', - 'type' => 1, - 'title' => 'Postal Greeting ID', - 'description' => 'FK to civicrm_option_value.id, that has to be valid registered Postal Greeting.', - 'where' => 'civicrm_contact.postal_greeting_id', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'postal_greeting', - 'optionEditPath' => 'civicrm/admin/options/postal_greeting', - ], - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'postal_greeting_custom' => [ - 'name' => 'postal_greeting_custom', - 'type' => 2, - 'title' => 'Postal Greeting Custom', - 'description' => 'Custom Postal greeting.', - 'maxlength' => 128, - 'size' => 45, - 'import' => TRUE, - 'where' => 'civicrm_contact.postal_greeting_custom', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Postal Greeting Custom', - 'maxlength' => 128, - 'size' => 45, - ], - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'postal_greeting_display' => [ - 'name' => 'postal_greeting_display', - 'type' => 2, - 'title' => 'Postal Greeting', - 'description' => 'Cache Postal greeting.', - 'maxlength' => 255, - 'size' => 45, - 'where' => 'civicrm_contact.postal_greeting_display', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'readonly' => TRUE, - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'addressee_id' => [ - 'name' => 'addressee_id', - 'type' => 1, - 'title' => 'Addressee ID', - 'description' => 'FK to civicrm_option_value.id, that has to be valid registered Addressee.', - 'where' => 'civicrm_contact.addressee_id', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'addressee', - 'optionEditPath' => 'civicrm/admin/options/addressee', - ], - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'addressee_custom' => [ - 'name' => 'addressee_custom', - 'type' => 2, - 'title' => 'Addressee Custom', - 'description' => 'Custom Addressee.', - 'maxlength' => 128, - 'size' => 45, - 'import' => TRUE, - 'where' => 'civicrm_contact.addressee_custom', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Addressee Custom', - 'maxlength' => 128, - 'size' => 45, - ], - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'addressee_display' => [ - 'name' => 'addressee_display', - 'type' => 2, - 'title' => 'Addressee', - 'description' => 'Cache Addressee.', - 'maxlength' => 255, - 'size' => 45, - 'where' => 'civicrm_contact.addressee_display', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'readonly' => TRUE, - 'add' => '3.0', - 'is_core_field' => TRUE, - ], - 'job_title' => [ - 'name' => 'job_title', - 'type' => 2, - 'title' => 'Job Title', - 'description' => 'Job Title', - 'maxlength' => 255, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.job_title', - 'headerPattern' => '/^job|(j(ob\\s)?title)$/i', - 'dataPattern' => '//', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Job Title', - 'maxlength' => 255, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'gender_id' => [ - 'name' => 'gender_id', - 'type' => 1, - 'title' => 'Gender ID', - 'description' => 'FK to gender ID', - 'import' => TRUE, - 'where' => 'civicrm_contact.gender_id', - 'headerPattern' => '/^gender$/i', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'label' => 'Gender', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'gender', - 'optionEditPath' => 'civicrm/admin/options/gender', - ], - 'add' => '1.2', - 'is_core_field' => TRUE, - 'api.aliases' => [ - '0' => 'gender', - ], - ], - 'birth_date' => [ - 'name' => 'birth_date', - 'type' => 4, - 'title' => 'Birth Date', - 'description' => 'Date of birth', - 'import' => TRUE, - 'where' => 'civicrm_contact.birth_date', - 'headerPattern' => '/^birth|(b(irth\\s)?date)|D(\\W*)O(\\W*)B(\\W*)$/i', - 'dataPattern' => '/\\d{4}-?\\d{2}-?\\d{2}/', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select Date', - 'formatType' => 'birth', - 'label' => 'Birth Date', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'is_deceased' => [ - 'name' => 'is_deceased', - 'type' => 16, - 'title' => 'Deceased', - 'required' => TRUE, - 'import' => TRUE, - 'where' => 'civicrm_contact.is_deceased', - 'headerPattern' => '/i(s\\s)?d(eceased)$/i', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - 'label' => 'Is Deceased', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'deceased_date' => [ - 'name' => 'deceased_date', - 'type' => 4, - 'title' => 'Deceased Date', - 'description' => 'Date of deceased', - 'import' => TRUE, - 'where' => 'civicrm_contact.deceased_date', - 'headerPattern' => '/^deceased|(d(eceased\\s)?date)$/i', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select Date', - 'formatType' => 'birth', - 'label' => 'Deceased Date', - ], - 'add' => '1.5', - 'is_core_field' => TRUE, - ], - 'household_name' => [ - 'name' => 'household_name', - 'type' => 2, - 'title' => 'Household Name', - 'description' => 'Household Name.', - 'maxlength' => 128, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.household_name', - 'headerPattern' => '/^household|(h(ousehold\\s)?name)$/i', - 'dataPattern' => '/^\\w+$/', - 'export' => TRUE, - 'contactType' => 'Household', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Household Name', - 'maxlength' => 128, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'primary_contact_id' => [ - 'name' => 'primary_contact_id', - 'type' => 1, - 'title' => 'Household Primary Contact ID', - 'description' => 'Optional FK to Primary Contact for this household.', - 'where' => 'civicrm_contact.primary_contact_id', - 'contactType' => 'Household', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'html' => [ - 'label' => 'Household Primary Contact', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'FKApiName' => 'Contact', - ], - 'organization_name' => [ - 'name' => 'organization_name', - 'type' => 2, - 'title' => 'Organization Name', - 'description' => 'Organization Name.', - 'maxlength' => 128, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.organization_name', - 'headerPattern' => '/^organization|(o(rganization\\s)?name)$/i', - 'dataPattern' => '/^\\w+$/', - 'export' => TRUE, - 'contactType' => 'Organization', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Organization Name', - 'maxlength' => 128, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'sic_code' => [ - 'name' => 'sic_code', - 'type' => 2, - 'title' => 'Sic Code', - 'description' => 'Standard Industry Classification Code.', - 'maxlength' => 8, - 'size' => 8, - 'import' => TRUE, - 'where' => 'civicrm_contact.sic_code', - 'headerPattern' => '/^sic|(s(ic\\s)?code)$/i', - 'export' => TRUE, - 'contactType' => 'Organization', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'SIC Code', - 'maxlength' => 8, - 'size' => 8, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'user_unique_id' => [ - 'name' => 'user_unique_id', - 'type' => 2, - 'title' => 'Unique ID (OpenID)', - 'description' => 'the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM', - 'maxlength' => 255, - 'size' => 45, - 'import' => TRUE, - 'where' => 'civicrm_contact.user_unique_id', - 'headerPattern' => '/^Open\\s?ID|u(niq\\w*)?\\s?ID/i', - 'dataPattern' => '/^[\\w\\/\\:\\.]+$/', - 'export' => TRUE, - 'rule' => 'url', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 255, - 'size' => 45, - ], - 'add' => '2.0', - 'is_core_field' => TRUE, - ], - 'created_date' => [ - 'name' => 'created_date', - 'type' => 256, - 'title' => 'Created Date', - 'description' => 'When was the contact was created.', - 'required' => '', - 'where' => 'civicrm_contact.created_date', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'label' => 'Created Date', - ], - 'add' => '4.3', - 'is_core_field' => TRUE, - ], - 'modified_date' => [ - 'name' => 'modified_date', - 'type' => 256, - 'title' => 'Modified Date', - 'description' => 'When was the contact (or closely related entity) was created or modified or deleted.', - 'required' => '', - 'where' => 'civicrm_contact.modified_date', - 'export' => TRUE, - 'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'label' => 'Modified Date', - ], - 'readonly' => TRUE, - 'add' => '4.3', - 'is_core_field' => TRUE, - ], - 'source' => [ - 'name' => 'source', - 'type' => 2, - 'title' => 'Contact Source', - 'description' => 'where contact come from, e.g. import, donate module insert...', - 'maxlength' => 255, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.source', - 'headerPattern' => '/(C(ontact\\s)?Source)$/i', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 255, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'uniqueName' => 'contact_source', - ], - 'employer_id' => [ - 'name' => 'employer_id', - 'type' => 1, - 'title' => 'Current Employer ID', - 'description' => 'OPTIONAL FK to civicrm_contact record.', - 'where' => 'civicrm_contact.employer_id', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'html' => [ - 'type' => 'EntityRef', - 'label' => 'Current Employer', - 'size' => 6, - 'maxlength' => 14, - ], - 'add' => '2.1', - 'is_core_field' => TRUE, - 'uniqueName' => 'current_employer_id', - 'FKApiName' => 'Contact', - ], - 'is_deleted' => [ - 'name' => 'is_deleted', - 'type' => 16, - 'title' => 'Contact is in Trash', - 'required' => TRUE, - 'where' => 'civicrm_contact.is_deleted', - 'export' => TRUE, - 'table_name' => 'civicrm_contact', - 'entity' => 'Contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'CheckBox', - ], - 'add' => '3.2', - 'is_core_field' => TRUE, - 'uniqueName' => 'contact_is_deleted', - ], - 'custom_1' => [ - 'id' => '1', - 'label' => 'Our special field', - 'headerPattern' => '//', - 'title' => 'Our special field', - 'custom_field_id' => '1', - 'groupTitle' => 'select_test_group', - 'data_type' => 'String', - 'name' => 'custom_1', - 'type' => 2, - 'html_type' => 'Select', - 'default_value' => '', - 'text_length' => '', - 'options_per_line' => '', - 'custom_group_id' => '1', - 'extends' => 'Contact', - 'is_search_range' => 0, - 'extends_entity_column_value' => '', - 'extends_entity_column_id' => '', - 'is_view' => 0, - 'is_multiple' => 0, - 'option_group_id' => '109', - 'date_format' => '', - 'time_format' => '', - 'is_required' => '1', - 'table_name' => 'civicrm_value_select_test_g_1', - 'column_name' => 'our_special_field_1', - 'serialize' => 0, - 'where' => 'civicrm_value_select_test_g_1.our_special_field_1', - 'extends_table' => 'civicrm_contact', - 'search_table' => 'contact_a', - 'pseudoconstant' => [ - 'optionGroupName' => 'our_special_field_20220117122549', - 'optionEditPath' => 'civicrm/admin/options/our_special_field_20220117122549', - ], - 'options' => [ - '1' => 'Label1', - '2' => 'Label2', - ], - ], - 'current_employer' => [ - 'title' => 'Current Employer', - 'description' => 'Name of Current Employer', - 'type' => 2, - 'name' => 'current_employer', - ], - 'dupe_check' => [ - 'title' => 'Check for Duplicates', - 'description' => 'Throw error if contact create matches dedupe rule', - 'type' => 16, - 'name' => 'dupe_check', - ], - 'skip_greeting_processing' => [ - 'title' => 'Skip Greeting processing', - 'description' => 'Do not process greetings, (these can be done by scheduled job and there may be a preference to do so for performance reasons)', - 'type' => 16, - 'api.default' => 0, - 'name' => 'skip_greeting_processing', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCustomFieldCreateWithOptionValues" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GetMergedfrom.ex.php b/api/v3/examples/Contact/GetMergedfrom.ex.php deleted file mode 100644 index bab1e98219..0000000000 --- a/api/v3/examples/Contact/GetMergedfrom.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 4, - ]; - - try { - $result = civicrm_api3('Contact', 'getmergedfrom', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getmergedfrom_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - ], - '5' => [ - 'id' => '5', - ], - '6' => [ - 'id' => '6', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMergedGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GetMergedto.ex.php b/api/v3/examples/Contact/GetMergedto.ex.php deleted file mode 100644 index 4746b88c42..0000000000 --- a/api/v3/examples/Contact/GetMergedto.ex.php +++ /dev/null @@ -1,81 +0,0 @@ - 1, - 'contact_id' => 6, - ]; - - try { - $result = civicrm_api3('Contact', 'getmergedto', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getmergedto_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 4, - 'values' => [ - '0' => [ - 'id' => '4', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMergedGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GetOptions.ex.php b/api/v3/examples/Contact/GetOptions.ex.php deleted file mode 100644 index b7e43de58f..0000000000 --- a/api/v3/examples/Contact/GetOptions.ex.php +++ /dev/null @@ -1,80 +0,0 @@ - 'custom_1', - ]; - - try { - $result = civicrm_api3('Contact', 'getoptions', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getoptions_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '1' => 'Label1', - '2' => 'Label2', - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCustomFieldCreateWithOptionValues" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GetSingleContact.ex.php b/api/v3/examples/Contact/GetSingleContact.ex.php deleted file mode 100644 index 1590daf0c9..0000000000 --- a/api/v3/examples/Contact/GetSingleContact.ex.php +++ /dev/null @@ -1,142 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('Contact', 'getsingle', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getsingle_expectedresult() { - - $expectedResult = [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Contact, Test', - 'display_name' => 'Mr. Test Contact II', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => 'Test', - 'middle_name' => 'J.', - 'last_name' => 'Contact', - 'prefix_id' => '3', - 'suffix_id' => '3', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => '', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '3', - 'email' => 'anthony_anderson@civicrm.org', - 'on_hold' => 0, - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => 'Mr.', - 'individual_suffix' => 'II', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '3', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactGetSingleEntityArray" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GetUnique.ex.php b/api/v3/examples/Contact/GetUnique.ex.php deleted file mode 100644 index e3f85e4062..0000000000 --- a/api/v3/examples/Contact/GetUnique.ex.php +++ /dev/null @@ -1,76 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_getunique_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 'UI_external_identifier', - 'values' => [ - 'UI_external_identifier' => [], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactGetUnique" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/GroupFilterUsingContactAPI.ex.php b/api/v3/examples/Contact/GroupFilterUsingContactAPI.ex.php deleted file mode 100644 index aa05306ece..0000000000 --- a/api/v3/examples/Contact/GroupFilterUsingContactAPI.ex.php +++ /dev/null @@ -1,153 +0,0 @@ - [ - 'IN' => [ - '0' => 'Test group C', - '1' => 'Test group D', - ], - ], - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Group member, Test2', - 'display_name' => 'Test2 Group member', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => 'Test2', - 'middle_name' => '', - 'last_name' => 'Group member', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => '', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '3', - 'email' => 'test@example.org', - 'on_hold' => 0, - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => '', - 'individual_suffix' => '', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '3', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContactGetWithGroupTitleMultipleGroups" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contact/NestedReplaceEmail.ex.php b/api/v3/examples/Contact/NestedReplaceEmail.ex.php deleted file mode 100644 index 9da1b89f06..0000000000 --- a/api/v3/examples/Contact/NestedReplaceEmail.ex.php +++ /dev/null @@ -1,254 +0,0 @@ - 19, - 'api.email.replace' => [ - 'values' => [ - '0' => [ - 'location_type_id' => 38, - 'email' => '1-1@example.com', - 'is_primary' => 1, - ], - '1' => [ - 'location_type_id' => 38, - 'email' => '1-2@example.com', - 'is_primary' => 0, - ], - '2' => [ - 'location_type_id' => 38, - 'email' => '1-3@example.com', - 'is_primary' => 0, - ], - '3' => [ - 'location_type_id' => 39, - 'email' => '2-1@example.com', - 'is_primary' => 0, - ], - '4' => [ - 'location_type_id' => 39, - 'email' => '2-2@example.com', - 'is_primary' => 0, - ], - ], - ], - ]; - - try { - $result = civicrm_api3('Contact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 19, - 'values' => [ - '19' => [ - 'contact_id' => '19', - 'contact_type' => 'Organization', - 'contact_sub_type' => '', - 'sort_name' => 'Unit Test Organization', - 'display_name' => 'Unit Test Organization', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'first_name' => '', - 'middle_name' => '', - 'last_name' => '', - 'prefix_id' => '', - 'suffix_id' => '', - 'formal_title' => '', - 'communication_style_id' => '1', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'organization_name' => 'Unit Test Organization', - 'sic_code' => '', - 'contact_is_deleted' => 0, - 'current_employer' => '', - 'address_id' => '', - 'street_address' => '', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'postal_code_suffix' => '', - 'postal_code' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - 'state_province_id' => '', - 'country_id' => '', - 'phone_id' => '', - 'phone_type_id' => '', - 'phone' => '', - 'email_id' => '', - 'email' => '', - 'on_hold' => '', - 'im_id' => '', - 'provider_id' => '', - 'im' => '', - 'worldregion_id' => '', - 'world_region' => '', - 'languages' => 'English (United States)', - 'individual_prefix' => '', - 'individual_suffix' => '', - 'communication_style' => 'Formal', - 'gender' => '', - 'state_province_name' => '', - 'state_province' => '', - 'country' => '', - 'id' => '19', - 'api.email.replace' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 5, - 'values' => [ - '0' => [ - 'id' => '35', - 'contact_id' => '19', - 'location_type_id' => '38', - 'email' => '1-1@example.com', - 'is_primary' => '1', - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - '1' => [ - 'id' => '36', - 'contact_id' => '19', - 'location_type_id' => '38', - 'email' => '1-2@example.com', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - '2' => [ - 'id' => '37', - 'contact_id' => '19', - 'location_type_id' => '38', - 'email' => '1-3@example.com', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - '3' => [ - 'id' => '38', - 'contact_id' => '19', - 'location_type_id' => '39', - 'email' => '2-1@example.com', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - '4' => [ - 'id' => '39', - 'contact_id' => '19', - 'location_type_id' => '39', - 'email' => '2-2@example.com', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testReplaceEmailsInChain" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EmailTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/ContributionCreateWithHonoreeContact.ex.php b/api/v3/examples/Contribution/ContributionCreateWithHonoreeContact.ex.php deleted file mode 100644 index e56c890d5b..0000000000 --- a/api/v3/examples/Contribution/ContributionCreateWithHonoreeContact.ex.php +++ /dev/null @@ -1,122 +0,0 @@ - 3, - 'receive_date' => '20120511', - 'total_amount' => '100', - 'financial_type_id' => 1, - 'non_deductible_amount' => '10', - 'fee_amount' => '5', - 'net_amount' => '95', - 'source' => 'SSF', - 'contribution_status_id' => 1, - 'honor_contact_id' => 4, - ]; - - try { - $result = civicrm_api3('Contribution', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '4', - 'receive_date' => '20120511000000', - 'non_deductible_amount' => '10', - 'total_amount' => '100', - 'fee_amount' => '5', - 'net_amount' => '95', - 'trxn_id' => '', - 'invoice_id' => '', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '1', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateContributionWithHonoreeContact" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/ContributionCreateWithNote.ex.php b/api/v3/examples/Contribution/ContributionCreateWithNote.ex.php deleted file mode 100644 index 44ec08c356..0000000000 --- a/api/v3/examples/Contribution/ContributionCreateWithNote.ex.php +++ /dev/null @@ -1,125 +0,0 @@ - 3, - 'receive_date' => '2012-01-01', - 'total_amount' => '100', - 'financial_type_id' => 1, - 'payment_instrument_id' => 1, - 'non_deductible_amount' => '10', - 'fee_amount' => '50', - 'net_amount' => '90', - 'trxn_id' => 12345, - 'invoice_id' => 67890, - 'source' => 'SSF', - 'contribution_status_id' => 1, - 'note' => 'my contribution note', - ]; - - try { - $result = civicrm_api3('Contribution', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '1', - 'receive_date' => '20120101000000', - 'non_deductible_amount' => '10', - 'total_amount' => '100', - 'fee_amount' => '50', - 'net_amount' => '90', - 'trxn_id' => '12345', - 'invoice_id' => '67890', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '1', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateContributionWithNote" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/ContributionCreateWithSoftCredit.ex.php b/api/v3/examples/Contribution/ContributionCreateWithSoftCredit.ex.php deleted file mode 100644 index ea42d726df..0000000000 --- a/api/v3/examples/Contribution/ContributionCreateWithSoftCredit.ex.php +++ /dev/null @@ -1,128 +0,0 @@ - 3, - 'receive_date' => '20120511', - 'total_amount' => '100', - 'financial_type_id' => 1, - 'non_deductible_amount' => '10', - 'fee_amount' => '5', - 'net_amount' => '95', - 'source' => 'SSF', - 'contribution_status_id' => 1, - 'soft_credit' => [ - '1' => [ - 'contact_id' => 4, - 'amount' => 50, - 'soft_credit_type_id' => 3, - ], - ], - ]; - - try { - $result = civicrm_api3('Contribution', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '4', - 'receive_date' => '20120511000000', - 'non_deductible_amount' => '10', - 'total_amount' => '100', - 'fee_amount' => '5', - 'net_amount' => '95', - 'trxn_id' => '', - 'invoice_id' => '', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '1', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateContributionWithSoftCredit" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/ContributionCreateWithSoftCreditDefaults.ex.php b/api/v3/examples/Contribution/ContributionCreateWithSoftCreditDefaults.ex.php deleted file mode 100644 index 938f989bc5..0000000000 --- a/api/v3/examples/Contribution/ContributionCreateWithSoftCreditDefaults.ex.php +++ /dev/null @@ -1,122 +0,0 @@ - 3, - 'receive_date' => '20120511', - 'total_amount' => '100', - 'financial_type_id' => 1, - 'non_deductible_amount' => '10', - 'fee_amount' => '5', - 'net_amount' => '95', - 'source' => 'SSF', - 'contribution_status_id' => 1, - 'soft_credit_to' => 4, - ]; - - try { - $result = civicrm_api3('Contribution', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '4', - 'receive_date' => '20120511000000', - 'non_deductible_amount' => '10', - 'total_amount' => '100', - 'fee_amount' => '5', - 'net_amount' => '95', - 'trxn_id' => '', - 'invoice_id' => '', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '1', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateContributionWithSoftCreditDefaults" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/Create.ex.php b/api/v3/examples/Contribution/Create.ex.php deleted file mode 100644 index f275e817e5..0000000000 --- a/api/v3/examples/Contribution/Create.ex.php +++ /dev/null @@ -1,120 +0,0 @@ - 3, - 'receive_date' => '20120511', - 'total_amount' => '100', - 'financial_type_id' => 1, - 'contribution_page_id' => 1, - 'trxn_id' => 12345, - 'is_pay_later' => 1, - 'invoice_id' => 67890, - 'source' => 'SSF', - 'contribution_status_id' => 'Pending', - ]; - - try { - $result = civicrm_api3('Contribution', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'financial_type_id' => '1', - 'contribution_page_id' => '1', - 'payment_instrument_id' => '4', - 'receive_date' => '20120511000000', - 'non_deductible_amount' => '', - 'total_amount' => '100', - 'fee_amount' => 0, - 'net_amount' => '100', - 'trxn_id' => '12345', - 'invoice_id' => '67890', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '1', - 'contribution_status_id' => '2', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateContributionPayLaterOnline" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/CreateWithNestedLineItems.ex.php b/api/v3/examples/Contribution/CreateWithNestedLineItems.ex.php deleted file mode 100644 index 6324494bd3..0000000000 --- a/api/v3/examples/Contribution/CreateWithNestedLineItems.ex.php +++ /dev/null @@ -1,191 +0,0 @@ - 3, - 'receive_date' => '20120511', - 'total_amount' => '100', - 'financial_type_id' => 1, - 'payment_instrument_id' => 1, - 'non_deductible_amount' => '10', - 'fee_amount' => '50', - 'net_amount' => '90', - 'trxn_id' => 12345, - 'invoice_id' => 67890, - 'source' => 'SSF', - 'contribution_status_id' => 'Pending', - 'skipLineItem' => 1, - 'api.line_item.create' => [ - '0' => [ - 'price_field_id' => 1, - 'qty' => 2, - 'line_total' => '20', - 'unit_price' => '10', - ], - '1' => [ - 'price_field_id' => 1, - 'qty' => 1, - 'line_total' => '80', - 'unit_price' => '80', - ], - ], - ]; - - try { - $result = civicrm_api3('Contribution', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '1', - 'receive_date' => '20120511000000', - 'non_deductible_amount' => '10', - 'total_amount' => '100', - 'fee_amount' => '50', - 'net_amount' => '90', - 'trxn_id' => '12345', - 'invoice_id' => '67890', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '2', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - 'api.line_item.create' => [ - '0' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'entity_table' => 'civicrm_contribution', - 'entity_id' => '1', - 'contribution_id' => '1', - 'price_field_id' => '1', - 'label' => 'line item', - 'qty' => '2', - 'unit_price' => '10', - 'line_total' => '20', - 'participant_count' => '', - 'price_field_value_id' => '', - 'financial_type_id' => '', - 'non_deductible_amount' => '', - 'tax_amount' => '', - 'membership_num_terms' => '', - ], - ], - ], - '1' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '0' => [ - 'id' => '2', - 'entity_table' => 'civicrm_contribution', - 'entity_id' => '1', - 'contribution_id' => '1', - 'price_field_id' => '1', - 'label' => 'line item', - 'qty' => '1', - 'unit_price' => '80', - 'line_total' => '80', - 'participant_count' => '', - 'price_field_value_id' => '', - 'financial_type_id' => '', - 'non_deductible_amount' => '', - 'tax_amount' => '', - 'membership_num_terms' => '', - ], - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateContributionChainedLineItems" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/Delete.ex.php b/api/v3/examples/Contribution/Delete.ex.php deleted file mode 100644 index 995946cd03..0000000000 --- a/api/v3/examples/Contribution/Delete.ex.php +++ /dev/null @@ -1,78 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Contribution', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => 1, - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteContribution" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/Get.ex.php b/api/v3/examples/Contribution/Get.ex.php deleted file mode 100644 index aa60007bb2..0000000000 --- a/api/v3/examples/Contribution/Get.ex.php +++ /dev/null @@ -1,112 +0,0 @@ - 1, - 'return' => [ - '0' => 'invoice_number', - '1' => 'contribution_source', - '2' => 'contact_id', - '3' => 'receive_date', - '4' => 'total_amount', - '5' => 'financial_type_id', - '6' => 'non_deductible_amount', - '7' => 'fee_amount', - '8' => 'net_amount', - '9' => 'trxn_id', - '10' => 'invoice_id', - '11' => 'source', - '12' => 'contribution_status_id', - ], - ]; - - try { - $result = civicrm_api3('Contribution', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'contact_id' => '3', - 'contribution_recur_id' => '', - 'contribution_status_id' => '1', - 'contribution_id' => '1', - 'financial_type_id' => '1', - 'receive_date' => '2010-01-20 00:00:00', - 'non_deductible_amount' => '10.00', - 'total_amount' => '100.00', - 'fee_amount' => '5.00', - 'net_amount' => '95.00', - 'trxn_id' => '23456', - 'invoice_id' => '78910', - 'invoice_number' => 'INV_1', - 'contribution_source' => 'SSF', - 'contribution_recur_status' => 'Completed', - 'contribution_status' => 'Completed', - 'id' => '1', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetContribution" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Contribution/GetUnique.ex.php b/api/v3/examples/Contribution/GetUnique.ex.php deleted file mode 100644 index 01aa735930..0000000000 --- a/api/v3/examples/Contribution/GetUnique.ex.php +++ /dev/null @@ -1,76 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_getunique_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - 'UI_contrib_trxn_id' => [], - 'UI_contrib_invoice_id' => [], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testContributionGetUnique" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionPage/Create.ex.php b/api/v3/examples/ContributionPage/Create.ex.php deleted file mode 100644 index 2070e71044..0000000000 --- a/api/v3/examples/ContributionPage/Create.ex.php +++ /dev/null @@ -1,135 +0,0 @@ - 'Test Contribution Page', - 'financial_type_id' => 1, - 'currency' => 'NZD', - 'goal_amount' => 34567, - 'is_pay_later' => 1, - 'pay_later_text' => 'Send check', - 'is_monetary' => TRUE, - 'is_email_receipt' => TRUE, - 'receipt_from_email' => 'yourconscience@donate.com', - 'receipt_from_name' => 'Ego Freud', - ]; - - try { - $result = civicrm_api3('ContributionPage', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_page_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'title' => 'Test Contribution Page', - 'intro_text' => '', - 'financial_type_id' => '1', - 'payment_processor' => '', - 'is_credit_card_only' => '', - 'is_monetary' => '1', - 'is_recur' => '', - 'is_confirm_enabled' => '', - 'recur_frequency_unit' => '', - 'is_recur_interval' => '', - 'is_recur_installments' => '', - 'adjust_recur_start_date' => '', - 'is_pay_later' => '1', - 'pay_later_text' => 'Send check', - 'pay_later_receipt' => '', - 'is_partial_payment' => '', - 'initial_amount_label' => '', - 'initial_amount_help_text' => '', - 'min_initial_amount' => '', - 'is_allow_other_amount' => '', - 'default_amount_id' => '', - 'min_amount' => '', - 'max_amount' => '', - 'goal_amount' => '34567', - 'thankyou_title' => '', - 'thankyou_text' => '', - 'thankyou_footer' => '', - 'is_email_receipt' => '1', - 'receipt_from_name' => 'Ego Freud', - 'receipt_from_email' => 'yourconscience@donate.com', - 'cc_receipt' => '', - 'bcc_receipt' => '', - 'receipt_text' => '', - 'is_active' => '1', - 'footer_text' => '', - 'amount_block_is_active' => '', - 'start_date' => '', - 'end_date' => '', - 'created_id' => '', - 'created_date' => '', - 'currency' => 'NZD', - 'campaign_id' => '', - 'is_share' => '', - 'is_billing_required' => '', - 'frontend_title' => '', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "basicCreateTest" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CiviUnitTestCase.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionPage/Delete.ex.php b/api/v3/examples/ContributionPage/Delete.ex.php deleted file mode 100644 index babbd43ca0..0000000000 --- a/api/v3/examples/ContributionPage/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('ContributionPage', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_page_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "basicDeleteTest" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CiviUnitTestCase.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionPage/Get.ex.php b/api/v3/examples/ContributionPage/Get.ex.php deleted file mode 100644 index 46acb7e857..0000000000 --- a/api/v3/examples/ContributionPage/Get.ex.php +++ /dev/null @@ -1,104 +0,0 @@ - 'NZD', - 'financial_type_id' => 1, - ]; - - try { - $result = civicrm_api3('ContributionPage', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_page_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'title' => 'Test Contribution Page', - 'financial_type_id' => '1', - 'is_credit_card_only' => 0, - 'is_monetary' => '1', - 'is_recur' => 0, - 'is_confirm_enabled' => '1', - 'is_recur_interval' => 0, - 'is_recur_installments' => 0, - 'adjust_recur_start_date' => 0, - 'is_pay_later' => '1', - 'pay_later_text' => 'Send check', - 'is_partial_payment' => 0, - 'is_allow_other_amount' => 0, - 'goal_amount' => '34567.00', - 'is_email_receipt' => '1', - 'receipt_from_name' => 'Ego Freud', - 'receipt_from_email' => 'yourconscience@donate.com', - 'is_active' => '1', - 'amount_block_is_active' => '1', - 'currency' => 'NZD', - 'is_share' => '1', - 'is_billing_required' => 0, - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetBasicContributionPage" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionPageTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionPage/Submit.ex.php b/api/v3/examples/ContributionPage/Submit.ex.php deleted file mode 100644 index f1eb5c13c8..0000000000 --- a/api/v3/examples/ContributionPage/Submit.ex.php +++ /dev/null @@ -1,98 +0,0 @@ - 1, - 'pledge_amount' => [ - '2' => 1, - ], - 'price_2' => 3, - 'billing_first_name' => 'Billy', - 'billing_middle_name' => 'Goat', - 'billing_last_name' => 'Gruff', - 'email' => 'billy@goat.gruff', - 'payment_processor_id' => 1, - 'credit_card_number' => '4111111111111111', - 'credit_card_type' => 'Visa', - 'credit_card_exp_date' => [ - 'M' => 9, - 'Y' => 2040, - ], - 'cvv2' => 123, - 'pledge_id' => '1', - 'cid' => '4', - 'contact_id' => '4', - 'is_pledge' => TRUE, - 'pledge_block_id' => 1, - ]; - - try { - $result = civicrm_api3('ContributionPage', 'submit', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_page_submit_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => '', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testSubmitPledgePayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionPageTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionRecur/Create.ex.php b/api/v3/examples/ContributionRecur/Create.ex.php deleted file mode 100644 index d4029781aa..0000000000 --- a/api/v3/examples/ContributionRecur/Create.ex.php +++ /dev/null @@ -1,115 +0,0 @@ - 3, - 'installments' => '12', - 'frequency_interval' => '1', - 'amount' => '500.00', - 'contribution_status_id' => 1, - 'start_date' => '2012-01-01 00:00:00', - 'currency' => 'USD', - 'frequency_unit' => 'day', - ]; - - try { - $result = civicrm_api3('ContributionRecur', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_recur_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'amount' => '500.00', - 'currency' => 'USD', - 'frequency_unit' => 'day', - 'frequency_interval' => '1', - 'installments' => '12', - 'start_date' => '2013-07-29 00:00:00', - 'create_date' => '20120130621222105', - 'modified_date' => '2012-11-14 16:02:35', - 'cancel_date' => '', - 'cancel_reason' => '', - 'end_date' => '', - 'processor_id' => '', - 'payment_token_id' => '', - 'trxn_id' => '', - 'invoice_id' => '', - 'contribution_status_id' => '1', - 'is_test' => '', - 'cycle_day' => '', - 'next_sched_contribution_date' => '', - 'failure_count' => '', - 'failure_retry_date' => '', - 'auto_renew' => '', - 'payment_processor_id' => '', - 'financial_type_id' => '', - 'payment_instrument_id' => '', - 'campaign_id' => '', - 'is_email_receipt' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "basicCreateTest" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CiviUnitTestCase.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionRecur/Delete.ex.php b/api/v3/examples/ContributionRecur/Delete.ex.php deleted file mode 100644 index 1d4b11c403..0000000000 --- a/api/v3/examples/ContributionRecur/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 7, - ]; - - try { - $result = civicrm_api3('ContributionRecur', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_recur_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "basicDeleteTest" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CiviUnitTestCase.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionRecur/Get.ex.php b/api/v3/examples/ContributionRecur/Get.ex.php deleted file mode 100644 index a26894fc44..0000000000 --- a/api/v3/examples/ContributionRecur/Get.ex.php +++ /dev/null @@ -1,95 +0,0 @@ - '500', - ]; - - try { - $result = civicrm_api3('ContributionRecur', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_recur_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_id' => '5', - 'amount' => '500.00', - 'currency' => 'USD', - 'frequency_unit' => 'day', - 'frequency_interval' => '1', - 'installments' => '12', - 'start_date' => '2013-07-29 00:00:00', - 'create_date' => '20120130621222105', - 'modified_date' => '2012-11-14 16:02:35', - 'contribution_status_id' => '1', - 'is_test' => 0, - 'cycle_day' => '1', - 'failure_count' => 0, - 'auto_renew' => 0, - 'is_email_receipt' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetContributionRecur" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionRecurTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionSoft/Create.ex.php b/api/v3/examples/ContributionSoft/Create.ex.php deleted file mode 100644 index b90e7cbead..0000000000 --- a/api/v3/examples/ContributionSoft/Create.ex.php +++ /dev/null @@ -1,93 +0,0 @@ - 6, - 'contact_id' => 19, - 'amount' => '10', - 'currency' => 'USD', - 'soft_credit_type_id' => 5, - ]; - - try { - $result = civicrm_api3('ContributionSoft', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_soft_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 5, - 'values' => [ - '5' => [ - 'id' => '5', - 'contribution_id' => '6', - 'contact_id' => '19', - 'amount' => '10', - 'currency' => 'USD', - 'pcp_id' => '', - 'pcp_display_in_roll' => '', - 'pcp_roll_nickname' => '', - 'pcp_personal_note' => '', - 'soft_credit_type_id' => '5', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateContributionSoft" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionSoft/Delete.ex.php b/api/v3/examples/ContributionSoft/Delete.ex.php deleted file mode 100644 index 967a0891cf..0000000000 --- a/api/v3/examples/ContributionSoft/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 7, - ]; - - try { - $result = civicrm_api3('ContributionSoft', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_soft_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteContributionSoft" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ContributionSoft/Get.ex.php b/api/v3/examples/ContributionSoft/Get.ex.php deleted file mode 100644 index 49ea3c8c04..0000000000 --- a/api/v3/examples/ContributionSoft/Get.ex.php +++ /dev/null @@ -1,86 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('ContributionSoft', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function contribution_soft_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contribution_id' => '1', - 'contact_id' => '4', - 'amount' => '10.00', - 'currency' => 'USD', - 'pcp_display_in_roll' => 0, - 'soft_credit_type_id' => '4', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetContributionSoft" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Country/Create.ex.php b/api/v3/examples/Country/Create.ex.php deleted file mode 100644 index 8443fc2d9e..0000000000 --- a/api/v3/examples/Country/Create.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - 'Made Up Land', - 'iso_code' => 'ZZ', - 'region_id' => 1, - ]; - - try { - $result = civicrm_api3('Country', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function country_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1255, - 'values' => [ - '1255' => [ - 'id' => '1255', - 'name' => 'Made Up Land', - 'iso_code' => 'ZZ', - 'country_code' => '', - 'address_format_id' => '', - 'idd_prefix' => '', - 'ndd_prefix' => '', - 'region_id' => '1', - 'is_province_abbreviated' => '', - 'is_active' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateCountry" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CountryTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Country/Delete.ex.php b/api/v3/examples/Country/Delete.ex.php deleted file mode 100644 index f7b33b0c5a..0000000000 --- a/api/v3/examples/Country/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1257, - ]; - - try { - $result = civicrm_api3('Country', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function country_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteCountry" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CountryTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Country/Get.ex.php b/api/v3/examples/Country/Get.ex.php deleted file mode 100644 index 83e3d119a2..0000000000 --- a/api/v3/examples/Country/Get.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 'ZZ', - ]; - - try { - $result = civicrm_api3('Country', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function country_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1259, - 'values' => [ - '1259' => [ - 'id' => '1259', - 'name' => 'Made Up Land', - 'iso_code' => 'ZZ', - 'region_id' => '1', - 'is_province_abbreviated' => 0, - 'is_active' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CountryTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/CustomField/Create.ex.php b/api/v3/examples/CustomField/Create.ex.php deleted file mode 100644 index b4bb9124eb..0000000000 --- a/api/v3/examples/CustomField/Create.ex.php +++ /dev/null @@ -1,119 +0,0 @@ - 1, - 'name' => 'test_textfield2', - 'label' => 'Name1', - 'html_type' => 'Text', - 'data_type' => 'String', - 'default_value' => 'abc', - 'weight' => 4, - 'is_required' => 1, - 'is_searchable' => 0, - 'is_active' => 1, - ]; - - try { - $result = civicrm_api3('CustomField', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function custom_field_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'custom_group_id' => '1', - 'name' => 'test_textfield2', - 'label' => 'Name1', - 'data_type' => 'String', - 'html_type' => 'Text', - 'default_value' => 'abc', - 'is_required' => '1', - 'is_searchable' => 0, - 'is_search_range' => 0, - 'weight' => '4', - 'help_pre' => '', - 'help_post' => '', - 'mask' => '', - 'attributes' => '', - 'javascript' => '', - 'is_active' => '1', - 'is_view' => 0, - 'options_per_line' => '', - 'text_length' => '', - 'start_date_years' => '', - 'end_date_years' => '', - 'date_format' => '', - 'time_format' => '', - 'note_columns' => '', - 'note_rows' => '', - 'column_name' => 'name1_1', - 'option_group_id' => '', - 'serialize' => 0, - 'filter' => '', - 'in_selector' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCustomFieldCreateWithEdit" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CustomFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/CustomField/Delete.ex.php b/api/v3/examples/CustomField/Delete.ex.php deleted file mode 100644 index 9b5ff15d59..0000000000 --- a/api/v3/examples/CustomField/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('CustomField', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function custom_field_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCustomFieldDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CustomFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/CustomGroup/Create.ex.php b/api/v3/examples/CustomGroup/Create.ex.php deleted file mode 100644 index f965296441..0000000000 --- a/api/v3/examples/CustomGroup/Create.ex.php +++ /dev/null @@ -1,111 +0,0 @@ - 'Test_Group_1', - 'name' => 'test_group_1', - 'extends' => [ - '0' => 'Individual', - ], - 'weight' => 4, - 'collapse_display' => 1, - 'style' => 'Inline', - 'help_pre' => 'This is Pre Help For Test Group 1', - 'help_post' => 'This is Post Help For Test Group 1', - 'is_active' => 1, - ]; - - try { - $result = civicrm_api3('CustomGroup', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function custom_group_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => 'test_group_1', - 'title' => 'Test_Group_1', - 'extends' => 'Individual', - 'extends_entity_column_id' => '', - 'extends_entity_column_value' => '', - 'style' => 'Inline', - 'collapse_display' => '1', - 'help_pre' => 'This is Pre Help For Test Group 1', - 'help_post' => 'This is Post Help For Test Group 1', - 'weight' => '2', - 'is_active' => '1', - 'table_name' => 'civicrm_value_test_group_1_1', - 'is_multiple' => '', - 'min_multiple' => '', - 'max_multiple' => '', - 'collapse_adv_display' => '', - 'created_id' => '', - 'created_date' => '', - 'is_reserved' => '', - 'is_public' => '', - 'icon' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCustomGroupCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CustomGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/CustomGroup/Delete.ex.php b/api/v3/examples/CustomGroup/Delete.ex.php deleted file mode 100644 index d495a48aa6..0000000000 --- a/api/v3/examples/CustomGroup/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('CustomGroup', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function custom_group_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCustomGroupDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CustomGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/CustomGroup/Get.ex.php b/api/v3/examples/CustomGroup/Get.ex.php deleted file mode 100644 index f40211ba22..0000000000 --- a/api/v3/examples/CustomGroup/Get.ex.php +++ /dev/null @@ -1,92 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function custom_group_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => 'test_group_1', - 'title' => 'Test_Group_1', - 'extends' => 'Individual', - 'style' => 'Inline', - 'collapse_display' => '1', - 'help_pre' => 'This is Pre Help For Test Group 1', - 'help_post' => 'This is Post Help For Test Group 1', - 'weight' => '2', - 'is_active' => '1', - 'table_name' => 'civicrm_value_test_group_1_1', - 'is_multiple' => 0, - 'collapse_adv_display' => 0, - 'is_reserved' => 0, - 'is_public' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetCustomGroupSuccess" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CustomGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/CustomValue/Create.ex.php b/api/v3/examples/CustomValue/Create.ex.php deleted file mode 100644 index 930ddf9f92..0000000000 --- a/api/v3/examples/CustomValue/Create.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 'customString', - 'entity_id' => 3, - ]; - - try { - $result = civicrm_api3('CustomValue', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function custom_value_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => TRUE, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateCustomValue" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CustomValueTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-master-git/ - * - * To Learn about the API read - * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API - * - * Browse the api on your own site with the api explorer - * http://MYSITE.ORG/path/to/civicrm/api - * - * Read more about testing here - * http://wiki.civicrm.org/confluence/display/CRM/Testing - * - * API Standards documentation: - * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards - */ diff --git a/api/v3/examples/CustomValue/FormatFieldName.ex.php b/api/v3/examples/CustomValue/FormatFieldName.ex.php deleted file mode 100644 index e353390380..0000000000 --- a/api/v3/examples/CustomValue/FormatFieldName.ex.php +++ /dev/null @@ -1,126 +0,0 @@ - 2, - 'entity_id' => 2, - 'format.field_names' => 1, - ]; - - try { - $result = civicrm_api3('CustomValue', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function custom_value_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 7, - 'values' => [ - 'mySingleField' => [ - 'entity_id' => '2', - 'latest' => 'value 1', - 'id' => 'mySingleField', - ], - 'field_12' => [ - 'entity_id' => '2', - 'latest' => 'value 3', - 'id' => 'field_12', - '1' => 'value 2', - '2' => 'value 3', - ], - 'field_22' => [ - 'entity_id' => '2', - 'latest' => '', - 'id' => 'field_22', - '1' => 'warm beer', - '2' => '', - ], - 'field_32' => [ - 'entity_id' => '2', - 'latest' => '', - 'id' => 'field_32', - '1' => 'fl* w*', - '2' => '', - ], - 'field_13' => [ - 'entity_id' => '2', - 'latest' => 'coffee', - 'id' => 'field_13', - '1' => 'defaultValue', - '2' => 'coffee', - ], - 'field_23' => [ - 'entity_id' => '2', - 'latest' => 'value 4', - 'id' => 'field_23', - '1' => '', - '2' => 'value 4', - ], - 'field_33' => [ - 'entity_id' => '2', - 'latest' => '', - 'id' => 'field_33', - '1' => 'vegemite', - '2' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetMultipleCustomValues" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CustomValueTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-master-git/ - * - * To Learn about the API read - * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API - * - * Browse the api on your own site with the api explorer - * http://MYSITE.ORG/path/to/civicrm/api - * - * Read more about testing here - * http://wiki.civicrm.org/confluence/display/CRM/Testing - * - * API Standards documentation: - * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards - */ diff --git a/api/v3/examples/CustomValue/Get.ex.php b/api/v3/examples/CustomValue/Get.ex.php deleted file mode 100644 index b5eae03648..0000000000 --- a/api/v3/examples/CustomValue/Get.ex.php +++ /dev/null @@ -1,125 +0,0 @@ - 2, - 'entity_id' => 2, - ]; - - try { - $result = civicrm_api3('CustomValue', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function custom_value_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 7, - 'values' => [ - '1' => [ - 'entity_id' => '2', - 'latest' => 'value 1', - 'id' => '1', - ], - '2' => [ - 'entity_id' => '2', - 'latest' => 'value 3', - 'id' => '2', - '1' => 'value 2', - '2' => 'value 3', - ], - '3' => [ - 'entity_id' => '2', - 'latest' => '', - 'id' => '3', - '1' => 'warm beer', - '2' => '', - ], - '4' => [ - 'entity_id' => '2', - 'latest' => '', - 'id' => '4', - '1' => 'fl* w*', - '2' => '', - ], - '5' => [ - 'entity_id' => '2', - 'latest' => 'coffee', - 'id' => '5', - '1' => 'defaultValue', - '2' => 'coffee', - ], - '6' => [ - 'entity_id' => '2', - 'latest' => 'value 4', - 'id' => '6', - '1' => '', - '2' => 'value 4', - ], - '7' => [ - 'entity_id' => '2', - 'latest' => '', - 'id' => '7', - '1' => 'vegemite', - '2' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetMultipleCustomValues" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CustomValueTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-master-git/ - * - * To Learn about the API read - * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API - * - * Browse the api on your own site with the api explorer - * http://MYSITE.ORG/path/to/civicrm/api - * - * Read more about testing here - * http://wiki.civicrm.org/confluence/display/CRM/Testing - * - * API Standards documentation: - * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards - */ diff --git a/api/v3/examples/Domain/Create.ex.php b/api/v3/examples/Domain/Create.ex.php deleted file mode 100644 index be9c1708af..0000000000 --- a/api/v3/examples/Domain/Create.ex.php +++ /dev/null @@ -1,89 +0,0 @@ - 'A-team domain', - 'description' => 'domain of chaos', - 'domain_version' => '4.2', - 'contact_id' => 7, - ]; - - try { - $result = civicrm_api3('Domain', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function domain_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'name' => 'A-team domain', - 'description' => 'domain of chaos', - 'contact_id' => '7', - 'locales' => '', - 'locale_custom_strings' => '', - 'domain_version' => '4.2', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/DomainTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Domain/Get.ex.php b/api/v3/examples/Domain/Get.ex.php deleted file mode 100644 index 54652a3bc4..0000000000 --- a/api/v3/examples/Domain/Get.ex.php +++ /dev/null @@ -1,129 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Domain', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function domain_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '0' => [ - 'id' => '1', - 'name' => 'Default Domain Name', - 'version' => '5.47.alpha1', - 'contact_id' => '3', - 'locale_custom_strings' => 'a:1:{s:5:\"en_US\";a:0:{}}', - 'domain_email' => 'my@email.com', - 'domain_phone' => [ - 'phone_type' => 'Phone', - 'phone' => '456-456', - ], - 'domain_address' => [ - 'street_address' => '45 Penny Lane', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => '', - 'state_province_id' => '', - 'postal_code' => '', - 'country_id' => '', - 'geo_code_1' => '', - 'geo_code_2' => '', - ], - 'from_name' => 'FIXME', - 'from_email' => 'info@EXAMPLE.ORG', - 'domain_version' => '5.47.alpha1', - ], - '1' => [ - 'id' => '2', - 'name' => 'Second Domain', - 'version' => '5.47.alpha1', - 'contact_id' => '2', - 'domain_email' => 'domainemail2@example.org', - 'domain_phone' => [ - 'phone_type' => 'Phone', - 'phone' => '204 555-1001', - ], - 'domain_address' => [ - 'street_address' => '15 Main St', - 'supplemental_address_1' => '', - 'supplemental_address_2' => '', - 'supplemental_address_3' => '', - 'city' => 'Collinsville', - 'state_province_id' => '1006', - 'postal_code' => '6022', - 'country_id' => '1228', - 'geo_code_1' => '41.8328', - 'geo_code_2' => '-72.9253', - ], - 'from_name' => 'FIXME', - 'from_email' => 'info@EXAMPLE.ORG', - 'domain_version' => '5.47.alpha1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/DomainTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Email/Create.ex.php b/api/v3/examples/Email/Create.ex.php deleted file mode 100644 index 7b793b185f..0000000000 --- a/api/v3/examples/Email/Create.ex.php +++ /dev/null @@ -1,93 +0,0 @@ - 23, - 'email' => 'api@a-team.com', - 'on_hold' => '2', - ]; - - try { - $result = civicrm_api3('Email', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function email_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 49, - 'values' => [ - '49' => [ - 'id' => '49', - 'contact_id' => '23', - 'location_type_id' => '1', - 'email' => 'api@a-team.com', - 'is_primary' => '1', - 'is_billing' => '', - 'on_hold' => '2', - 'is_bulkmail' => '', - 'hold_date' => '20220117122830', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testEmailOnHold" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EmailTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Email/Delete.ex.php b/api/v3/examples/Email/Delete.ex.php deleted file mode 100644 index a0152c8841..0000000000 --- a/api/v3/examples/Email/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 21, - ]; - - try { - $result = civicrm_api3('Email', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function email_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteEmail" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EmailTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Email/Replace.ex.php b/api/v3/examples/Email/Replace.ex.php deleted file mode 100644 index 42a949cdb9..0000000000 --- a/api/v3/examples/Email/Replace.ex.php +++ /dev/null @@ -1,173 +0,0 @@ - 17, - 'values' => [ - '0' => [ - 'location_type_id' => 34, - 'email' => '1-1@example.com', - 'is_primary' => 1, - ], - '1' => [ - 'location_type_id' => 34, - 'email' => '1-2@example.com', - 'is_primary' => 0, - ], - '2' => [ - 'location_type_id' => 34, - 'email' => '1-3@example.com', - 'is_primary' => 0, - ], - '3' => [ - 'location_type_id' => 35, - 'email' => '2-1@example.com', - 'is_primary' => 0, - ], - '4' => [ - 'location_type_id' => 35, - 'email' => '2-2@example.com', - 'is_primary' => 0, - ], - ], - ]; - - try { - $result = civicrm_api3('Email', 'replace', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function email_replace_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 5, - 'values' => [ - '23' => [ - 'id' => '23', - 'contact_id' => '17', - 'location_type_id' => '34', - 'email' => '1-1@example.com', - 'is_primary' => '1', - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - '24' => [ - 'id' => '24', - 'contact_id' => '17', - 'location_type_id' => '34', - 'email' => '1-2@example.com', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - '25' => [ - 'id' => '25', - 'contact_id' => '17', - 'location_type_id' => '34', - 'email' => '1-3@example.com', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - '26' => [ - 'id' => '26', - 'contact_id' => '17', - 'location_type_id' => '35', - 'email' => '2-1@example.com', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - '27' => [ - 'id' => '27', - 'contact_id' => '17', - 'location_type_id' => '35', - 'email' => '2-2@example.com', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testReplaceEmail" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EmailTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/EntityBatch/Create.ex.php b/api/v3/examples/EntityBatch/Create.ex.php deleted file mode 100644 index f0a3c13095..0000000000 --- a/api/v3/examples/EntityBatch/Create.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - '1', - 'batch_id' => 1, - 'entity_table' => 'civicrm_financial_trxn', - ]; - - try { - $result = civicrm_api3('EntityBatch', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function entity_batch_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'entity_table' => 'civicrm_financial_trxn', - 'entity_id' => '1', - 'batch_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateEntityBatch" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityBatchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/EntityBatch/Delete.ex.php b/api/v3/examples/EntityBatch/Delete.ex.php deleted file mode 100644 index d614b19fd4..0000000000 --- a/api/v3/examples/EntityBatch/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('EntityBatch', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function entity_batch_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteEntityBatch" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityBatchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/EntityBatch/Get.ex.php b/api/v3/examples/EntityBatch/Get.ex.php deleted file mode 100644 index 0adac2b07c..0000000000 --- a/api/v3/examples/EntityBatch/Get.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - '3', - 'batch_id' => 2, - 'entity_table' => 'civicrm_financial_trxn', - ]; - - try { - $result = civicrm_api3('EntityBatch', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function entity_batch_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'entity_table' => 'civicrm_financial_trxn', - 'entity_id' => '3', - 'batch_id' => '2', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetEntityBatch" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityBatchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/EntityTag/Create.ex.php b/api/v3/examples/EntityTag/Create.ex.php deleted file mode 100644 index 18bb68026a..0000000000 --- a/api/v3/examples/EntityTag/Create.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - 'tag_id' => '6', - ]; - - try { - $result = civicrm_api3('EntityTag', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function entity_tag_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'not_added' => 0, - 'added' => 1, - 'total_count' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testIndividualEntityTagGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityTagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-master-git/ - * - * To Learn about the API read - * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API - * - * Browse the api on your own site with the api explorer - * http://MYSITE.ORG/path/to/civicrm/api - * - * Read more about testing here - * http://wiki.civicrm.org/confluence/display/CRM/Testing - * - * API Standards documentation: - * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards - */ diff --git a/api/v3/examples/EntityTag/Delete.ex.php b/api/v3/examples/EntityTag/Delete.ex.php deleted file mode 100644 index f871a3da65..0000000000 --- a/api/v3/examples/EntityTag/Delete.ex.php +++ /dev/null @@ -1,76 +0,0 @@ - 43, - 'tag_id' => '19', - ]; - - try { - $result = civicrm_api3('EntityTag', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function entity_tag_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'not_removed' => 0, - 'removed' => 1, - 'total_count' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testEntityTagDeleteHH" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityTagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/EntityTag/Get.ex.php b/api/v3/examples/EntityTag/Get.ex.php deleted file mode 100644 index 6d139a4554..0000000000 --- a/api/v3/examples/EntityTag/Get.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 18, - ]; - - try { - $result = civicrm_api3('EntityTag', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function entity_tag_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 6, - 'values' => [ - '6' => [ - 'id' => '6', - 'entity_table' => 'civicrm_contact', - 'entity_id' => '18', - 'tag_id' => '11', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testIndividualEntityTagGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityTagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Event/ContactRefCustomField.ex.php b/api/v3/examples/Event/ContactRefCustomField.ex.php deleted file mode 100644 index d2a5d1db6c..0000000000 --- a/api/v3/examples/Event/ContactRefCustomField.ex.php +++ /dev/null @@ -1,113 +0,0 @@ - 1, - 'custom_2' => 3, - ]; - - try { - $result = civicrm_api3('Event', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function event_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'title' => 'My test event.', - 'event_title' => 'My test event.', - 'event_description' => '', - 'event_type_id' => '1', - 'is_public' => '1', - 'start_date' => '2013-07-29 00:00:00', - 'event_start_date' => '2013-07-29 00:00:00', - 'event_end_date' => '', - 'is_online_registration' => 0, - 'is_monetary' => 0, - 'is_map' => 0, - 'is_active' => '1', - 'is_show_location' => '1', - 'default_role_id' => '1', - 'is_email_confirm' => 0, - 'is_pay_later' => 0, - 'is_partial_payment' => 0, - 'is_multiple_registrations' => 0, - 'max_additional_participants' => 0, - 'allow_same_participant_emails' => 0, - 'allow_selfcancelxfer' => 0, - 'selfcancelxfer_time' => 0, - 'is_template' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'is_share' => '1', - 'is_confirm_enabled' => '1', - 'is_billing_required' => 0, - 'custom_1' => 'defaultValue', - 'custom_2_id' => '3', - 'custom_2' => 'Contact, Test', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testEventGetCustomContactRefFieldCRM16036" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Event/Create.ex.php b/api/v3/examples/Event/Create.ex.php deleted file mode 100644 index b2bc9d0b11..0000000000 --- a/api/v3/examples/Event/Create.ex.php +++ /dev/null @@ -1,162 +0,0 @@ - 'Annual CiviCRM meet', - 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now', - 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues', - 'event_type_id' => 1, - 'is_public' => 1, - 'start_date' => 20081021, - 'end_date' => 20081023, - 'is_online_registration' => 1, - 'registration_start_date' => 20080601, - 'registration_end_date' => '2008-10-15', - 'max_participants' => 100, - 'event_full_text' => 'Sorry! We are already full', - 'is_monetary' => 0, - 'is_active' => 1, - 'is_show_location' => 0, - ]; - - try { - $result = civicrm_api3('Event', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function event_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'title' => 'Annual CiviCRM meet', - 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now', - 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues', - 'event_type_id' => '1', - 'participant_listing_id' => '', - 'is_public' => '1', - 'start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'is_online_registration' => '1', - 'registration_link_text' => '', - 'registration_start_date' => '20080601000000', - 'registration_end_date' => '20081015000000', - 'max_participants' => '100', - 'event_full_text' => 'Sorry! We are already full', - 'is_monetary' => 0, - 'financial_type_id' => '', - 'payment_processor' => '', - 'is_map' => '', - 'is_active' => '1', - 'fee_label' => '', - 'is_show_location' => 0, - 'loc_block_id' => '', - 'default_role_id' => '', - 'intro_text' => '', - 'footer_text' => '', - 'confirm_title' => '', - 'confirm_text' => '', - 'confirm_footer_text' => '', - 'is_email_confirm' => '', - 'confirm_email_text' => '', - 'confirm_from_name' => '', - 'confirm_from_email' => '', - 'cc_confirm' => '', - 'bcc_confirm' => '', - 'default_fee_id' => '', - 'default_discount_fee_id' => '', - 'thankyou_title' => '', - 'thankyou_text' => '', - 'thankyou_footer_text' => '', - 'is_pay_later' => '', - 'pay_later_text' => '', - 'pay_later_receipt' => '', - 'is_partial_payment' => '', - 'initial_amount_label' => '', - 'initial_amount_help_text' => '', - 'min_initial_amount' => '', - 'is_multiple_registrations' => '', - 'max_additional_participants' => '', - 'allow_same_participant_emails' => '', - 'has_waitlist' => '', - 'requires_approval' => '', - 'expiration_time' => '', - 'allow_selfcancelxfer' => '', - 'selfcancelxfer_time' => '', - 'waitlist_text' => '', - 'approval_req_text' => '', - 'is_template' => 0, - 'template_title' => '', - 'created_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'currency' => '', - 'campaign_id' => '', - 'is_share' => '', - 'is_confirm_enabled' => '', - 'parent_event_id' => '', - 'slot_label_id' => '', - 'dedupe_rule_group_id' => '', - 'is_billing_required' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateEventSuccess" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Event/Delete.ex.php b/api/v3/examples/Event/Delete.ex.php deleted file mode 100644 index 8e3f6cb209..0000000000 --- a/api/v3/examples/Event/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Event', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function event_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Event/Get.ex.php b/api/v3/examples/Event/Get.ex.php deleted file mode 100644 index 921ab12aac..0000000000 --- a/api/v3/examples/Event/Get.ex.php +++ /dev/null @@ -1,108 +0,0 @@ - 'Annual CiviCRM meet', - 'sequential' => TRUE, - ]; - - try { - $result = civicrm_api3('Event', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function event_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'title' => 'Annual CiviCRM meet', - 'event_title' => 'Annual CiviCRM meet', - 'event_description' => '', - 'event_type_id' => '1', - 'is_public' => '1', - 'start_date' => '2013-07-29 00:00:00', - 'event_start_date' => '2013-07-29 00:00:00', - 'event_end_date' => '', - 'is_online_registration' => 0, - 'is_monetary' => 0, - 'is_map' => 0, - 'is_active' => '1', - 'is_show_location' => '1', - 'default_role_id' => '1', - 'is_email_confirm' => 0, - 'is_pay_later' => 0, - 'is_partial_payment' => 0, - 'is_multiple_registrations' => 0, - 'max_additional_participants' => 0, - 'allow_same_participant_emails' => 0, - 'allow_selfcancelxfer' => 0, - 'selfcancelxfer_time' => 0, - 'is_template' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'is_share' => '1', - 'is_confirm_enabled' => '1', - 'is_billing_required' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetEventByEventTitle" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Event/IsCurrentOption.ex.php b/api/v3/examples/Event/IsCurrentOption.ex.php deleted file mode 100644 index 0df7671851..0000000000 --- a/api/v3/examples/Event/IsCurrentOption.ex.php +++ /dev/null @@ -1,116 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Event', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function event_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'title' => 'Annual CiviCRM meet 2', - 'event_title' => 'Annual CiviCRM meet 2', - 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now', - 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues', - 'event_description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues', - 'event_type_id' => '1', - 'is_public' => '1', - 'start_date' => '2013-07-29 00:00:00', - 'event_start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'event_end_date' => '2013-08-04 00:00:00', - 'is_online_registration' => '1', - 'registration_start_date' => '2010-06-01 00:00:00', - 'registration_end_date' => '2010-10-15 00:00:00', - 'max_participants' => '100', - 'event_full_text' => 'Sorry! We are already full', - 'is_monetary' => 0, - 'is_map' => 0, - 'is_active' => '1', - 'is_show_location' => 0, - 'default_role_id' => '1', - 'is_email_confirm' => 0, - 'is_pay_later' => 0, - 'is_partial_payment' => 0, - 'is_multiple_registrations' => 0, - 'max_additional_participants' => 0, - 'allow_same_participant_emails' => 0, - 'allow_selfcancelxfer' => 0, - 'selfcancelxfer_time' => 0, - 'is_template' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'is_share' => '1', - 'is_confirm_enabled' => '1', - 'is_billing_required' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetIsCurrent" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Event/IsFullOption.ex.php b/api/v3/examples/Event/IsFullOption.ex.php deleted file mode 100644 index cf874bb64d..0000000000 --- a/api/v3/examples/Event/IsFullOption.ex.php +++ /dev/null @@ -1,105 +0,0 @@ - 1, - 'return.is_full' => 1, - ]; - - try { - $result = civicrm_api3('Event', 'getsingle', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function event_getsingle_expectedresult() { - - $expectedResult = [ - 'id' => '1', - 'title' => 'Annual CiviCRM meet', - 'event_title' => 'Annual CiviCRM meet', - 'event_description' => '', - 'event_type_id' => '1', - 'is_public' => '1', - 'start_date' => '2008-10-21 00:00:00', - 'event_start_date' => '2008-10-21 00:00:00', - 'event_end_date' => '', - 'is_online_registration' => 0, - 'max_participants' => '1', - 'is_monetary' => 0, - 'is_map' => 0, - 'is_active' => '1', - 'is_show_location' => '1', - 'default_role_id' => '1', - 'is_email_confirm' => 0, - 'is_pay_later' => 0, - 'is_partial_payment' => 0, - 'is_multiple_registrations' => 0, - 'max_additional_participants' => 0, - 'allow_same_participant_emails' => 0, - 'allow_selfcancelxfer' => 0, - 'selfcancelxfer_time' => 0, - 'is_template' => 0, - 'created_date' => '2022-01-17 12:29:42', - 'is_share' => '1', - 'is_confirm_enabled' => '1', - 'is_billing_required' => 0, - 'available_places' => 0, - 'is_full' => '1', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetSingleReturnIsFull" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Grant/Create.ex.php b/api/v3/examples/Grant/Create.ex.php deleted file mode 100644 index 615ec933eb..0000000000 --- a/api/v3/examples/Grant/Create.ex.php +++ /dev/null @@ -1,101 +0,0 @@ - 3, - 'application_received_date' => 'now', - 'decision_date' => 'next Monday', - 'amount_total' => '500', - 'status_id' => 1, - 'rationale' => 'Just Because', - 'currency' => 'USD', - 'grant_type_id' => 1, - ]; - - try { - $result = civicrm_api3('Grant', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function grant_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'application_received_date' => '20130728084957', - 'decision_date' => '20130805000000', - 'money_transfer_date' => '', - 'grant_due_date' => '', - 'grant_report_received' => '', - 'grant_type_id' => '1', - 'amount_total' => '500', - 'amount_requested' => '', - 'amount_granted' => '', - 'currency' => 'USD', - 'rationale' => 'Just Because', - 'status_id' => '1', - 'financial_type_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateGrant" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GrantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Grant/Delete.ex.php b/api/v3/examples/Grant/Delete.ex.php deleted file mode 100644 index 36a2200d40..0000000000 --- a/api/v3/examples/Grant/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Grant', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function grant_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteGrant" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GrantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Grant/Get.ex.php b/api/v3/examples/Grant/Get.ex.php deleted file mode 100644 index 3a95377fa9..0000000000 --- a/api/v3/examples/Grant/Get.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 'Just Because', - ]; - - try { - $result = civicrm_api3('Grant', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function grant_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'application_received_date' => '20130728084957', - 'decision_date' => '20130805000000', - 'grant_type_id' => '1', - 'amount_total' => '500.00', - 'currency' => 'USD', - 'rationale' => 'Just Because', - 'status_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetGrant" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GrantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Group/Get.ex.php b/api/v3/examples/Group/Get.ex.php deleted file mode 100644 index 737e90b4e3..0000000000 --- a/api/v3/examples/Group/Get.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - 'Test Group 1', - ]; - - try { - $result = civicrm_api3('Group', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => 'Test Group 1', - 'title' => 'New Test Group Created', - 'description' => 'New Test Group Created', - 'is_active' => '1', - 'visibility' => 'Public Pages', - 'group_type' => [ - '0' => '1', - '1' => '2', - ], - 'is_hidden' => 0, - 'is_reserved' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetGroupParamsWithGroupName" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Group/GetFields.ex.php b/api/v3/examples/Group/GetFields.ex.php deleted file mode 100644 index 3a357d6903..0000000000 --- a/api/v3/examples/Group/GetFields.ex.php +++ /dev/null @@ -1,460 +0,0 @@ - 'create', - ]; - - try { - $result = civicrm_api3('Group', 'getfields', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_getfields_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 22, - 'values' => [ - 'id' => [ - 'name' => 'id', - 'type' => 1, - 'title' => 'Group ID', - 'description' => 'Group ID', - 'required' => TRUE, - 'where' => 'civicrm_group.id', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'html' => [ - 'type' => 'Number', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.aliases' => [ - '0' => 'group_id', - ], - ], - 'name' => [ - 'name' => 'name', - 'type' => 2, - 'title' => 'Group Name', - 'description' => 'Internal name of Group.', - 'maxlength' => 64, - 'size' => 30, - 'where' => 'civicrm_group.name', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'title' => [ - 'name' => 'title', - 'type' => 2, - 'title' => 'Group Title', - 'description' => 'Name of Group.', - 'maxlength' => 255, - 'size' => 45, - 'where' => 'civicrm_group.title', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 1, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 255, - 'size' => 45, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.required' => 1, - ], - 'description' => [ - 'name' => 'description', - 'type' => 32, - 'title' => 'Group Description', - 'description' => 'Optional verbose description of the group.', - 'rows' => 2, - 'cols' => 60, - 'where' => 'civicrm_group.description', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'html' => [ - 'type' => 'TextArea', - 'rows' => 2, - 'cols' => 60, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'source' => [ - 'name' => 'source', - 'type' => 2, - 'title' => 'Group Source', - 'description' => 'Module or process which created this group.', - 'maxlength' => 64, - 'size' => 30, - 'where' => 'civicrm_group.source', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'saved_search_id' => [ - 'name' => 'saved_search_id', - 'type' => 1, - 'title' => 'Saved Search ID', - 'description' => 'FK to saved search table.', - 'where' => 'civicrm_group.saved_search_id', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_SavedSearch', - 'html' => [ - 'label' => 'Saved Search', - 'size' => 6, - 'maxlength' => 14, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'FKApiName' => 'SavedSearch', - ], - 'is_active' => [ - 'name' => 'is_active', - 'type' => 16, - 'title' => 'Group Enabled', - 'description' => 'Is this entry active?', - 'where' => 'civicrm_group.is_active', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.default' => 1, - ], - 'visibility' => [ - 'name' => 'visibility', - 'type' => 2, - 'title' => 'Group Visibility Setting', - 'description' => 'In what context(s) is this field visible.', - 'maxlength' => 24, - 'size' => 20, - 'where' => 'civicrm_group.visibility', - 'default' => 'User and User Admin Only', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'maxlength' => 24, - 'size' => 20, - ], - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::groupVisibility', - ], - 'add' => '1.2', - 'is_core_field' => TRUE, - ], - 'where_clause' => [ - 'name' => 'where_clause', - 'type' => 32, - 'title' => 'Group Where Clause', - 'description' => 'the sql where clause if a saved search acl', - 'where' => 'civicrm_group.where_clause', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'readonly' => TRUE, - 'add' => '1.6', - 'is_core_field' => TRUE, - ], - 'select_tables' => [ - 'name' => 'select_tables', - 'type' => 32, - 'title' => 'Tables For Select Clause', - 'description' => 'the tables to be included in a select data', - 'where' => 'civicrm_group.select_tables', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'serialize' => 4, - 'readonly' => TRUE, - 'add' => '1.6', - 'is_core_field' => TRUE, - ], - 'where_tables' => [ - 'name' => 'where_tables', - 'type' => 32, - 'title' => 'Tables For Where Clause', - 'description' => 'the tables to be included in the count statement', - 'where' => 'civicrm_group.where_tables', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'serialize' => 4, - 'readonly' => TRUE, - 'add' => '1.6', - 'is_core_field' => TRUE, - ], - 'group_type' => [ - 'name' => 'group_type', - 'type' => 2, - 'title' => 'Group Type', - 'description' => 'FK to group type', - 'maxlength' => 128, - 'size' => 45, - 'where' => 'civicrm_group.group_type', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'serialize' => 1, - 'pseudoconstant' => [ - 'optionGroupName' => 'group_type', - 'optionEditPath' => 'civicrm/admin/options/group_type', - ], - 'add' => '1.9', - 'is_core_field' => TRUE, - ], - 'cache_date' => [ - 'name' => 'cache_date', - 'type' => 256, - 'title' => 'Group Cache Date', - 'description' => 'Date when we created the cache for a smart group', - 'required' => '', - 'where' => 'civicrm_group.cache_date', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'readonly' => TRUE, - 'add' => '2.1', - 'is_core_field' => TRUE, - ], - 'refresh_date' => [ - 'name' => 'refresh_date', - 'type' => 256, - 'title' => 'Next Group Refresh Time', - 'description' => 'Date and time when we need to refresh the cache next.', - 'required' => '', - 'where' => 'civicrm_group.refresh_date', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'readonly' => TRUE, - 'add' => '4.3', - 'is_core_field' => TRUE, - ], - 'parents' => [ - 'name' => 'parents', - 'type' => 32, - 'title' => 'Group Parents', - 'description' => 'IDs of the parent(s)', - 'where' => 'civicrm_group.parents', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'serialize' => 5, - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_PseudoConstant::allGroup', - ], - 'add' => '2.1', - 'is_core_field' => TRUE, - ], - 'children' => [ - 'name' => 'children', - 'type' => 32, - 'title' => 'Group Children', - 'description' => 'IDs of the child(ren)', - 'where' => 'civicrm_group.children', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'add' => '2.1', - 'is_core_field' => TRUE, - ], - 'is_hidden' => [ - 'name' => 'is_hidden', - 'type' => 16, - 'title' => 'Group is Hidden', - 'description' => 'Is this group hidden?', - 'where' => 'civicrm_group.is_hidden', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'add' => '2.2', - 'is_core_field' => TRUE, - ], - 'is_reserved' => [ - 'name' => 'is_reserved', - 'type' => 16, - 'title' => 'Group is Reserved', - 'where' => 'civicrm_group.is_reserved', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'add' => '4.2', - 'is_core_field' => TRUE, - ], - 'created_id' => [ - 'name' => 'created_id', - 'type' => 1, - 'title' => 'Created By Contact ID', - 'description' => 'FK to contact table.', - 'where' => 'civicrm_group.created_id', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'html' => [ - 'label' => 'Created By', - 'size' => 6, - 'maxlength' => 14, - ], - 'add' => '4.3', - 'is_core_field' => TRUE, - 'FKApiName' => 'Contact', - ], - 'modified_id' => [ - 'name' => 'modified_id', - 'type' => 1, - 'title' => 'Modified By Contact ID', - 'description' => 'FK to contact table.', - 'where' => 'civicrm_group.modified_id', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'html' => [ - 'label' => 'Modified By', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '4.5', - 'is_core_field' => TRUE, - 'FKApiName' => 'Contact', - ], - 'frontend_title' => [ - 'name' => 'frontend_title', - 'type' => 2, - 'title' => 'Public Group Title', - 'description' => 'Alternative public title for this Group.', - 'maxlength' => 255, - 'size' => 45, - 'where' => 'civicrm_group.frontend_title', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 1, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 255, - 'size' => 45, - ], - 'add' => '5.31', - 'is_core_field' => TRUE, - ], - 'frontend_description' => [ - 'name' => 'frontend_description', - 'type' => 32, - 'title' => 'Public Group Description', - 'description' => 'Alternative public description of the group.', - 'rows' => 2, - 'cols' => 60, - 'where' => 'civicrm_group.frontend_description', - 'table_name' => 'civicrm_group', - 'entity' => 'Group', - 'bao' => 'CRM_Contact_BAO_Group', - 'localizable' => 1, - 'html' => [ - 'type' => 'TextArea', - 'rows' => 2, - 'cols' => 60, - ], - 'add' => '5.31', - 'is_core_field' => TRUE, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testgetfields" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupContact/Create.ex.php b/api/v3/examples/GroupContact/Create.ex.php deleted file mode 100644 index ab4683ff29..0000000000 --- a/api/v3/examples/GroupContact/Create.ex.php +++ /dev/null @@ -1,80 +0,0 @@ - 8, - 'contact_id.2' => 9, - 'group_id' => 11, - ]; - - try { - $result = civicrm_api3('GroupContact', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_contact_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - 'total_count' => 2, - 'added' => 1, - 'not_added' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupContact/Delete.ex.php b/api/v3/examples/GroupContact/Delete.ex.php deleted file mode 100644 index 4ae8dd7062..0000000000 --- a/api/v3/examples/GroupContact/Delete.ex.php +++ /dev/null @@ -1,79 +0,0 @@ - 9, - 'skip_undelete' => TRUE, - ]; - - try { - $result = civicrm_api3('GroupContact', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_contact_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - 'total_count' => 1, - 'removed' => 0, - 'not_removed' => 0, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePermanent" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupContact/Get.ex.php b/api/v3/examples/GroupContact/Get.ex.php deleted file mode 100644 index 3635d4c692..0000000000 --- a/api/v3/examples/GroupContact/Get.ex.php +++ /dev/null @@ -1,86 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('GroupContact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'group_id' => '1', - 'title' => 'New Test Group Created', - 'visibility' => 'Public Pages', - 'is_hidden' => 0, - 'in_date' => '2013-07-28 08:50:19', - 'in_method' => 'API', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupContact/GetWithGroupID.ex.php b/api/v3/examples/GroupContact/GetWithGroupID.ex.php deleted file mode 100644 index 7009d244b4..0000000000 --- a/api/v3/examples/GroupContact/GetWithGroupID.ex.php +++ /dev/null @@ -1,109 +0,0 @@ - 3, - 'api.group.get' => 1, - 'sequential' => 1, - ]; - - try { - $result = civicrm_api3('GroupContact', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_contact_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '0' => [ - 'id' => '2', - 'group_id' => '3', - 'contact_id' => '4', - 'status' => 'Added', - 'api.group.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '0' => [ - 'id' => '3', - 'name' => 'Test Group 1', - 'title' => 'New Test Group Created', - 'description' => 'New Test Group Created', - 'is_active' => '1', - 'visibility' => 'Public Pages', - 'group_type' => [ - '0' => '1', - '1' => '2', - ], - 'is_hidden' => 0, - 'is_reserved' => 0, - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetGroupID" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupNesting/Create.ex.php b/api/v3/examples/GroupNesting/Create.ex.php deleted file mode 100644 index 40197d2b30..0000000000 --- a/api/v3/examples/GroupNesting/Create.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 1, - 'child_group_id' => 3, - ]; - - try { - $result = civicrm_api3('GroupNesting', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_nesting_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'child_group_id' => '3', - 'parent_group_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupNestingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupNesting/Delete.ex.php b/api/v3/examples/GroupNesting/Delete.ex.php deleted file mode 100644 index a99389bbb9..0000000000 --- a/api/v3/examples/GroupNesting/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('GroupNesting', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_nesting_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupNestingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupNesting/Get.ex.php b/api/v3/examples/GroupNesting/Get.ex.php deleted file mode 100644 index 7f12e6123a..0000000000 --- a/api/v3/examples/GroupNesting/Get.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 1, - 'child_group_id' => 2, - ]; - - try { - $result = civicrm_api3('GroupNesting', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_nesting_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'child_group_id' => '2', - 'parent_group_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupNestingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupOrganization/Create.ex.php b/api/v3/examples/GroupOrganization/Create.ex.php deleted file mode 100644 index e27bc46e97..0000000000 --- a/api/v3/examples/GroupOrganization/Create.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 12, - 'group_id' => 10, - ]; - - try { - $result = civicrm_api3('GroupOrganization', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_organization_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 6, - 'values' => [ - '6' => [ - 'id' => '6', - 'group_id' => '10', - 'organization_id' => '12', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGroupOrganizationCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupOrganizationTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupOrganization/Delete.ex.php b/api/v3/examples/GroupOrganization/Delete.ex.php deleted file mode 100644 index 3f87163026..0000000000 --- a/api/v3/examples/GroupOrganization/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 10, - ]; - - try { - $result = civicrm_api3('GroupOrganization', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_organization_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 'Deleted Group Organization successfully', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGroupOrganizationDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupOrganizationTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/GroupOrganization/Get.ex.php b/api/v3/examples/GroupOrganization/Get.ex.php deleted file mode 100644 index c962c50914..0000000000 --- a/api/v3/examples/GroupOrganization/Get.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 2, - ]; - - try { - $result = civicrm_api3('GroupOrganization', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function group_organization_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => [], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGroupOrganizationGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupOrganizationTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Im/Create.ex.php b/api/v3/examples/Im/Create.ex.php deleted file mode 100644 index 2a47feb628..0000000000 --- a/api/v3/examples/Im/Create.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 5, - 'name' => 'My Yahoo IM Handle', - 'provider_id' => 1, - ]; - - try { - $result = civicrm_api3('Im', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function im_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_id' => '5', - 'location_type_id' => '1', - 'name' => 'My Yahoo IM Handle', - 'provider_id' => '1', - 'is_primary' => '1', - 'is_billing' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateImDefaultLocation" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ImTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Im/Delete.ex.php b/api/v3/examples/Im/Delete.ex.php deleted file mode 100644 index 5094e1c253..0000000000 --- a/api/v3/examples/Im/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 7, - ]; - - try { - $result = civicrm_api3('Im', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function im_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteIm" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ImTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Im/Get.ex.php b/api/v3/examples/Im/Get.ex.php deleted file mode 100644 index 9da151891b..0000000000 --- a/api/v3/examples/Im/Get.ex.php +++ /dev/null @@ -1,89 +0,0 @@ - 7, - 'name' => 'My Yahoo IM Handle', - 'location_type_id' => 1, - 'provider_id' => 1, - ]; - - try { - $result = civicrm_api3('Im', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function im_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 5, - 'values' => [ - '5' => [ - 'id' => '5', - 'contact_id' => '7', - 'location_type_id' => '1', - 'name' => 'My Yahoo IM Handle', - 'provider_id' => '1', - 'is_primary' => '1', - 'is_billing' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetIm" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ImTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Job/Clone.ex.php b/api/v3/examples/Job/Clone.ex.php deleted file mode 100644 index 5757ab43a4..0000000000 --- a/api/v3/examples/Job/Clone.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 31, - ]; - - try { - $result = civicrm_api3('Job', 'clone', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function job_clone_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 32, - 'values' => [ - '32' => [ - 'id' => '32', - 'domain_id' => '1', - 'run_frequency' => 'Daily', - 'name' => 'API_Test_Job - Copy', - 'description' => 'A long description written by hand in cursive', - 'api_entity' => 'ApiTestEntity', - 'api_action' => 'api_test_action', - 'parameters' => 'Semi-formal explanation of runtime job parameters', - 'is_active' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testClone" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/JobTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Job/Create.ex.php b/api/v3/examples/Job/Create.ex.php deleted file mode 100644 index 605b9cc9ab..0000000000 --- a/api/v3/examples/Job/Create.ex.php +++ /dev/null @@ -1,97 +0,0 @@ - 1, - 'name' => 'API_Test_Job', - 'description' => 'A long description written by hand in cursive', - 'run_frequency' => 'Daily', - 'api_entity' => 'ApiTestEntity', - 'api_action' => 'api_test_action', - 'parameters' => 'Semi-formal explanation of runtime job parameters', - 'is_active' => 1, - ]; - - try { - $result = civicrm_api3('Job', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function job_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 30, - 'values' => [ - '0' => [ - 'id' => '30', - 'domain_id' => '1', - 'run_frequency' => 'Daily', - 'last_run' => '', - 'scheduled_run_date' => '', - 'name' => 'API_Test_Job', - 'description' => 'A long description written by hand in cursive', - 'api_entity' => 'ApiTestEntity', - 'api_action' => 'api_test_action', - 'parameters' => 'Semi-formal explanation of runtime job parameters', - 'is_active' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/JobTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Job/Delete.ex.php b/api/v3/examples/Job/Delete.ex.php deleted file mode 100644 index 2f6dd94003..0000000000 --- a/api/v3/examples/Job/Delete.ex.php +++ /dev/null @@ -1,70 +0,0 @@ - 33, - ]; - - try { - $result = civicrm_api3('Job', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function job_delete_expectedresult() { - - $expectedResult = ''; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/JobTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/LineItem/Create.ex.php b/api/v3/examples/LineItem/Create.ex.php deleted file mode 100644 index 11eb298ce9..0000000000 --- a/api/v3/examples/LineItem/Create.ex.php +++ /dev/null @@ -1,100 +0,0 @@ - 1, - 'price_field_id' => 1, - 'entity_table' => 'civicrm_contribution', - 'entity_id' => 3, - 'qty' => 1, - 'unit_price' => 50, - 'line_total' => 50, - ]; - - try { - $result = civicrm_api3('LineItem', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function line_item_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 6, - 'values' => [ - '6' => [ - 'id' => '6', - 'entity_table' => 'civicrm_contribution', - 'entity_id' => '3', - 'contribution_id' => '', - 'price_field_id' => '1', - 'label' => 'line item', - 'qty' => '1', - 'unit_price' => '50', - 'line_total' => '50', - 'participant_count' => '', - 'price_field_value_id' => '1', - 'financial_type_id' => '', - 'non_deductible_amount' => '', - 'tax_amount' => '', - 'membership_num_terms' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateLineItem" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/LineItemTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/LineItem/Delete.ex.php b/api/v3/examples/LineItem/Delete.ex.php deleted file mode 100644 index c8cedafc79..0000000000 --- a/api/v3/examples/LineItem/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 17, - ]; - - try { - $result = civicrm_api3('LineItem', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function line_item_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteLineItem" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/LineItemTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/LineItem/Get.ex.php b/api/v3/examples/LineItem/Get.ex.php deleted file mode 100644 index 6fcebcea17..0000000000 --- a/api/v3/examples/LineItem/Get.ex.php +++ /dev/null @@ -1,93 +0,0 @@ - 'civicrm_contribution', - ]; - - try { - $result = civicrm_api3('LineItem', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function line_item_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 15, - 'values' => [ - '15' => [ - 'id' => '15', - 'entity_table' => 'civicrm_contribution', - 'entity_id' => '7', - 'contribution_id' => '7', - 'price_field_id' => '1', - 'label' => 'Contribution Amount', - 'qty' => '1.00', - 'unit_price' => '100.00', - 'line_total' => '100.00', - 'price_field_value_id' => '1', - 'financial_type_id' => '1', - 'non_deductible_amount' => '0.00', - 'tax_amount' => '0.00', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetBasicLineItem" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/LineItemTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/LocBlock/Create.ex.php b/api/v3/examples/LocBlock/Create.ex.php deleted file mode 100644 index b30a85cdcd..0000000000 --- a/api/v3/examples/LocBlock/Create.ex.php +++ /dev/null @@ -1,92 +0,0 @@ - 2, - 'phone_id' => 2, - 'email_id' => 3, - ]; - - try { - $result = civicrm_api3('LocBlock', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function loc_block_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'address_id' => '2', - 'email_id' => '3', - 'phone_id' => '2', - 'im_id' => '', - 'address_2_id' => '', - 'email_2_id' => '', - 'phone_2_id' => '', - 'im_2_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateLocBlock" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/LocBlockTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/LocBlock/CreateEntities.ex.php b/api/v3/examples/LocBlock/CreateEntities.ex.php deleted file mode 100644 index 9b2d00d2b6..0000000000 --- a/api/v3/examples/LocBlock/CreateEntities.ex.php +++ /dev/null @@ -1,151 +0,0 @@ - [ - 'location_type_id' => 1, - 'email' => 'test2@loc.block', - ], - 'phone' => [ - 'location_type_id' => 1, - 'phone' => '987654321', - ], - 'phone_2' => [ - 'location_type_id' => 1, - 'phone' => '456-7890', - ], - 'address' => [ - 'location_type_id' => 1, - 'street_address' => '987654321', - ], - ]; - - try { - $result = civicrm_api3('LocBlock', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function loc_block_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'address' => [ - 'id' => '3', - 'location_type_id' => '1', - 'is_primary' => 0, - 'is_billing' => 0, - 'street_address' => '987654321', - 'manual_geo_code' => 0, - ], - 'email' => [ - 'id' => '4', - 'contact_id' => '', - 'location_type_id' => '1', - 'email' => 'test2@loc.block', - 'is_primary' => 0, - 'is_billing' => '', - 'on_hold' => 0, - 'is_bulkmail' => '', - 'hold_date' => '', - 'reset_date' => '', - 'signature_text' => '', - 'signature_html' => '', - ], - 'phone' => [ - 'id' => '3', - 'contact_id' => '', - 'location_type_id' => '1', - 'is_primary' => 0, - 'is_billing' => '', - 'mobile_provider_id' => '', - 'phone' => '987654321', - 'phone_ext' => '', - 'phone_numeric' => '', - 'phone_type_id' => '', - ], - 'phone_2' => [ - 'id' => '4', - 'contact_id' => '', - 'location_type_id' => '1', - 'is_primary' => 0, - 'is_billing' => '', - 'mobile_provider_id' => '', - 'phone' => '456-7890', - 'phone_ext' => '', - 'phone_numeric' => '', - 'phone_type_id' => '', - ], - 'id' => '3', - 'address_id' => '3', - 'email_id' => '4', - 'phone_id' => '3', - 'im_id' => '', - 'address_2_id' => '', - 'email_2_id' => '', - 'phone_2_id' => '4', - 'im_2_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateLocBlockEntities" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/LocBlockTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/LocBlock/Get.ex.php b/api/v3/examples/LocBlock/Get.ex.php deleted file mode 100644 index 67e14158aa..0000000000 --- a/api/v3/examples/LocBlock/Get.ex.php +++ /dev/null @@ -1,120 +0,0 @@ - 3, - 'return' => 'all', - ]; - - try { - $result = civicrm_api3('LocBlock', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function loc_block_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'address_id' => '3', - 'email_id' => '4', - 'phone_id' => '3', - 'phone_2_id' => '4', - 'address' => [ - 'id' => '3', - 'location_type_id' => '1', - 'is_primary' => 0, - 'is_billing' => 0, - 'street_address' => '987654321', - 'manual_geo_code' => 0, - ], - 'email' => [ - 'id' => '4', - 'location_type_id' => '1', - 'email' => 'test2@loc.block', - 'is_primary' => 0, - 'is_billing' => 0, - 'on_hold' => 0, - 'is_bulkmail' => 0, - ], - 'phone' => [ - 'id' => '3', - 'location_type_id' => '1', - 'is_primary' => 0, - 'is_billing' => 0, - 'phone' => '987654321', - 'phone_numeric' => '987654321', - ], - 'phone_2' => [ - 'id' => '4', - 'location_type_id' => '1', - 'is_primary' => 0, - 'is_billing' => 0, - 'phone' => '456-7890', - 'phone_numeric' => '4567890', - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateLocBlockEntities" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/LocBlockTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Logging/Get.ex.php b/api/v3/examples/Logging/Get.ex.php deleted file mode 100644 index f5431e58cc..0000000000 --- a/api/v3/examples/Logging/Get.ex.php +++ /dev/null @@ -1,246 +0,0 @@ - 'wooty wop wop', - ]; - - try { - $result = civicrm_api3('Logging', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function logging_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 17, - 'values' => [ - '0' => [ - 'action' => 'Update', - 'id' => '3', - 'field' => 'sort_name', - 'from' => 'Anderson, Anthony', - 'to' => 'Dwarf, Dopey', - 'table' => 'civicrm_contact', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '1' => [ - 'action' => 'Update', - 'id' => '3', - 'field' => 'display_name', - 'from' => 'Mr. Anthony Anderson II', - 'to' => 'Mr. Dopey Dwarf II', - 'table' => 'civicrm_contact', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '2' => [ - 'action' => 'Update', - 'id' => '3', - 'field' => 'first_name', - 'from' => 'Anthony', - 'to' => 'Dopey', - 'table' => 'civicrm_contact', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '3' => [ - 'action' => 'Update', - 'id' => '3', - 'field' => 'last_name', - 'from' => 'Anderson', - 'to' => 'Dwarf', - 'table' => 'civicrm_contact', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '4' => [ - 'action' => 'Update', - 'id' => '3', - 'field' => 'modified_date', - 'from' => '2022-01-17 12:53:29', - 'to' => '2022-01-17 12:53:39', - 'table' => 'civicrm_contact', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '5' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'id', - 'from' => '', - 'to' => '4', - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '6' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'contact_id', - 'from' => '', - 'to' => '3', - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '7' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'location_type_id', - 'from' => '', - 'to' => '1', - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '8' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'email', - 'from' => '', - 'to' => 'dopey@mail.com', - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '9' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'is_primary', - 'from' => '', - 'to' => 0, - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '10' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'is_billing', - 'from' => '', - 'to' => 0, - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '11' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'on_hold', - 'from' => '', - 'to' => 0, - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '12' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'is_bulkmail', - 'from' => '', - 'to' => 0, - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '13' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'hold_date', - 'from' => '', - 'to' => '', - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '14' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'reset_date', - 'from' => '', - 'to' => '', - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '15' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'signature_text', - 'from' => '', - 'to' => '', - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - '16' => [ - 'action' => 'Insert', - 'id' => '4', - 'field' => 'signature_html', - 'from' => '', - 'to' => '', - 'table' => 'civicrm_email', - 'log_date' => '2022-01-17 12:53:39', - 'log_conn_id' => 'wooty wop wop', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetNoDate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/LoggingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Logging/Revert.ex.php b/api/v3/examples/Logging/Revert.ex.php deleted file mode 100644 index b7e1100024..0000000000 --- a/api/v3/examples/Logging/Revert.ex.php +++ /dev/null @@ -1,76 +0,0 @@ - 'woot', - 'log_date' => '2022-01-17 12:52:20', - ]; - - try { - $result = civicrm_api3('Logging', 'revert', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function logging_revert_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "/home/seamus/buildkit/build/47-test/web/sites/all/modules/civicrm/tests/phpunit/api/v3/LoggingTest.php" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/Revert - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MailSettings/ChainedGetDelete.ex.php b/api/v3/examples/MailSettings/ChainedGetDelete.ex.php deleted file mode 100644 index df398954ea..0000000000 --- a/api/v3/examples/MailSettings/ChainedGetDelete.ex.php +++ /dev/null @@ -1,100 +0,0 @@ - 'delete this setting', - 'api.MailSettings.delete' => 1, - ]; - - try { - $result = civicrm_api3('MailSettings', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mail_settings_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 10, - 'values' => [ - '10' => [ - 'id' => '10', - 'domain_id' => '1', - 'name' => 'delete this setting', - 'is_default' => '1', - 'domain' => 'setting.com', - 'localpart' => 'civicrm+', - 'server' => 'localhost', - 'username' => 'sue', - 'password' => 'pass', - 'is_ssl' => 0, - 'is_non_case_email_skipped' => 0, - 'is_contact_creation_disabled_if_no_match' => 0, - 'api.MailSettings.delete' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetMailSettingsChainDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MailSettings/Create.ex.php b/api/v3/examples/MailSettings/Create.ex.php deleted file mode 100644 index a30d8c86b0..0000000000 --- a/api/v3/examples/MailSettings/Create.ex.php +++ /dev/null @@ -1,103 +0,0 @@ - 1, - 'name' => 'my mail setting', - 'domain' => 'setting.com', - 'localpart' => 'civicrm+', - 'server' => 'localhost', - 'username' => 'sue', - 'password' => 'pass', - 'is_default' => 1, - ]; - - try { - $result = civicrm_api3('MailSettings', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mail_settings_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 8, - 'values' => [ - '8' => [ - 'id' => '8', - 'domain_id' => '1', - 'name' => 'my mail setting', - 'is_default' => '1', - 'domain' => 'setting.com', - 'localpart' => 'civicrm+', - 'return_path' => '', - 'protocol' => '', - 'server' => 'localhost', - 'port' => '', - 'username' => 'sue', - 'password' => 'pass', - 'is_ssl' => '', - 'source' => '', - 'activity_status' => '', - 'is_non_case_email_skipped' => '', - 'is_contact_creation_disabled_if_no_match' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteMailSettings" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MailSettings/Delete.ex.php b/api/v3/examples/MailSettings/Delete.ex.php deleted file mode 100644 index e2dc25648d..0000000000 --- a/api/v3/examples/MailSettings/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 8, - ]; - - try { - $result = civicrm_api3('MailSettings', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mail_settings_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteMailSettings" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MailSettings/Get.ex.php b/api/v3/examples/MailSettings/Get.ex.php deleted file mode 100644 index 14ff9fe1df..0000000000 --- a/api/v3/examples/MailSettings/Get.ex.php +++ /dev/null @@ -1,98 +0,0 @@ - 1, - 'name' => 'my mail setting', - 'domain' => 'setting.com', - 'localpart' => 'civicrm+', - 'server' => 'localhost', - 'username' => 'sue', - 'password' => 'pass', - 'is_default' => 1, - ]; - - try { - $result = civicrm_api3('MailSettings', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mail_settings_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 6, - 'values' => [ - '6' => [ - 'id' => '6', - 'domain_id' => '1', - 'name' => 'my mail setting', - 'is_default' => '1', - 'domain' => 'setting.com', - 'localpart' => 'civicrm+', - 'server' => 'localhost', - 'username' => 'sue', - 'password' => 'pass', - 'is_ssl' => 0, - 'is_non_case_email_skipped' => 0, - 'is_contact_creation_disabled_if_no_match' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetMailSettings" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MailSettings/GetOptions.ex.php b/api/v3/examples/MailSettings/GetOptions.ex.php deleted file mode 100644 index 75d359bae0..0000000000 --- a/api/v3/examples/MailSettings/GetOptions.ex.php +++ /dev/null @@ -1,80 +0,0 @@ - 'protocol', - ]; - - try { - $result = civicrm_api3('MailSettings', 'getoptions', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mail_settings_getoptions_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 4, - 'values' => [ - '1' => 'IMAP', - '2' => 'Maildir', - '3' => 'POP3', - '4' => 'Localdir', - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testmailProtocol" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ConstantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Mailing/Clone.ex.php b/api/v3/examples/Mailing/Clone.ex.php deleted file mode 100644 index b06c69136a..0000000000 --- a/api/v3/examples/Mailing/Clone.ex.php +++ /dev/null @@ -1,124 +0,0 @@ - 28, - ]; - - try { - $result = civicrm_api3('Mailing', 'clone', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mailing_clone_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 29, - 'values' => [ - '29' => [ - 'id' => '29', - 'domain_id' => '1', - 'header_id' => '1', - 'footer_id' => '2', - 'reply_id' => '8', - 'unsubscribe_id' => '5', - 'resubscribe_id' => '6', - 'optout_id' => '7', - 'name' => 'mailing name', - 'mailing_type' => 'standalone', - 'from_name' => 'FIXME', - 'from_email' => 'info@EXAMPLE.ORG', - 'replyto_email' => 'info@EXAMPLE.ORG', - 'template_type' => 'traditional', - 'template_options' => '', - 'subject' => 'Hello {contact.display_name}', - 'body_text' => 'This is {contact.display_name}. -https://civicrm.org -{domain.address}{action.optOutUrl}', - 'body_html' => '

Forward this email

This is {contact.display_name}.

CiviCRM.org

{domain.address}{action.optOutUrl}

', - 'url_tracking' => '1', - 'forward_replies' => 0, - 'auto_responder' => 0, - 'open_tracking' => '1', - 'is_completed' => '', - 'msg_template_id' => '', - 'override_verp' => '1', - 'created_id' => '157', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'scheduled_id' => '', - 'scheduled_date' => '', - 'approver_id' => '', - 'approval_date' => '', - 'approval_status_id' => '', - 'approval_note' => '', - 'is_archived' => 0, - 'visibility' => 'Public Pages', - 'campaign_id' => '', - 'dedupe_email' => '1', - 'sms_provider_id' => '', - 'hash' => '', - 'location_type_id' => '', - 'email_selection_method' => 'automatic', - 'language' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testClone" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Mailing/Create.ex.php b/api/v3/examples/Mailing/Create.ex.php deleted file mode 100644 index 4ecddd8645..0000000000 --- a/api/v3/examples/Mailing/Create.ex.php +++ /dev/null @@ -1,172 +0,0 @@ - 'Hello {contact.display_name}', - 'body_text' => 'This is {contact.display_name}. -https://civicrm.org -{domain.address}{action.optOutUrl}', - 'body_html' => '

Forward this email

This is {contact.display_name}.

CiviCRM.org

{domain.address}{action.optOutUrl}

', - 'name' => 'mailing name', - 'created_id' => 18, - 'header_id' => '', - 'footer_id' => '', - 'groups' => [ - 'include' => [ - '0' => 15, - ], - 'exclude' => [ - '0' => 16, - ], - ], - 'mailings' => [ - 'include' => [], - 'exclude' => [], - ], - 'options' => [ - 'force_rollback' => 1, - ], - 'api.MailingRecipients.get' => [ - 'mailing_id' => '$value.id', - 'api.contact.getvalue' => [ - 'return' => 'display_name', - ], - 'api.email.getvalue' => [ - 'return' => 'email', - ], - ], - ]; - - try { - $result = civicrm_api3('Mailing', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mailing_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 10, - 'values' => [ - '10' => [ - 'id' => '10', - 'domain_id' => '1', - 'header_id' => '', - 'footer_id' => '', - 'reply_id' => '8', - 'unsubscribe_id' => '5', - 'resubscribe_id' => '6', - 'optout_id' => '7', - 'name' => 'mailing name', - 'mailing_type' => 'standalone', - 'from_name' => 'FIXME', - 'from_email' => 'info@EXAMPLE.ORG', - 'replyto_email' => 'info@EXAMPLE.ORG', - 'template_type' => 'traditional', - 'template_options' => '', - 'subject' => 'Hello {contact.display_name}', - 'body_text' => 'This is {contact.display_name}. -https://civicrm.org -{domain.address}{action.optOutUrl}', - 'body_html' => '

Forward this email

This is {contact.display_name}.

CiviCRM.org

{domain.address}{action.optOutUrl}

', - 'url_tracking' => '1', - 'forward_replies' => 0, - 'auto_responder' => 0, - 'open_tracking' => '1', - 'is_completed' => '', - 'msg_template_id' => '', - 'override_verp' => '1', - 'created_id' => '18', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'scheduled_id' => '', - 'scheduled_date' => '', - 'approver_id' => '', - 'approval_date' => '', - 'approval_status_id' => '', - 'approval_note' => '', - 'is_archived' => 0, - 'visibility' => 'Public Pages', - 'campaign_id' => '', - 'dedupe_email' => '1', - 'sms_provider_id' => '', - 'hash' => '', - 'location_type_id' => '', - 'email_selection_method' => 'automatic', - 'language' => '', - 'api.MailingRecipients.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 4, - 'values' => [ - '0' => [ - 'id' => '4', - 'mailing_id' => '10', - 'contact_id' => '19', - 'email_id' => '19', - 'api.contact.getvalue' => 'Mr. Includer Person II', - 'api.email.getvalue' => 'include.me@example.org', - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMailerPreviewRecipients" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Mailing/Delete.ex.php b/api/v3/examples/Mailing/Delete.ex.php deleted file mode 100644 index 511eff7e1b..0000000000 --- a/api/v3/examples/Mailing/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 27, - ]; - - try { - $result = civicrm_api3('Mailing', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mailing_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMailerDeleteSuccess" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Mailing/GetTokens.ex.php b/api/v3/examples/Mailing/GetTokens.ex.php deleted file mode 100644 index 416b3ac86d..0000000000 --- a/api/v3/examples/Mailing/GetTokens.ex.php +++ /dev/null @@ -1,172 +0,0 @@ - [ - '0' => 'Contact', - '1' => 'Mailing', - ], - ]; - - try { - $result = civicrm_api3('Mailing', 'gettokens', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mailing_gettokens_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 90, - 'values' => [ - '{action.unsubscribe}' => 'Unsubscribe via email', - '{action.unsubscribeUrl}' => 'Unsubscribe via web page', - '{action.resubscribe}' => 'Resubscribe via email', - '{action.resubscribeUrl}' => 'Resubscribe via web page', - '{action.optOut}' => 'Opt out via email', - '{action.optOutUrl}' => 'Opt out via web page', - '{action.forward}' => 'Forward this email (link)', - '{action.reply}' => 'Reply to this email (link)', - '{action.subscribeUrl}' => 'Subscribe via web page', - '{mailing.key}' => 'Mailing key', - '{mailing.name}' => 'Mailing name', - '{mailing.group}' => 'Mailing group', - '{mailing.viewUrl}' => 'Mailing permalink', - '{domain.name}' => 'Domain name', - '{domain.address}' => 'Domain (organization) address', - '{domain.phone}' => 'Domain (organization) phone', - '{domain.email}' => 'Domain (organization) email', - '{domain.id}' => 'Domain ID', - '{domain.description}' => 'Domain Description', - '{domain.now}' => 'Current time/date', - '{domain.base_url}' => 'Domain absolute base url', - '{domain.tax_term}' => 'Sales tax term (e.g VAT)', - '{contact.checksum}' => 'Checksum', - '{contact.current_employer}' => 'Current Employer', - '{contact.world_region}' => 'World Region', - '{contact.id}' => 'Contact ID', - '{contact.contact_type:label}' => 'Contact Type', - '{contact.do_not_email:label}' => 'Do Not Email', - '{contact.do_not_phone:label}' => 'Do Not Phone', - '{contact.do_not_mail:label}' => 'Do Not Mail', - '{contact.do_not_sms:label}' => 'Do Not Sms', - '{contact.do_not_trade:label}' => 'Do Not Trade', - '{contact.is_opt_out:label}' => 'No Bulk Emails (User Opt Out)', - '{contact.external_identifier}' => 'External Identifier', - '{contact.sort_name}' => 'Sort Name', - '{contact.display_name}' => 'Display Name', - '{contact.nick_name}' => 'Nickname', - '{contact.image_URL}' => 'Image Url', - '{contact.preferred_communication_method:label}' => 'Preferred Communication Method', - '{contact.preferred_language:label}' => 'Preferred Language', - '{contact.hash}' => 'Contact Hash', - '{contact.source}' => 'Contact Source', - '{contact.first_name}' => 'First Name', - '{contact.middle_name}' => 'Middle Name', - '{contact.last_name}' => 'Last Name', - '{contact.prefix_id:label}' => 'Individual Prefix', - '{contact.suffix_id:label}' => 'Individual Suffix', - '{contact.formal_title}' => 'Formal Title', - '{contact.communication_style_id:label}' => 'Communication Style', - '{contact.email_greeting_display}' => 'Email Greeting', - '{contact.postal_greeting_display}' => 'Postal Greeting', - '{contact.addressee_display}' => 'Addressee', - '{contact.job_title}' => 'Job Title', - '{contact.gender_id:label}' => 'Gender', - '{contact.birth_date}' => 'Birth Date', - '{contact.employer_id}' => 'Current Employer ID', - '{contact.is_deleted:label}' => 'Contact is in Trash', - '{contact.created_date}' => 'Created Date', - '{contact.modified_date}' => 'Modified Date', - '{contact.address_id}' => 'Address ID', - '{contact.location_type_id:label}' => 'Address Location Type', - '{contact.street_address}' => 'Street Address', - '{contact.street_number}' => 'Street Number', - '{contact.street_number_suffix}' => 'Street Number Suffix', - '{contact.street_name}' => 'Street Name', - '{contact.street_unit}' => 'Street Unit', - '{contact.supplemental_address_1}' => 'Supplemental Address 1', - '{contact.supplemental_address_2}' => 'Supplemental Address 2', - '{contact.supplemental_address_3}' => 'Supplemental Address 3', - '{contact.city}' => 'City', - '{contact.county}' => 'County', - '{contact.postal_code_suffix}' => 'Postal Code Suffix', - '{contact.postal_code}' => 'Postal Code', - '{contact.country}' => 'Country', - '{contact.geo_code_1}' => 'Latitude', - '{contact.geo_code_2}' => 'Longitude', - '{contact.address_name}' => 'Address Name', - '{contact.master_id}' => 'Master Address ID', - '{contact.phone}' => 'Phone', - '{contact.phone_ext}' => 'Phone Extension', - '{contact.phone_type}' => 'Phone Type', - '{contact.email}' => 'Email', - '{contact.on_hold:label}' => 'On Hold', - '{contact.signature_text}' => 'Signature Text', - '{contact.signature_html}' => 'Signature Html', - '{contact.url}' => 'Website', - '{contact.openid}' => 'OpenID', - '{contact.im}' => 'IM Screen Name', - '{contact.provider_id:label}' => 'IM Provider', - '{contact.state_province}' => 'State/Province', - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMailGetTokens" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Mailing/Submit.ex.php b/api/v3/examples/Mailing/Submit.ex.php deleted file mode 100644 index b2bf20e4d9..0000000000 --- a/api/v3/examples/Mailing/Submit.ex.php +++ /dev/null @@ -1,126 +0,0 @@ - '2014-12-13 10:00:00', - 'approval_date' => '2014-12-13 00:00:00', - 'id' => 23, - ]; - - try { - $result = civicrm_api3('Mailing', 'submit', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mailing_submit_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 23, - 'values' => [ - '23' => [ - 'id' => '23', - 'domain_id' => '1', - 'header_id' => '', - 'footer_id' => '33', - 'reply_id' => '8', - 'unsubscribe_id' => '5', - 'resubscribe_id' => '6', - 'optout_id' => '7', - 'name' => 'mailing name', - 'mailing_type' => 'standalone', - 'from_name' => 'FIXME', - 'from_email' => 'info@EXAMPLE.ORG', - 'replyto_email' => 'info@EXAMPLE.ORG', - 'template_type' => 'traditional', - 'template_options' => '', - 'subject' => 'Hello {contact.display_name}', - 'body_text' => 'This is {contact.display_name}. -https://civicrm.org -{domain.address}{action.optOutUrl}', - 'body_html' => '

Look ma, magic tokens in the markup!

', - 'url_tracking' => '1', - 'forward_replies' => 0, - 'auto_responder' => 0, - 'open_tracking' => '1', - 'is_completed' => '', - 'msg_template_id' => '', - 'override_verp' => '1', - 'created_id' => '48', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'scheduled_id' => '49', - 'scheduled_date' => '20130728085413', - 'approver_id' => '49', - 'approval_date' => '20130728085413', - 'approval_status_id' => '1', - 'approval_note' => '', - 'is_archived' => 0, - 'visibility' => 'Public Pages', - 'campaign_id' => '', - 'dedupe_email' => '1', - 'sms_provider_id' => '', - 'hash' => '67eac7789eaee00', - 'location_type_id' => '', - 'email_selection_method' => 'automatic', - 'language' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMailerSubmit" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MailingAB/Create.ex.php b/api/v3/examples/MailingAB/Create.ex.php deleted file mode 100644 index 6a287beb8d..0000000000 --- a/api/v3/examples/MailingAB/Create.ex.php +++ /dev/null @@ -1,99 +0,0 @@ - 1, - 'mailing_id_b' => 2, - 'mailing_id_c' => 3, - 'testing_criteria' => 'subject', - 'winner_criteria' => 'open', - 'declare_winning_time' => '+2 days', - 'group_percentage' => 10, - ]; - - try { - $result = civicrm_api3('MailingAB', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mailing_a_b_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => '', - 'status' => '', - 'mailing_id_a' => '1', - 'mailing_id_b' => '2', - 'mailing_id_c' => '3', - 'domain_id' => '1', - 'testing_criteria' => 'subject', - 'winner_criteria' => 'open', - 'specific_url' => '', - 'declare_winning_time' => '20220119125416', - 'group_percentage' => '10', - 'created_id' => '3', - 'created_date' => '2013-07-28 08:49:19', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMailingABCreateSuccess" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingABTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MailingEventSubscribe/Create.ex.php b/api/v3/examples/MailingEventSubscribe/Create.ex.php deleted file mode 100644 index 9059f57df9..0000000000 --- a/api/v3/examples/MailingEventSubscribe/Create.ex.php +++ /dev/null @@ -1,86 +0,0 @@ - 'test@test.test', - 'group_id' => 2, - 'contact_id' => 3, - 'hash' => 'b15de8b64e2cec34', - 'time_stamp' => '20101212121212', - ]; - - try { - $result = civicrm_api3('MailingEventSubscribe', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mailing_event_subscribe_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'contact_id' => '3', - 'subscribe_id' => '1', - 'hash' => '67eac7789eaee00', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMailerGroupSubscribeGivenContactId" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MailingGroup/Subscribe.ex.php b/api/v3/examples/MailingGroup/Subscribe.ex.php deleted file mode 100644 index df4f96729b..0000000000 --- a/api/v3/examples/MailingGroup/Subscribe.ex.php +++ /dev/null @@ -1,86 +0,0 @@ - 'test@test.test', - 'group_id' => 2, - 'contact_id' => 3, - 'hash' => 'b15de8b64e2cec34', - 'time_stamp' => '20101212121212', - ]; - - try { - $result = civicrm_api3('mailing_group', 'subscribe', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mailing_group_subscribe_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'contact_id' => '3', - 'subscribe_id' => '1', - 'hash' => '67eac7789eaee00', - ], - ], - ]; - - return $expectedResult; -} - -/** -* This example has been generated from the API test suite. -* The test that created it is called -* testMailerGroupSubscribeGivenContactId -* and can be found in -* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingGroupTest.php. -* -* You can see the outcome of the API tests at -* https://test.civicrm.org/job/CiviCRM-master-git/ -* -* To Learn about the API read -* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API -* -* Browse the api on your own site with the api explorer -* http://MYSITE.ORG/path/to/civicrm/api -* -* Read more about testing here -* http://wiki.civicrm.org/confluence/display/CRM/Testing -* -* API Standards documentation: -* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards -*/ diff --git a/api/v3/examples/Mapping/Create.ex.php b/api/v3/examples/Mapping/Create.ex.php deleted file mode 100644 index c3ebff0aee..0000000000 --- a/api/v3/examples/Mapping/Create.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 'Mapping name', - 'description' => 'Mapping description', - 'mapping_type_id' => 7, - ]; - - try { - $result = civicrm_api3('Mapping', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mapping_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => 'Mapping name', - 'description' => 'Mapping description', - 'mapping_type_id' => '7', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateMapping" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Mapping/Delete.ex.php b/api/v3/examples/Mapping/Delete.ex.php deleted file mode 100644 index c70d4fd4d4..0000000000 --- a/api/v3/examples/Mapping/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('Mapping', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mapping_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteMapping" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Mapping/Get.ex.php b/api/v3/examples/Mapping/Get.ex.php deleted file mode 100644 index 1c3c101dd8..0000000000 --- a/api/v3/examples/Mapping/Get.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 'Mapping name', - 'description' => 'Mapping description', - 'mapping_type_id' => 7, - ]; - - try { - $result = civicrm_api3('Mapping', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mapping_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'name' => 'Mapping name', - 'description' => 'Mapping description', - 'mapping_type_id' => '7', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetMapping" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MappingField/Create.ex.php b/api/v3/examples/MappingField/Create.ex.php deleted file mode 100644 index 27a3a7a8f2..0000000000 --- a/api/v3/examples/MappingField/Create.ex.php +++ /dev/null @@ -1,97 +0,0 @@ - 1, - 'name' => 'last_name', - 'contact_type' => 'Individual', - 'column_number' => 2, - 'grouping' => 1, - ]; - - try { - $result = civicrm_api3('MappingField', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mapping_field_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'mapping_id' => '1', - 'name' => 'last_name', - 'contact_type' => 'Individual', - 'column_number' => '2', - 'location_type_id' => '', - 'phone_type_id' => '', - 'im_provider_id' => '', - 'website_type_id' => '', - 'relationship_type_id' => '', - 'relationship_direction' => '', - 'grouping' => '1', - 'operator' => '', - 'value' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateMappingField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MappingField/Delete.ex.php b/api/v3/examples/MappingField/Delete.ex.php deleted file mode 100644 index c9f6b23566..0000000000 --- a/api/v3/examples/MappingField/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('MappingField', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mapping_field_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteMappingField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MappingField/Get.ex.php b/api/v3/examples/MappingField/Get.ex.php deleted file mode 100644 index 3e8403e6be..0000000000 --- a/api/v3/examples/MappingField/Get.ex.php +++ /dev/null @@ -1,89 +0,0 @@ - 2, - 'name' => 'last_name', - 'contact_type' => 'Individual', - 'column_number' => 2, - 'grouping' => 1, - ]; - - try { - $result = civicrm_api3('MappingField', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function mapping_field_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'mapping_id' => '2', - 'name' => 'last_name', - 'contact_type' => 'Individual', - 'column_number' => '2', - 'grouping' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetMappingField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Membership/Create.ex.php b/api/v3/examples/Membership/Create.ex.php deleted file mode 100644 index fed7a91627..0000000000 --- a/api/v3/examples/Membership/Create.ex.php +++ /dev/null @@ -1,102 +0,0 @@ - 3, - 'membership_type_id' => 1, - 'join_date' => '2006-01-21', - 'start_date' => '2006-01-21', - 'end_date' => '2006-12-21', - 'source' => 'Payment', - 'is_override' => 1, - 'status_id' => 33, - ]; - - try { - $result = civicrm_api3('Membership', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'membership_type_id' => '1', - 'join_date' => '20060121000000', - 'start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'source' => 'Payment', - 'status_id' => '33', - 'is_override' => '1', - 'status_override_end_date' => '', - 'owner_membership_id' => '', - 'max_related' => '', - 'is_test' => 0, - 'is_pay_later' => '', - 'contribution_recur_id' => '', - 'campaign_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMembershipCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Membership/CreateWithCustomData.ex.php b/api/v3/examples/Membership/CreateWithCustomData.ex.php deleted file mode 100644 index 4f8ae718da..0000000000 --- a/api/v3/examples/Membership/CreateWithCustomData.ex.php +++ /dev/null @@ -1,103 +0,0 @@ - 3, - 'membership_type_id' => 'General', - 'join_date' => '2009-01-21', - 'start_date' => '2009-01-21', - 'end_date' => '2009-12-21', - 'source' => 'Payment', - 'is_override' => 1, - 'status_id' => 35, - 'custom_1' => 'custom string', - ]; - - try { - $result = civicrm_api3('Membership', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'membership_type_id' => '1', - 'join_date' => '20090121000000', - 'start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'source' => 'Payment', - 'status_id' => '35', - 'is_override' => '1', - 'status_override_end_date' => '', - 'owner_membership_id' => '', - 'max_related' => '', - 'is_test' => 0, - 'is_pay_later' => '', - 'contribution_recur_id' => '', - 'campaign_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateWithCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Membership/Delete.ex.php b/api/v3/examples/Membership/Delete.ex.php deleted file mode 100644 index ee913f54d8..0000000000 --- a/api/v3/examples/Membership/Delete.ex.php +++ /dev/null @@ -1,76 +0,0 @@ - 1, - 'preserve_contribution' => 1, - ]; - - try { - $result = civicrm_api3('Membership', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => TRUE, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testMembershipDeletePreserveContribution" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Membership/FilterIsCurrent.ex.php b/api/v3/examples/Membership/FilterIsCurrent.ex.php deleted file mode 100644 index f8434450f7..0000000000 --- a/api/v3/examples/Membership/FilterIsCurrent.ex.php +++ /dev/null @@ -1,97 +0,0 @@ - 3, - 'filters' => [ - 'is_current' => 1, - ], - ]; - - try { - $result = civicrm_api3('Membership', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'membership_type_id' => '1', - 'join_date' => '2009-01-21', - 'start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'source' => 'Payment', - 'status_id' => '23', - 'is_override' => '1', - 'is_test' => 0, - 'is_pay_later' => 0, - 'membership_name' => 'General', - 'relationship_name' => 'Child of', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetOnlyActive" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Membership/Get.ex.php b/api/v3/examples/Membership/Get.ex.php deleted file mode 100644 index bba4a3150b..0000000000 --- a/api/v3/examples/Membership/Get.ex.php +++ /dev/null @@ -1,82 +0,0 @@ - 'General', - 'return' => 'custom_1', - ]; - - try { - $result = civicrm_api3('Membership', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'custom_1' => 'custom string', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetWithParamsMemberShipIdAndCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Membership/SearchWithCustomData.ex.php b/api/v3/examples/Membership/SearchWithCustomData.ex.php deleted file mode 100644 index 4541fb4909..0000000000 --- a/api/v3/examples/Membership/SearchWithCustomData.ex.php +++ /dev/null @@ -1,102 +0,0 @@ - 3, - 'membership_type_id' => 'General', - 'join_date' => '2009-01-21', - 'start_date' => '2009-01-21', - 'end_date' => '2009-12-21', - 'source' => 'Payment', - 'is_override' => 1, - 'status_id' => 36, - ]; - - try { - $result = civicrm_api3('Membership', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'membership_type_id' => '1', - 'join_date' => '20090121000000', - 'start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'source' => 'Payment', - 'status_id' => '36', - 'is_override' => '1', - 'status_override_end_date' => '', - 'owner_membership_id' => '', - 'max_related' => '', - 'is_test' => 0, - 'is_pay_later' => '', - 'contribution_recur_id' => '', - 'campaign_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testSearchWithCustomDataCRM16036" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Membership/UpdateCustomData.ex.php b/api/v3/examples/Membership/UpdateCustomData.ex.php deleted file mode 100644 index 6552c3487d..0000000000 --- a/api/v3/examples/Membership/UpdateCustomData.ex.php +++ /dev/null @@ -1,103 +0,0 @@ - 3, - 'membership_type_id' => 'General', - 'join_date' => '2009-01-21', - 'start_date' => '2009-01-21', - 'end_date' => '2009-12-21', - 'source' => 'Payment', - 'is_override' => 1, - 'status_id' => 43, - 'custom_1' => 'custom string', - ]; - - try { - $result = civicrm_api3('Membership', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'membership_type_id' => '1', - 'join_date' => '20090121000000', - 'start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'source' => 'Payment', - 'status_id' => '43', - 'is_override' => '1', - 'status_override_end_date' => '', - 'owner_membership_id' => '', - 'max_related' => '', - 'is_test' => 0, - 'is_pay_later' => '', - 'contribution_recur_id' => '', - 'campaign_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testUpdateWithCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MembershipPayment/Create.ex.php b/api/v3/examples/MembershipPayment/Create.ex.php deleted file mode 100644 index d48c64db57..0000000000 --- a/api/v3/examples/MembershipPayment/Create.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 2, - 'membership_id' => 1, - ]; - - try { - $result = civicrm_api3('MembershipPayment', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_payment_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'membership_id' => '1', - 'contribution_id' => '2', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipPaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MembershipPayment/Get.ex.php b/api/v3/examples/MembershipPayment/Get.ex.php deleted file mode 100644 index fbe5c2aee4..0000000000 --- a/api/v3/examples/MembershipPayment/Get.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 3, - 'membership_id' => 2, - ]; - - try { - $result = civicrm_api3('MembershipPayment', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_payment_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'membership_id' => '2', - 'contribution_id' => '3', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipPaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MembershipStatus/Create.ex.php b/api/v3/examples/MembershipStatus/Create.ex.php deleted file mode 100644 index 0ba7d7347f..0000000000 --- a/api/v3/examples/MembershipStatus/Create.ex.php +++ /dev/null @@ -1,94 +0,0 @@ - 'test membership status', - ]; - - try { - $result = civicrm_api3('MembershipStatus', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_status_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 15, - 'values' => [ - '15' => [ - 'id' => '15', - 'name' => 'test membership status', - 'label' => 'test membership status', - 'start_event' => '', - 'start_event_adjust_unit' => '', - 'start_event_adjust_interval' => '', - 'end_event' => '', - 'end_event_adjust_unit' => '', - 'end_event_adjust_interval' => '', - 'is_current_member' => '', - 'is_admin' => '', - 'weight' => '', - 'is_default' => '', - 'is_active' => '', - 'is_reserved' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipStatusTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MembershipStatus/Get.ex.php b/api/v3/examples/MembershipStatus/Get.ex.php deleted file mode 100644 index 095991660f..0000000000 --- a/api/v3/examples/MembershipStatus/Get.ex.php +++ /dev/null @@ -1,89 +0,0 @@ - 'test status', - ]; - - try { - $result = civicrm_api3('MembershipStatus', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_status_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 9, - 'values' => [ - '9' => [ - 'id' => '9', - 'name' => 'test status', - 'label' => 'test status', - 'start_event' => 'start_date', - 'end_event' => 'end_date', - 'is_current_member' => '1', - 'is_admin' => 0, - 'is_default' => 0, - 'is_active' => '1', - 'is_reserved' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipStatusTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MembershipType/Create.ex.php b/api/v3/examples/MembershipType/Create.ex.php deleted file mode 100644 index 93711c6412..0000000000 --- a/api/v3/examples/MembershipType/Create.ex.php +++ /dev/null @@ -1,110 +0,0 @@ - '40+ Membership', - 'description' => 'people above 40 are given health instructions', - 'member_of_contact_id' => 11, - 'financial_type_id' => 1, - 'domain_id' => '1', - 'minimum_fee' => '200', - 'duration_unit' => 'month', - 'duration_interval' => '10', - 'period_type' => 'rolling', - 'visibility' => 'public', - ]; - - try { - $result = civicrm_api3('MembershipType', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_type_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'domain_id' => '1', - 'name' => '40+ Membership', - 'description' => 'people above 40 are given health instructions', - 'member_of_contact_id' => '11', - 'financial_type_id' => '1', - 'minimum_fee' => '200', - 'duration_unit' => 'month', - 'duration_interval' => '10', - 'period_type' => 'rolling', - 'fixed_period_start_day' => '', - 'fixed_period_rollover_day' => '', - 'relationship_type_id' => '', - 'relationship_direction' => '', - 'max_related' => '', - 'visibility' => 'Public', - 'weight' => '', - 'receipt_text_signup' => '', - 'receipt_text_renewal' => '', - 'auto_renew' => '', - 'is_active' => '1', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MembershipType/Delete.ex.php b/api/v3/examples/MembershipType/Delete.ex.php deleted file mode 100644 index 67aff9ba1b..0000000000 --- a/api/v3/examples/MembershipType/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 10, - ]; - - try { - $result = civicrm_api3('MembershipType', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_type_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MembershipType/Get.ex.php b/api/v3/examples/MembershipType/Get.ex.php deleted file mode 100644 index 78bc437361..0000000000 --- a/api/v3/examples/MembershipType/Get.ex.php +++ /dev/null @@ -1,92 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('MembershipType', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function membership_type_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'domain_id' => '1', - 'name' => 'General', - 'member_of_contact_id' => '5', - 'financial_type_id' => '2', - 'minimum_fee' => '0.000000000', - 'duration_unit' => 'year', - 'duration_interval' => '1', - 'period_type' => 'rolling', - 'visibility' => 'Public', - 'auto_renew' => 0, - 'is_active' => '1', - 'contribution_type_id' => '2', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MessageTemplate/Create.ex.php b/api/v3/examples/MessageTemplate/Create.ex.php deleted file mode 100644 index 386818f9cd..0000000000 --- a/api/v3/examples/MessageTemplate/Create.ex.php +++ /dev/null @@ -1,97 +0,0 @@ - 'msg_title_356', - 'msg_subject' => 'msg_subject_356', - 'msg_text' => 'msg_text_356', - 'msg_html' => 'msg_html_356', - 'workflow_id' => 356, - 'is_default' => '1', - 'is_reserved' => 0, - ]; - - try { - $result = civicrm_api3('MessageTemplate', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function message_template_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 69, - 'values' => [ - '69' => [ - 'id' => '69', - 'msg_title' => 'msg_title_356', - 'msg_subject' => 'msg_subject_356', - 'msg_text' => 'msg_text_356', - 'msg_html' => 'msg_html_356', - 'is_active' => '1', - 'workflow_id' => '356', - 'workflow_name' => '', - 'is_default' => '1', - 'is_reserved' => 0, - 'is_sms' => '', - 'pdf_format_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MessageTemplateTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MessageTemplate/Delete.ex.php b/api/v3/examples/MessageTemplate/Delete.ex.php deleted file mode 100644 index 4d3a118c99..0000000000 --- a/api/v3/examples/MessageTemplate/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 72, - ]; - - try { - $result = civicrm_api3('MessageTemplate', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function message_template_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MessageTemplateTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/MessageTemplate/Get.ex.php b/api/v3/examples/MessageTemplate/Get.ex.php deleted file mode 100644 index 3edf3985b4..0000000000 --- a/api/v3/examples/MessageTemplate/Get.ex.php +++ /dev/null @@ -1,97 +0,0 @@ - 'msg_title_357', - 'msg_subject' => 'msg_subject_357', - 'msg_text' => 'msg_text_357', - 'msg_html' => 'msg_html_357', - 'workflow_id' => 357, - 'is_default' => '1', - 'is_reserved' => 0, - ]; - - try { - $result = civicrm_api3('MessageTemplate', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function message_template_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 70, - 'values' => [ - '70' => [ - 'id' => '70', - 'msg_title' => 'msg_title_357', - 'msg_subject' => 'msg_subject_357', - 'msg_text' => 'msg_text_357', - 'msg_html' => 'msg_html_357', - 'is_active' => '1', - 'workflow_id' => '357', - 'workflow_name' => 'workflow_name_357', - 'is_default' => '1', - 'is_reserved' => 0, - 'is_sms' => 0, - 'pdf_format_id' => '357', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MessageTemplateTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Note/Create.ex.php b/api/v3/examples/Note/Create.ex.php deleted file mode 100644 index 71fb2729a8..0000000000 --- a/api/v3/examples/Note/Create.ex.php +++ /dev/null @@ -1,96 +0,0 @@ - 'civicrm_contact', - 'entity_id' => 15, - 'note' => 'Hello!!! m testing Note', - 'contact_id' => 15, - 'created_date' => '2012-01-17 13:04:50', - 'note_date' => '2012-01-17 13:04:50', - 'modified_date' => '2011-01-31', - 'subject' => 'Test Note', - ]; - - try { - $result = civicrm_api3('Note', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function note_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 14, - 'values' => [ - '14' => [ - 'id' => '14', - 'entity_table' => 'civicrm_contact', - 'entity_id' => '15', - 'note' => 'Hello!!! m testing Note', - 'contact_id' => '15', - 'note_date' => '20120117130450', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - 'subject' => 'Test Note', - 'privacy' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/NoteTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Note/Delete.ex.php b/api/v3/examples/Note/Delete.ex.php deleted file mode 100644 index 370c49a036..0000000000 --- a/api/v3/examples/Note/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 35, - ]; - - try { - $result = civicrm_api3('Note', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function note_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/NoteTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Note/Get.ex.php b/api/v3/examples/Note/Get.ex.php deleted file mode 100644 index c62583b45a..0000000000 --- a/api/v3/examples/Note/Get.ex.php +++ /dev/null @@ -1,76 +0,0 @@ - 'civicrm_contact', - 'entity_id' => 5, - ]; - - try { - $result = civicrm_api3('Note', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function note_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => [], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/NoteTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/OpenID/Create.ex.php b/api/v3/examples/OpenID/Create.ex.php deleted file mode 100644 index 41d665c8ba..0000000000 --- a/api/v3/examples/OpenID/Create.ex.php +++ /dev/null @@ -1,87 +0,0 @@ - 5, - 'openid' => 'My OpenID handle', - 'sequential' => 1, - ]; - - try { - $result = civicrm_api3('OpenID', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function open_i_d_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '0' => [ - 'id' => '3', - 'contact_id' => '5', - 'location_type_id' => '1', - 'openid' => 'My OpenID handle', - 'allowed_to_login' => '', - 'is_primary' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateOpenIDDefaultLocation" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OpenIDTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/OpenID/Delete.ex.php b/api/v3/examples/OpenID/Delete.ex.php deleted file mode 100644 index 1e906d9fbf..0000000000 --- a/api/v3/examples/OpenID/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 7, - ]; - - try { - $result = civicrm_api3('OpenID', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function open_i_d_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteOpenID" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OpenIDTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/OpenID/Get.ex.php b/api/v3/examples/OpenID/Get.ex.php deleted file mode 100644 index 1f117d1dd0..0000000000 --- a/api/v3/examples/OpenID/Get.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 7, - 'openid' => 'My OpenID handle', - 'location_type_id' => 1, - 'sequential' => 1, - ]; - - try { - $result = civicrm_api3('OpenID', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function open_i_d_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 5, - 'values' => [ - '0' => [ - 'id' => '5', - 'contact_id' => '7', - 'location_type_id' => '1', - 'openid' => 'My OpenID handle', - 'allowed_to_login' => 0, - 'is_primary' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetOpenID" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OpenIDTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/OptionGroup/Create.ex.php b/api/v3/examples/OptionGroup/Create.ex.php deleted file mode 100644 index 1f23a4dc8e..0000000000 --- a/api/v3/examples/OptionGroup/Create.ex.php +++ /dev/null @@ -1,98 +0,0 @@ - 1, - 'name' => 'civicrm_event.amount.560', - 'is_reserved' => 1, - 'is_active' => 1, - 'api.OptionValue.create' => [ - 'label' => 'workshop', - 'value' => 35, - 'is_default' => 1, - 'is_active' => 1, - 'format.only_id' => 1, - ], - ]; - - try { - $result = civicrm_api3('OptionGroup', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function option_group_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 96, - 'values' => [ - '0' => [ - 'id' => '96', - 'name' => 'civicrm_event.amount.560', - 'title' => '', - 'description' => '', - 'data_type' => '', - 'is_reserved' => '1', - 'is_active' => '1', - 'is_locked' => '', - 'api.OptionValue.create' => 859, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetOptionCreateSuccess" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/OptionGroup/Delete.ex.php b/api/v3/examples/OptionGroup/Delete.ex.php deleted file mode 100644 index 7b1e6acedd..0000000000 --- a/api/v3/examples/OptionGroup/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 101, - ]; - - try { - $result = civicrm_api3('OptionGroup', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function option_group_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteOptionGroup" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/OptionGroup/Get.ex.php b/api/v3/examples/OptionGroup/Get.ex.php deleted file mode 100644 index 570c36ab2a..0000000000 --- a/api/v3/examples/OptionGroup/Get.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 'preferred_communication_method', - ]; - - try { - $result = civicrm_api3('OptionGroup', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function option_group_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => 'preferred_communication_method', - 'title' => 'Preferred Communication Method', - 'is_reserved' => '1', - 'is_active' => '1', - 'is_locked' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetOptionGroupByName" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/OptionValue/Get.ex.php b/api/v3/examples/OptionValue/Get.ex.php deleted file mode 100644 index a69c81178e..0000000000 --- a/api/v3/examples/OptionValue/Get.ex.php +++ /dev/null @@ -1,136 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('OptionValue', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function option_value_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 5, - 'values' => [ - '1' => [ - 'id' => '1', - 'option_group_id' => '1', - 'label' => 'Phone', - 'value' => '1', - 'name' => 'Phone', - 'filter' => 0, - 'weight' => '1', - 'is_optgroup' => 0, - 'is_reserved' => 0, - 'is_active' => '1', - ], - '2' => [ - 'id' => '2', - 'option_group_id' => '1', - 'label' => 'Email', - 'value' => '2', - 'name' => 'Email', - 'filter' => 0, - 'weight' => '2', - 'is_optgroup' => 0, - 'is_reserved' => 0, - 'is_active' => '1', - ], - '3' => [ - 'id' => '3', - 'option_group_id' => '1', - 'label' => 'Postal Mail', - 'value' => '3', - 'name' => 'Postal Mail', - 'filter' => 0, - 'weight' => '3', - 'is_optgroup' => 0, - 'is_reserved' => 0, - 'is_active' => '1', - ], - '4' => [ - 'id' => '4', - 'option_group_id' => '1', - 'label' => 'SMS', - 'value' => '4', - 'name' => 'SMS', - 'filter' => 0, - 'weight' => '4', - 'is_optgroup' => 0, - 'is_reserved' => 0, - 'is_active' => '1', - ], - '5' => [ - 'id' => '5', - 'option_group_id' => '1', - 'label' => 'Fax', - 'value' => '5', - 'name' => 'Fax', - 'filter' => 0, - 'weight' => '5', - 'is_optgroup' => 0, - 'is_reserved' => 0, - 'is_active' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetOptionGroup" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionValueTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/OptionValue/SortOption.ex.php b/api/v3/examples/OptionValue/SortOption.ex.php deleted file mode 100644 index c68a2e3fd0..0000000000 --- a/api/v3/examples/OptionValue/SortOption.ex.php +++ /dev/null @@ -1,87 +0,0 @@ - 1, - 'options' => [ - 'sort' => 'label DESC', - 'limit' => 1, - ], - ]; - - try { - $result = civicrm_api3('OptionValue', 'getsingle', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function option_value_getsingle_expectedresult() { - - $expectedResult = [ - 'id' => '4', - 'option_group_id' => '1', - 'label' => 'SMS', - 'value' => '4', - 'name' => 'SMS', - 'filter' => 0, - 'weight' => '4', - 'is_optgroup' => 0, - 'is_reserved' => 0, - 'is_active' => '1', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetSingleValueOptionValueSort" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionValueTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Order/Cancel.ex.php b/api/v3/examples/Order/Cancel.ex.php deleted file mode 100644 index 2ae843024d..0000000000 --- a/api/v3/examples/Order/Cancel.ex.php +++ /dev/null @@ -1,111 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Order', 'cancel', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function order_cancel_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '55', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '4', - 'receive_date' => '2010-01-20 00:00:00', - 'non_deductible_amount' => '0.00', - 'total_amount' => '100.00', - 'fee_amount' => '0.00', - 'net_amount' => '100.00', - 'trxn_id' => '', - 'invoice_id' => '', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => '', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => 0, - 'is_pay_later' => 0, - 'contribution_status_id' => '3', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => 'CN_1', - 'tax_amount' => '0.00', - 'revenue_recognition_date' => '', - 'is_template' => 0, - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCancelOrder" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Order/Create.ex.php b/api/v3/examples/Order/Create.ex.php deleted file mode 100644 index f1ecc96b39..0000000000 --- a/api/v3/examples/Order/Create.ex.php +++ /dev/null @@ -1,157 +0,0 @@ - 10, - 'receive_date' => '2010-01-20', - 'financial_type_id' => 'Event Fee', - 'contribution_status_id' => 'Pending', - 'line_items' => [ - '0' => [ - 'line_item' => [ - '0' => [ - 'price_field_id' => '4', - 'price_field_value_id' => '5', - 'label' => 'Price Field 2', - 'field_title' => 'Price Field 2', - 'qty' => 1, - 'unit_price' => '200.000000000', - 'line_total' => '200.000000000', - 'financial_type_id' => '4', - 'entity_table' => 'civicrm_membership', - 'membership_type_id' => 1, - ], - ], - 'params' => [ - 'contact_id' => 10, - 'membership_type_id' => 2, - 'join_date' => '2006-01-21', - 'start_date' => '2006-01-21', - 'end_date' => '2006-12-21', - 'source' => 'Payment', - 'is_override' => 1, - ], - ], - ], - ]; - - try { - $result = civicrm_api3('Order', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function order_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '10', - 'financial_type_id' => '4', - 'contribution_page_id' => '', - 'payment_instrument_id' => '4', - 'receive_date' => '20100120000000', - 'non_deductible_amount' => '', - 'total_amount' => '200', - 'fee_amount' => 0, - 'net_amount' => '200', - 'trxn_id' => '', - 'invoice_id' => '', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => '', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '2', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '4', - 'line_item' => [ - '0' => [ - 'price_field_id' => '4', - 'price_field_value_id' => '5', - 'label' => 'Price Field 2', - 'field_title' => 'Price Field 2', - 'qty' => '1', - 'unit_price' => '200.000000000', - 'line_total' => '200.000000000', - 'financial_type_id' => '4', - 'entity_table' => 'civicrm_membership', - 'membership_type_id' => '1', - 'tax_amount' => 0, - 'entity_id' => '1', - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testAddOrderForMembership" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Order/CreateOrderParticipant.ex.php b/api/v3/examples/Order/CreateOrderParticipant.ex.php deleted file mode 100644 index 310df9736c..0000000000 --- a/api/v3/examples/Order/CreateOrderParticipant.ex.php +++ /dev/null @@ -1,179 +0,0 @@ - 41, - 'receive_date' => '2010-01-20', - 'financial_type_id' => 1, - 'contribution_status_id' => 'Pending', - 'line_items' => [ - '0' => [ - 'line_item' => [ - '2' => [ - 'price_field_id' => '2', - 'price_field_value_id' => '2', - 'label' => 'Price Field 1', - 'field_title' => 'Price Field 1', - 'qty' => 1, - 'unit_price' => '100.000000000', - 'line_total' => '100.000000000', - 'financial_type_id' => '4', - 'entity_table' => 'civicrm_participant', - ], - '3' => [ - 'price_field_id' => '2', - 'price_field_value_id' => '3', - 'label' => 'Price Field 2', - 'field_title' => 'Price Field 2', - 'qty' => 1, - 'unit_price' => '200.000000000', - 'line_total' => '200.000000000', - 'financial_type_id' => '4', - 'entity_table' => 'civicrm_participant', - ], - ], - 'params' => [ - 'contact_id' => 41, - 'event_id' => 1, - 'role_id' => 1, - 'register_date' => '2007-07-21 00:00:00', - 'source' => 'Online Event Registration: API Testing', - ], - ], - ], - ]; - - try { - $result = civicrm_api3('Order', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function order_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '41', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'payment_instrument_id' => '4', - 'receive_date' => '20100120000000', - 'non_deductible_amount' => '', - 'total_amount' => '300', - 'fee_amount' => 0, - 'net_amount' => '300', - 'trxn_id' => '', - 'invoice_id' => '', - 'invoice_number' => '', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => '', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '2', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => 0, - 'revenue_recognition_date' => '', - 'is_template' => '', - 'contribution_type_id' => '1', - 'line_item' => [ - '0' => [ - 'price_field_id' => '2', - 'price_field_value_id' => '2', - 'label' => 'Price Field 1', - 'field_title' => 'Price Field 1', - 'qty' => '1', - 'unit_price' => '100.000000000', - 'line_total' => '100.000000000', - 'financial_type_id' => '4', - 'entity_table' => 'civicrm_participant', - 'tax_amount' => 0, - 'entity_id' => '1', - ], - '1' => [ - 'price_field_id' => '2', - 'price_field_value_id' => '3', - 'label' => 'Price Field 2', - 'field_title' => 'Price Field 2', - 'qty' => '1', - 'unit_price' => '200.000000000', - 'line_total' => '200.000000000', - 'financial_type_id' => '4', - 'entity_table' => 'civicrm_participant', - 'tax_amount' => 0, - 'entity_id' => '1', - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testAddOrderForParticipant" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Order/Delete.ex.php b/api/v3/examples/Order/Delete.ex.php deleted file mode 100644 index 756db3d722..0000000000 --- a/api/v3/examples/Order/Delete.ex.php +++ /dev/null @@ -1,78 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Order', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function order_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => 1, - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteOrder" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Order/Get.ex.php b/api/v3/examples/Order/Get.ex.php deleted file mode 100644 index abbca0d6b2..0000000000 --- a/api/v3/examples/Order/Get.ex.php +++ /dev/null @@ -1,141 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Order', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function order_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'contact_id' => '3', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Anderson, Anthony', - 'display_name' => 'Mr. Anthony Anderson II', - 'contribution_id' => '1', - 'currency' => 'USD', - 'contribution_recur_id' => '', - 'contribution_status_id' => '1', - 'contribution_campaign_id' => '', - 'payment_instrument_id' => '4', - 'receive_date' => '2010-01-20 00:00:00', - 'non_deductible_amount' => '0.00', - 'total_amount' => '100.00', - 'fee_amount' => '0.00', - 'net_amount' => '100.00', - 'trxn_id' => '', - 'invoice_id' => '', - 'invoice_number' => '', - 'contribution_cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'contribution_source' => '', - 'amount_level' => '', - 'is_test' => 0, - 'is_pay_later' => 0, - 'contribution_check_number' => '', - 'financial_account_id' => '1', - 'accounting_code' => '4200', - 'campaign_id' => '', - 'contribution_campaign_title' => '', - 'financial_type_id' => '1', - 'contribution_note' => '', - 'contribution_batch' => '', - 'contribution_recur_status' => 'Completed', - 'payment_instrument' => 'Check', - 'contribution_status' => 'Completed', - 'financial_type' => 'Donation', - 'check_number' => '', - 'instrument_id' => '4', - 'cancel_date' => '', - 'id' => '1', - 'contribution_type_id' => '1', - 'line_items' => [ - '0' => [ - 'id' => '1', - 'entity_table' => 'civicrm_contribution', - 'entity_id' => '1', - 'contribution_id' => '1', - 'price_field_id' => '1', - 'label' => 'Contribution Amount', - 'qty' => '1.00', - 'unit_price' => '100.00', - 'line_total' => '100.00', - 'price_field_value_id' => '1', - 'financial_type_id' => '1', - 'non_deductible_amount' => '0.00', - 'tax_amount' => '0.00', - 'contribution_type_id' => '1', - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetOrder" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Participant/Create.ex.php b/api/v3/examples/Participant/Create.ex.php deleted file mode 100644 index 16a7251ba6..0000000000 --- a/api/v3/examples/Participant/Create.ex.php +++ /dev/null @@ -1,104 +0,0 @@ - 4, - 'event_id' => 3, - 'status_id' => 1, - 'role_id' => 1, - 'register_date' => '2007-07-21 00:00:00', - 'source' => 'Online Event Registration: API Testing', - 'custom_1' => 'custom string', - ]; - - try { - $result = civicrm_api3('Participant', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 4, - 'values' => [ - '4' => [ - 'id' => '4', - 'contact_id' => '4', - 'event_id' => '3', - 'status_id' => '1', - 'role_id' => '1', - 'register_date' => '20070721000000', - 'source' => 'Online Event Registration: API Testing', - 'fee_level' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'fee_amount' => '', - 'registered_by_id' => '', - 'discount_id' => '', - 'fee_currency' => '', - 'campaign_id' => '', - 'discount_amount' => '', - 'cart_id' => '', - 'must_wait' => '', - 'transferred_to_contact_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateWithCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Participant/Get.ex.php b/api/v3/examples/Participant/Get.ex.php deleted file mode 100644 index 035406a6d0..0000000000 --- a/api/v3/examples/Participant/Get.ex.php +++ /dev/null @@ -1,107 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Participant', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'contact_id' => '4', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Anderson, Anthony', - 'display_name' => 'Mr. Anthony Anderson II', - 'event_id' => '6', - 'event_title' => 'Annual CiviCRM meet', - 'event_start_date' => '2013-07-29 00:00:00', - 'event_end_date' => '2013-08-04 00:00:00', - 'default_role_id' => '1', - 'participant_id' => '1', - 'participant_fee_level' => '', - 'participant_fee_amount' => '', - 'participant_fee_currency' => '', - 'event_type' => 'Conference', - 'participant_status_id' => '2', - 'participant_status' => 'Attended', - 'participant_role_id' => '1', - 'participant_role' => 'Attendee', - 'participant_register_date' => '2007-02-19 00:00:00', - 'participant_source' => 'Wimbeldon', - 'participant_note' => '', - 'participant_is_pay_later' => 0, - 'participant_is_test' => 0, - 'participant_registered_by_id' => '', - 'participant_discount_name' => '', - 'participant_campaign_id' => '', - 'id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetParamsAsIdOnly" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Participant/NestedDelete.ex.php b/api/v3/examples/Participant/NestedDelete.ex.php deleted file mode 100644 index bf49461548..0000000000 --- a/api/v3/examples/Participant/NestedDelete.ex.php +++ /dev/null @@ -1,151 +0,0 @@ - 6, - 'api.participant.delete' => 1, - ]; - - try { - $result = civicrm_api3('Participant', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '2' => [ - 'contact_id' => '6', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Anderson, Anthony', - 'display_name' => 'Mr. Anthony Anderson II', - 'event_id' => '40', - 'event_title' => 'Annual CiviCRM meet', - 'event_start_date' => '2013-07-29 00:00:00', - 'event_end_date' => '2013-08-04 00:00:00', - 'default_role_id' => '1', - 'participant_id' => '2', - 'participant_fee_level' => '', - 'participant_fee_amount' => '', - 'participant_fee_currency' => '', - 'event_type' => 'Conference', - 'participant_status_id' => '2', - 'participant_status' => 'Attended', - 'participant_role_id' => '1', - 'participant_role' => 'Attendee', - 'participant_register_date' => '2007-02-19 00:00:00', - 'participant_source' => 'Wimbeldon', - 'participant_note' => '', - 'participant_is_pay_later' => 0, - 'participant_is_test' => 0, - 'participant_registered_by_id' => '1', - 'participant_discount_name' => '', - 'participant_campaign_id' => '', - 'id' => '2', - 'api.participant.delete' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ], - ], - '3' => [ - 'contact_id' => '6', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Anderson, Anthony', - 'display_name' => 'Mr. Anthony Anderson II', - 'event_id' => '40', - 'event_title' => 'Annual CiviCRM meet', - 'event_start_date' => '2013-07-29 00:00:00', - 'event_end_date' => '2013-08-04 00:00:00', - 'default_role_id' => '1', - 'participant_id' => '3', - 'participant_fee_level' => '', - 'participant_fee_amount' => '', - 'participant_fee_currency' => '', - 'event_type' => 'Conference', - 'participant_status_id' => '2', - 'participant_status' => 'Attended', - 'participant_role_id' => '1', - 'participant_role' => 'Attendee', - 'participant_register_date' => '2007-02-19 00:00:00', - 'participant_source' => 'Wimbeldon', - 'participant_note' => '', - 'participant_is_pay_later' => 0, - 'participant_is_test' => 0, - 'participant_registered_by_id' => '', - 'participant_discount_name' => '', - 'participant_campaign_id' => '', - 'id' => '3', - 'api.participant.delete' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testNestedDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Participant/NestedEventGet.ex.php b/api/v3/examples/Participant/NestedEventGet.ex.php deleted file mode 100644 index 921653f471..0000000000 --- a/api/v3/examples/Participant/NestedEventGet.ex.php +++ /dev/null @@ -1,155 +0,0 @@ - 1, - 'api.event.get' => 1, - ]; - - try { - $result = civicrm_api3('Participant', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'contact_id' => '4', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Anderson, Anthony', - 'display_name' => 'Mr. Anthony Anderson II', - 'event_id' => '7', - 'event_title' => 'Annual CiviCRM meet', - 'event_start_date' => '2013-07-29 00:00:00', - 'event_end_date' => '2013-08-04 00:00:00', - 'default_role_id' => '1', - 'participant_id' => '1', - 'participant_fee_level' => '', - 'participant_fee_amount' => '', - 'participant_fee_currency' => '', - 'event_type' => 'Conference', - 'participant_status_id' => '2', - 'participant_status' => 'Attended', - 'participant_role_id' => '1', - 'participant_role' => 'Attendee', - 'participant_register_date' => '2007-02-19 00:00:00', - 'participant_source' => 'Wimbeldon', - 'participant_note' => '', - 'participant_is_pay_later' => 0, - 'participant_is_test' => 0, - 'participant_registered_by_id' => '', - 'participant_discount_name' => '', - 'participant_campaign_id' => '', - 'id' => '1', - 'api.event.get' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 7, - 'values' => [ - '0' => [ - 'id' => '7', - 'title' => 'Annual CiviCRM meet', - 'event_title' => 'Annual CiviCRM meet', - 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now', - 'description' => 'This event is intended to give brief idea about progress of CiviCRM and giving solutions to common user issues', - 'event_description' => 'This event is intended to give brief idea about progress of CiviCRM and giving solutions to common user issues', - 'event_type_id' => '1', - 'is_public' => '1', - 'start_date' => '2013-07-29 00:00:00', - 'event_start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'event_end_date' => '2013-08-04 00:00:00', - 'is_online_registration' => '1', - 'registration_start_date' => '2008-06-01 00:00:00', - 'registration_end_date' => '2008-10-15 00:00:00', - 'max_participants' => '100', - 'event_full_text' => 'Sorry! We are already full', - 'is_monetary' => 0, - 'is_map' => 0, - 'is_active' => '1', - 'is_show_location' => 0, - 'default_role_id' => '1', - 'is_email_confirm' => '1', - 'is_pay_later' => 0, - 'is_partial_payment' => 0, - 'is_multiple_registrations' => 0, - 'max_additional_participants' => 0, - 'allow_same_participant_emails' => 0, - 'allow_selfcancelxfer' => 0, - 'selfcancelxfer_time' => 0, - 'is_template' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'is_share' => '1', - 'is_confirm_enabled' => '1', - 'is_billing_required' => 0, - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetNestedEventGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ParticipantPayment/Create.ex.php b/api/v3/examples/ParticipantPayment/Create.ex.php deleted file mode 100644 index e94e5914c3..0000000000 --- a/api/v3/examples/ParticipantPayment/Create.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 1, - 'contribution_id' => 1, - ]; - - try { - $result = civicrm_api3('ParticipantPayment', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_payment_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'participant_id' => '1', - 'contribution_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testPaymentCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantPaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ParticipantPayment/Delete.ex.php b/api/v3/examples/ParticipantPayment/Delete.ex.php deleted file mode 100644 index 0068ea6d24..0000000000 --- a/api/v3/examples/ParticipantPayment/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 6, - ]; - - try { - $result = civicrm_api3('ParticipantPayment', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_payment_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testPaymentDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantPaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ParticipantPayment/Get.ex.php b/api/v3/examples/ParticipantPayment/Get.ex.php deleted file mode 100644 index 52c297b5ab..0000000000 --- a/api/v3/examples/ParticipantPayment/Get.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 32, - 'contribution_id' => 7, - ]; - - try { - $result = civicrm_api3('ParticipantPayment', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_payment_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 7, - 'values' => [ - '7' => [ - 'id' => '7', - 'participant_id' => '32', - 'contribution_id' => '7', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantPaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ParticipantStatusType/Create.ex.php b/api/v3/examples/ParticipantStatusType/Create.ex.php deleted file mode 100644 index 4a5f419947..0000000000 --- a/api/v3/examples/ParticipantStatusType/Create.ex.php +++ /dev/null @@ -1,95 +0,0 @@ - 'test status', - 'label' => 'I am a test', - 'class' => 'Positive', - 'is_reserved' => 0, - 'is_active' => 1, - 'is_counted' => 1, - 'visibility_id' => 1, - 'weight' => 10, - ]; - - try { - $result = civicrm_api3('ParticipantStatusType', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_status_type_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 18, - 'values' => [ - '18' => [ - 'id' => '18', - 'name' => 'test status', - 'label' => 'I am a test', - 'class' => 'Positive', - 'is_reserved' => 0, - 'is_active' => '1', - 'is_counted' => '1', - 'weight' => '10', - 'visibility_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetParticipantStatusType" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantStatusTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ParticipantStatusType/Delete.ex.php b/api/v3/examples/ParticipantStatusType/Delete.ex.php deleted file mode 100644 index 9cb675fbfd..0000000000 --- a/api/v3/examples/ParticipantStatusType/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 19, - ]; - - try { - $result = civicrm_api3('ParticipantStatusType', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_status_type_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => TRUE, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteParticipantStatusType" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantStatusTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ParticipantStatusType/Get.ex.php b/api/v3/examples/ParticipantStatusType/Get.ex.php deleted file mode 100644 index ccc0988064..0000000000 --- a/api/v3/examples/ParticipantStatusType/Get.ex.php +++ /dev/null @@ -1,95 +0,0 @@ - 'test status', - 'label' => 'I am a test', - 'class' => 'Positive', - 'is_reserved' => 0, - 'is_active' => 1, - 'is_counted' => 1, - 'visibility_id' => 1, - 'weight' => 10, - ]; - - try { - $result = civicrm_api3('ParticipantStatusType', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function participant_status_type_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 18, - 'values' => [ - '18' => [ - 'id' => '18', - 'name' => 'test status', - 'label' => 'I am a test', - 'class' => 'Positive', - 'is_reserved' => 0, - 'is_active' => '1', - 'is_counted' => '1', - 'weight' => '10', - 'visibility_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetParticipantStatusType" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantStatusTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Payment/Cancel.ex.php b/api/v3/examples/Payment/Cancel.ex.php deleted file mode 100644 index 323aaad977..0000000000 --- a/api/v3/examples/Payment/Cancel.ex.php +++ /dev/null @@ -1,93 +0,0 @@ - 1, - 'check_permissions' => TRUE, - ]; - - try { - $result = civicrm_api3('Payment', 'cancel', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_cancel_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'from_financial_account_id' => '7', - 'to_financial_account_id' => '6', - 'trxn_date' => '20220117131002', - 'total_amount' => '-150', - 'fee_amount' => 0, - 'net_amount' => '-150', - 'currency' => 'USD', - 'is_payment' => '1', - 'trxn_id' => '', - 'trxn_result_code' => '', - 'status_id' => '7', - 'payment_processor_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCancelPayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Payment/Create.ex.php b/api/v3/examples/Payment/Create.ex.php deleted file mode 100644 index c1b14fd8e0..0000000000 --- a/api/v3/examples/Payment/Create.ex.php +++ /dev/null @@ -1,93 +0,0 @@ - 1, - 'total_amount' => 50, - ]; - - try { - $result = civicrm_api3('Payment', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'from_financial_account_id' => '7', - 'to_financial_account_id' => '6', - 'trxn_date' => '20220117130949', - 'total_amount' => '50', - 'fee_amount' => 0, - 'net_amount' => '50', - 'currency' => 'USD', - 'is_payment' => '1', - 'trxn_id' => '', - 'trxn_result_code' => '', - 'status_id' => '1', - 'payment_processor_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePaymentNoLineItems" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Payment/CreatePaymentWithLineItems.ex.php b/api/v3/examples/Payment/CreatePaymentWithLineItems.ex.php deleted file mode 100644 index c611d3ca7a..0000000000 --- a/api/v3/examples/Payment/CreatePaymentWithLineItems.ex.php +++ /dev/null @@ -1,103 +0,0 @@ - 1, - 'total_amount' => 50, - 'line_item' => [ - '0' => [ - '1' => 10, - ], - '1' => [ - '2' => 40, - ], - ], - ]; - - try { - $result = civicrm_api3('Payment', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'from_financial_account_id' => '7', - 'to_financial_account_id' => '6', - 'trxn_date' => '20220117130953', - 'total_amount' => '50', - 'fee_amount' => 0, - 'net_amount' => '50', - 'currency' => 'USD', - 'is_payment' => '1', - 'trxn_id' => '', - 'trxn_result_code' => '', - 'status_id' => '1', - 'payment_processor_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePaymentLineItems" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Payment/Delete.ex.php b/api/v3/examples/Payment/Delete.ex.php deleted file mode 100644 index 63a7fc79ce..0000000000 --- a/api/v3/examples/Payment/Delete.ex.php +++ /dev/null @@ -1,76 +0,0 @@ - '1', - 'check_permissions' => TRUE, - ]; - - try { - $result = civicrm_api3('Payment', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Payment/Get.ex.php b/api/v3/examples/Payment/Get.ex.php deleted file mode 100644 index 7028841c0c..0000000000 --- a/api/v3/examples/Payment/Get.ex.php +++ /dev/null @@ -1,92 +0,0 @@ - 1, - 'check_permissions' => TRUE, - ]; - - try { - $result = civicrm_api3('Payment', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'to_financial_account_id' => '6', - 'trxn_date' => '2010-01-20 00:00:00', - 'total_amount' => '100.00', - 'fee_amount' => '0.00', - 'net_amount' => '100.00', - 'currency' => 'USD', - 'is_payment' => '1', - 'trxn_id' => '23456', - 'status_id' => '1', - 'payment_instrument_id' => '4', - 'contribution_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetPayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Payment/UpdatePayment.ex.php b/api/v3/examples/Payment/UpdatePayment.ex.php deleted file mode 100644 index bd40516ee7..0000000000 --- a/api/v3/examples/Payment/UpdatePayment.ex.php +++ /dev/null @@ -1,97 +0,0 @@ - 1, - 'total_amount' => 100, - 'id' => 2, - 'check_permissions' => TRUE, - ]; - - try { - $result = civicrm_api3('Payment', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 4, - 'values' => [ - '4' => [ - 'id' => '4', - 'from_financial_account_id' => '7', - 'to_financial_account_id' => '6', - 'trxn_date' => '', - 'total_amount' => '100', - 'fee_amount' => 0, - 'net_amount' => '100', - 'currency' => 'USD', - 'is_payment' => '1', - 'trxn_id' => '', - 'trxn_result_code' => '', - 'status_id' => '1', - 'payment_processor_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testUpdatePayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PaymentProcessor/Create.ex.php b/api/v3/examples/PaymentProcessor/Create.ex.php deleted file mode 100644 index 84862dfc11..0000000000 --- a/api/v3/examples/PaymentProcessor/Create.ex.php +++ /dev/null @@ -1,107 +0,0 @@ - 'API Test PP', - 'title' => 'API Test PP', - 'payment_processor_type_id' => 1, - 'class_name' => 'CRM_Core_Payment_APITest', - 'is_recur' => 0, - 'domain_id' => 1, - ]; - - try { - $result = civicrm_api3('PaymentProcessor', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_processor_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'domain_id' => '1', - 'name' => 'API Test PP', - 'title' => '', - 'description' => '', - 'payment_processor_type_id' => '1', - 'is_active' => '1', - 'is_default' => 0, - 'is_test' => 0, - 'user_name' => '', - 'password' => '', - 'signature' => '', - 'url_site' => '', - 'url_api' => '', - 'url_recur' => '', - 'url_button' => '', - 'subject' => '', - 'class_name' => 'CRM_Core_Payment_APITest', - 'billing_mode' => '1', - 'is_recur' => 0, - 'payment_type' => '1', - 'payment_instrument_id' => '2', - 'accepted_credit_cards' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testPaymentProcessorCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentProcessorTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PaymentProcessor/Delete.ex.php b/api/v3/examples/PaymentProcessor/Delete.ex.php deleted file mode 100644 index 57fa4002a7..0000000000 --- a/api/v3/examples/PaymentProcessor/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 5, - ]; - - try { - $result = civicrm_api3('PaymentProcessor', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_processor_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testPaymentProcessorDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentProcessorTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PaymentProcessorType/Create.ex.php b/api/v3/examples/PaymentProcessorType/Create.ex.php deleted file mode 100644 index b5a753c4d8..0000000000 --- a/api/v3/examples/PaymentProcessorType/Create.ex.php +++ /dev/null @@ -1,107 +0,0 @@ - 1, - 'name' => 'API_Test_PP', - 'title' => 'API Test Payment Processor', - 'class_name' => 'CRM_Core_Payment_APITest', - 'billing_mode' => 'form', - 'is_recur' => 0, - ]; - - try { - $result = civicrm_api3('PaymentProcessorType', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_processor_type_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 10, - 'values' => [ - '0' => [ - 'id' => '10', - 'name' => 'API_Test_PP', - 'title' => 'API Test Payment Processor', - 'description' => '', - 'is_active' => '1', - 'is_default' => '', - 'user_name_label' => '', - 'password_label' => '', - 'signature_label' => '', - 'subject_label' => '', - 'class_name' => 'CRM_Core_Payment_APITest', - 'url_site_default' => '', - 'url_api_default' => '', - 'url_recur_default' => '', - 'url_button_default' => '', - 'url_site_test_default' => '', - 'url_api_test_default' => '', - 'url_recur_test_default' => '', - 'url_button_test_default' => '', - 'billing_mode' => '1', - 'is_recur' => 0, - 'payment_type' => '', - 'payment_instrument_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testPaymentProcessorTypeCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentProcessorTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PaymentProcessorType/Delete.ex.php b/api/v3/examples/PaymentProcessorType/Delete.ex.php deleted file mode 100644 index c1af30e58e..0000000000 --- a/api/v3/examples/PaymentProcessorType/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 13, - ]; - - try { - $result = civicrm_api3('PaymentProcessorType', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_processor_type_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => TRUE, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testPaymentProcessorTypeDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentProcessorTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PaymentToken/Create.ex.php b/api/v3/examples/PaymentToken/Create.ex.php deleted file mode 100644 index e16ea0be4e..0000000000 --- a/api/v3/examples/PaymentToken/Create.ex.php +++ /dev/null @@ -1,98 +0,0 @@ - 'fancy-token-xxxx', - 'contact_id' => 4, - 'created_id' => 4, - 'payment_processor_id' => 2, - ]; - - try { - $result = civicrm_api3('PaymentToken', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_token_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'contact_id' => '4', - 'payment_processor_id' => '2', - 'token' => 'fancy-token-xxxx', - 'created_date' => '2013-07-28 08:49:19', - 'created_id' => '4', - 'expiry_date' => '', - 'email' => '', - 'billing_first_name' => '', - 'billing_middle_name' => '', - 'billing_last_name' => '', - 'masked_account_number' => '', - 'ip_address' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePaymentToken" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTokenTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PaymentToken/Delete.ex.php b/api/v3/examples/PaymentToken/Delete.ex.php deleted file mode 100644 index 9fa39c5d12..0000000000 --- a/api/v3/examples/PaymentToken/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 6, - ]; - - try { - $result = civicrm_api3('PaymentToken', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_token_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePaymentToken" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTokenTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PaymentToken/Get.ex.php b/api/v3/examples/PaymentToken/Get.ex.php deleted file mode 100644 index 9995a23d74..0000000000 --- a/api/v3/examples/PaymentToken/Get.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 'fancy-token-xxxx', - 'contact_id' => 6, - 'created_id' => 6, - 'payment_processor_id' => 4, - ]; - - try { - $result = civicrm_api3('PaymentToken', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function payment_token_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 4, - 'values' => [ - '4' => [ - 'id' => '4', - 'contact_id' => '6', - 'payment_processor_id' => '4', - 'token' => 'fancy-token-xxxx', - 'created_date' => '2013-07-28 08:49:19', - 'created_id' => '6', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetPaymentToken" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTokenTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Pcp/ChainedGetDelete.ex.php b/api/v3/examples/Pcp/ChainedGetDelete.ex.php deleted file mode 100644 index 4901e25b00..0000000000 --- a/api/v3/examples/Pcp/ChainedGetDelete.ex.php +++ /dev/null @@ -1,119 +0,0 @@ - 'Pcp title', - 'api.Pcp.delete' => 1, - ]; - - try { - $result = civicrm_api3('Pcp', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pcp_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_id' => '1', - 'status_id' => 0, - 'title' => 'Pcp title', - 'page_id' => '1', - 'page_type' => 'contribute', - 'pcp_block_id' => '1', - 'is_thermometer' => 0, - 'is_honor_roll' => 0, - 'currency' => 'USD', - 'is_active' => 0, - 'is_notify' => 0, - 'api.Pcp.delete' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ], - ], - '5' => [ - 'id' => '5', - 'contact_id' => '1', - 'status_id' => 0, - 'title' => 'Pcp title', - 'page_id' => '1', - 'page_type' => 'contribute', - 'pcp_block_id' => '1', - 'is_thermometer' => 0, - 'is_honor_roll' => 0, - 'currency' => 'USD', - 'is_active' => 0, - 'is_notify' => 0, - 'api.Pcp.delete' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetPcpChainDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PcpTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Pcp/Create.ex.php b/api/v3/examples/Pcp/Create.ex.php deleted file mode 100644 index c7325b8bdb..0000000000 --- a/api/v3/examples/Pcp/Create.ex.php +++ /dev/null @@ -1,98 +0,0 @@ - 'Pcp title', - 'contact_id' => 1, - 'page_id' => 1, - 'pcp_block_id' => 1, - ]; - - try { - $result = civicrm_api3('Pcp', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pcp_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '1', - 'status_id' => 0, - 'title' => 'Pcp title', - 'intro_text' => '', - 'page_text' => '', - 'donate_link_text' => '', - 'page_id' => '1', - 'page_type' => '', - 'pcp_block_id' => '1', - 'is_thermometer' => '', - 'is_honor_roll' => '', - 'goal_amount' => '', - 'currency' => 'USD', - 'is_active' => '', - 'is_notify' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePcp" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PcpTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Pcp/Delete.ex.php b/api/v3/examples/Pcp/Delete.ex.php deleted file mode 100644 index 380c889e8e..0000000000 --- a/api/v3/examples/Pcp/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 4, - ]; - - try { - $result = civicrm_api3('Pcp', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pcp_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePcp" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PcpTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Pcp/Get.ex.php b/api/v3/examples/Pcp/Get.ex.php deleted file mode 100644 index 5e87d5edd1..0000000000 --- a/api/v3/examples/Pcp/Get.ex.php +++ /dev/null @@ -1,94 +0,0 @@ - 'Pcp title', - 'contact_id' => 1, - 'page_id' => 1, - 'pcp_block_id' => 1, - ]; - - try { - $result = civicrm_api3('Pcp', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pcp_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_id' => '1', - 'status_id' => 0, - 'title' => 'Pcp title', - 'page_id' => '1', - 'page_type' => 'contribute', - 'pcp_block_id' => '1', - 'is_thermometer' => 0, - 'is_honor_roll' => 0, - 'currency' => 'USD', - 'is_active' => 0, - 'is_notify' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetPcp" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PcpTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Phone/Create.ex.php b/api/v3/examples/Phone/Create.ex.php deleted file mode 100644 index 3f236a9a13..0000000000 --- a/api/v3/examples/Phone/Create.ex.php +++ /dev/null @@ -1,92 +0,0 @@ - 5, - 'phone' => '(123) 456-7890', - 'is_primary' => TRUE, - 'phone_type_id' => 1, - ]; - - try { - $result = civicrm_api3('Phone', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function phone_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 4, - 'values' => [ - '4' => [ - 'id' => '4', - 'contact_id' => '5', - 'location_type_id' => '1', - 'is_primary' => '1', - 'is_billing' => '', - 'mobile_provider_id' => '', - 'phone' => '(123) 456-7890', - 'phone_ext' => '', - 'phone_numeric' => '', - 'phone_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePhoneDefaultLocation" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PhoneTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Phone/Delete.ex.php b/api/v3/examples/Phone/Delete.ex.php deleted file mode 100644 index 19b8ef963d..0000000000 --- a/api/v3/examples/Phone/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 6, - ]; - - try { - $result = civicrm_api3('Phone', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function phone_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePhone" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PhoneTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Phone/Get.ex.php b/api/v3/examples/Phone/Get.ex.php deleted file mode 100644 index cce00a86f8..0000000000 --- a/api/v3/examples/Phone/Get.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 12, - 'phone' => '(123) 456-7890', - ]; - - try { - $result = civicrm_api3('Phone', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function phone_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 8, - 'values' => [ - '8' => [ - 'id' => '8', - 'contact_id' => '12', - 'location_type_id' => '15', - 'is_primary' => '1', - 'is_billing' => 0, - 'phone' => '(123) 456-7890', - 'phone_numeric' => '1234567890', - 'phone_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PhoneTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Phone/GetOptions.ex.php b/api/v3/examples/Phone/GetOptions.ex.php deleted file mode 100644 index 8a2149d399..0000000000 --- a/api/v3/examples/Phone/GetOptions.ex.php +++ /dev/null @@ -1,81 +0,0 @@ - 'phone_type_id', - ]; - - try { - $result = civicrm_api3('Phone', 'getoptions', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function phone_getoptions_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 5, - 'values' => [ - '1' => 'Phone', - '2' => 'Mobile', - '3' => 'Fax', - '4' => 'Pager', - '5' => 'Voicemail', - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testPhoneType" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ConstantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Pledge/Create.ex.php b/api/v3/examples/Pledge/Create.ex.php deleted file mode 100644 index 1e7949f88b..0000000000 --- a/api/v3/examples/Pledge/Create.ex.php +++ /dev/null @@ -1,115 +0,0 @@ - 12, - 'pledge_create_date' => '20220117', - 'start_date' => '20220117', - 'scheduled_date' => '20220119', - 'amount' => '100', - 'pledge_status_id' => '2', - 'pledge_financial_type_id' => '1', - 'pledge_original_installment_amount' => 20, - 'frequency_interval' => 5, - 'frequency_unit' => 'year', - 'frequency_day' => 15, - 'installments' => 5, - 'sequential' => 1, - ]; - - try { - $result = civicrm_api3('Pledge', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pledge_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'contact_id' => '12', - 'financial_type_id' => '1', - 'contribution_page_id' => '', - 'amount' => '100', - 'original_installment_amount' => '20', - 'currency' => 'USD', - 'frequency_unit' => 'year', - 'frequency_interval' => '5', - 'frequency_day' => '15', - 'installments' => '5', - 'start_date' => '2013-07-29 00:00:00', - 'create_date' => '20120130621222105', - 'acknowledge_date' => '', - 'modified_date' => '', - 'cancel_date' => '', - 'end_date' => '', - 'max_reminders' => '', - 'initial_reminder_day' => '', - 'additional_reminder_day' => '', - 'status_id' => '2', - 'is_test' => '', - 'campaign_id' => '', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePledge" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Pledge/Delete.ex.php b/api/v3/examples/Pledge/Delete.ex.php deleted file mode 100644 index 3b68b3f55e..0000000000 --- a/api/v3/examples/Pledge/Delete.ex.php +++ /dev/null @@ -1,78 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Pledge', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pledge_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 'id', - 'values' => [ - 'id' => 1, - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePledgeUseID" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Pledge/Get.ex.php b/api/v3/examples/Pledge/Get.ex.php deleted file mode 100644 index 7f9d7708e7..0000000000 --- a/api/v3/examples/Pledge/Get.ex.php +++ /dev/null @@ -1,101 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Pledge', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pledge_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'contact_id' => '5', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Anderson, Anthony', - 'display_name' => 'Mr. Anthony Anderson II', - 'pledge_id' => '1', - 'pledge_amount' => '100.00', - 'pledge_create_date' => '2022-01-17 00:00:00', - 'pledge_start_date' => '2022-01-17 00:00:00', - 'pledge_status' => 'Pending Label**', - 'pledge_total_paid' => '', - 'pledge_next_pay_date' => '2022-01-19 00:00:00', - 'pledge_next_pay_amount' => '20.00', - 'pledge_outstanding_amount' => '', - 'pledge_financial_type' => 'Donation', - 'pledge_contribution_page_id' => '', - 'pledge_frequency_interval' => '5', - 'pledge_frequency_unit' => 'year', - 'pledge_is_test' => 0, - 'pledge_campaign_id' => '', - 'pledge_currency' => 'USD', - 'id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetPledge" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Pledge/GetFilterHighDate.ex.php b/api/v3/examples/Pledge/GetFilterHighDate.ex.php deleted file mode 100644 index 63bbc8c8e3..0000000000 --- a/api/v3/examples/Pledge/GetFilterHighDate.ex.php +++ /dev/null @@ -1,103 +0,0 @@ - '20220115131204', - ]; - - try { - $result = civicrm_api3('Pledge', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pledge_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'contact_id' => '8', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'sort_name' => 'Anderson, Anthony', - 'display_name' => 'Mr. Anthony Anderson II', - 'pledge_id' => '2', - 'pledge_amount' => '100.00', - 'pledge_create_date' => '2022-01-17 00:00:00', - 'pledge_start_date' => '2021-03-05 00:00:00', - 'pledge_status' => 'Overdue', - 'pledge_total_paid' => '', - 'pledge_next_pay_date' => '2021-03-05 00:00:00', - 'pledge_next_pay_amount' => '20.00', - 'pledge_outstanding_amount' => '20.00', - 'pledge_financial_type' => 'Donation', - 'pledge_contribution_page_id' => '', - 'pledge_frequency_interval' => '5', - 'pledge_frequency_unit' => 'year', - 'pledge_is_test' => 0, - 'pledge_campaign_id' => '', - 'pledge_currency' => 'USD', - 'id' => '2', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testPledgeGetReturnFilters" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PledgePayment/Create.ex.php b/api/v3/examples/PledgePayment/Create.ex.php deleted file mode 100644 index 77fe0c235e..0000000000 --- a/api/v3/examples/PledgePayment/Create.ex.php +++ /dev/null @@ -1,93 +0,0 @@ - 3, - 'pledge_id' => 1, - 'contribution_id' => 1, - 'status_id' => 1, - 'actual_amount' => 20, - ]; - - try { - $result = civicrm_api3('PledgePayment', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pledge_payment_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'pledge_id' => '1', - 'contribution_id' => '1', - 'scheduled_amount' => '', - 'actual_amount' => '20', - 'currency' => 'USD', - 'scheduled_date' => '', - 'reminder_date' => '', - 'reminder_count' => '', - 'status_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePledgePayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgePaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PledgePayment/Delete.ex.php b/api/v3/examples/PledgePayment/Delete.ex.php deleted file mode 100644 index a457f28994..0000000000 --- a/api/v3/examples/PledgePayment/Delete.ex.php +++ /dev/null @@ -1,78 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('PledgePayment', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pledge_payment_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 'id', - 'values' => [ - 'id' => 1, - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePledgePayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgePaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PledgePayment/Get.ex.php b/api/v3/examples/PledgePayment/Get.ex.php deleted file mode 100644 index e125994b6e..0000000000 --- a/api/v3/examples/PledgePayment/Get.ex.php +++ /dev/null @@ -1,119 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pledge_payment_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 5, - 'values' => [ - '1' => [ - 'id' => '1', - 'pledge_id' => '1', - 'scheduled_amount' => '20.00', - 'currency' => 'USD', - 'scheduled_date' => '20130728085413', - 'reminder_count' => 0, - 'status_id' => '2', - ], - '2' => [ - 'id' => '2', - 'pledge_id' => '1', - 'scheduled_amount' => '20.00', - 'currency' => 'USD', - 'scheduled_date' => '20130728085413', - 'reminder_count' => 0, - 'status_id' => '2', - ], - '3' => [ - 'id' => '3', - 'pledge_id' => '1', - 'scheduled_amount' => '20.00', - 'currency' => 'USD', - 'scheduled_date' => '20130728085413', - 'reminder_count' => 0, - 'status_id' => '2', - ], - '4' => [ - 'id' => '4', - 'pledge_id' => '1', - 'scheduled_amount' => '20.00', - 'currency' => 'USD', - 'scheduled_date' => '20130728085413', - 'reminder_count' => 0, - 'status_id' => '2', - ], - '5' => [ - 'id' => '5', - 'pledge_id' => '1', - 'scheduled_amount' => '20.00', - 'currency' => 'USD', - 'scheduled_date' => '20130728085413', - 'reminder_count' => 0, - 'status_id' => '2', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetPledgePayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgePaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PledgePayment/Update.ex.php b/api/v3/examples/PledgePayment/Update.ex.php deleted file mode 100644 index 1a529a30b5..0000000000 --- a/api/v3/examples/PledgePayment/Update.ex.php +++ /dev/null @@ -1,90 +0,0 @@ - 1, - 'status_id' => 1, - ]; - - try { - $result = civicrm_api3('PledgePayment', 'update', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function pledge_payment_update_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'pledge_id' => '1', - 'contribution_id' => '1', - 'scheduled_amount' => '20.00', - 'actual_amount' => '20.00', - 'currency' => 'USD', - 'scheduled_date' => '20130728085413', - 'reminder_date' => '', - 'reminder_count' => 0, - 'status_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testUpdatePledgePayment" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgePaymentTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceField/Create.ex.php b/api/v3/examples/PriceField/Create.ex.php deleted file mode 100644 index 55b46038c2..0000000000 --- a/api/v3/examples/PriceField/Create.ex.php +++ /dev/null @@ -1,101 +0,0 @@ - 3, - 'name' => 'grassvariety', - 'label' => 'Grass Variety', - 'html_type' => 'Text', - 'is_enter_qty' => 1, - 'is_active' => 1, - ]; - - try { - $result = civicrm_api3('PriceField', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_field_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'price_set_id' => '3', - 'name' => 'grassvariety', - 'label' => 'Grass Variety', - 'html_type' => 'Text', - 'is_enter_qty' => '1', - 'help_pre' => '', - 'help_post' => '', - 'weight' => '', - 'is_display_amounts' => '', - 'options_per_line' => '', - 'is_active' => '1', - 'is_required' => '', - 'active_on' => '', - 'expire_on' => '', - 'javascript' => '', - 'visibility_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePriceField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceField/Delete.ex.php b/api/v3/examples/PriceField/Delete.ex.php deleted file mode 100644 index 050116d70a..0000000000 --- a/api/v3/examples/PriceField/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 6, - ]; - - try { - $result = civicrm_api3('PriceField', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_field_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePriceField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceField/Get.ex.php b/api/v3/examples/PriceField/Get.ex.php deleted file mode 100644 index 1be17d8f0d..0000000000 --- a/api/v3/examples/PriceField/Get.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - 'contribution_amount', - ]; - - try { - $result = civicrm_api3('PriceField', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_field_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'price_set_id' => '1', - 'name' => 'contribution_amount', - 'label' => 'Contribution Amount', - 'html_type' => 'Text', - 'is_enter_qty' => 0, - 'weight' => '1', - 'is_display_amounts' => '1', - 'options_per_line' => '1', - 'is_active' => '1', - 'is_required' => '1', - 'visibility_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetBasicPriceField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceFieldValue/Create.ex.php b/api/v3/examples/PriceFieldValue/Create.ex.php deleted file mode 100644 index 2231e10ab9..0000000000 --- a/api/v3/examples/PriceFieldValue/Create.ex.php +++ /dev/null @@ -1,105 +0,0 @@ - 13, - 'membership_type_id' => 5, - 'name' => 'memType1', - 'label' => 'memType1', - 'amount' => 90, - 'membership_num_terms' => 2, - 'is_active' => 1, - 'financial_type_id' => 2, - ]; - - try { - $result = civicrm_api3('PriceFieldValue', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_field_value_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 10, - 'values' => [ - '10' => [ - 'id' => '10', - 'price_field_id' => '13', - 'name' => 'memType1', - 'label' => 'memType1', - 'description' => '', - 'help_pre' => '', - 'help_post' => '', - 'amount' => '90', - 'count' => '', - 'max_value' => '', - 'weight' => '1', - 'membership_type_id' => '5', - 'membership_num_terms' => '2', - 'is_default' => '', - 'is_active' => '1', - 'financial_type_id' => '2', - 'non_deductible_amount' => '', - 'visibility_id' => '', - 'contribution_type_id' => '2', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreatePriceFieldValuewithMultipleTerms" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldValueTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceFieldValue/Delete.ex.php b/api/v3/examples/PriceFieldValue/Delete.ex.php deleted file mode 100644 index cc5ae1d553..0000000000 --- a/api/v3/examples/PriceFieldValue/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 7, - ]; - - try { - $result = civicrm_api3('PriceFieldValue', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_field_value_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePriceFieldValue" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldValueTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceFieldValue/Get.ex.php b/api/v3/examples/PriceFieldValue/Get.ex.php deleted file mode 100644 index 174c60b102..0000000000 --- a/api/v3/examples/PriceFieldValue/Get.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - 'contribution_amount', - ]; - - try { - $result = civicrm_api3('PriceFieldValue', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_field_value_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'price_field_id' => '1', - 'name' => 'contribution_amount', - 'label' => 'Contribution Amount', - 'amount' => '1.000000000', - 'weight' => '1', - 'is_default' => 0, - 'is_active' => '1', - 'financial_type_id' => '1', - 'non_deductible_amount' => '0.00', - 'visibility_id' => '1', - 'contribution_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetBasicPriceFieldValue" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldValueTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceSet/Create.ex.php b/api/v3/examples/PriceSet/Create.ex.php deleted file mode 100644 index a87d608fd6..0000000000 --- a/api/v3/examples/PriceSet/Create.ex.php +++ /dev/null @@ -1,96 +0,0 @@ - 'civicrm_event', - 'entity_id' => 1, - 'name' => 'event price', - 'title' => 'event price', - 'extends' => 1, - ]; - - try { - $result = civicrm_api3('PriceSet', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_set_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 6, - 'values' => [ - '6' => [ - 'id' => '6', - 'domain_id' => '', - 'name' => 'event price', - 'title' => 'event price', - 'is_active' => '', - 'help_pre' => '', - 'help_post' => '', - 'javascript' => '', - 'extends' => '1', - 'financial_type_id' => '', - 'is_quick_config' => '', - 'is_reserved' => '', - 'min_amount' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testEventPriceSet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceSetTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceSet/Delete.ex.php b/api/v3/examples/PriceSet/Delete.ex.php deleted file mode 100644 index 6e96a460ae..0000000000 --- a/api/v3/examples/PriceSet/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 7, - ]; - - try { - $result = civicrm_api3('PriceSet', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_set_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeletePriceSet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceSetTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/PriceSet/Get.ex.php b/api/v3/examples/PriceSet/Get.ex.php deleted file mode 100644 index 69f8546942..0000000000 --- a/api/v3/examples/PriceSet/Get.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 'default_contribution_amount', - ]; - - try { - $result = civicrm_api3('PriceSet', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function price_set_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'name' => 'default_contribution_amount', - 'title' => 'Contribution Amount', - 'is_active' => '1', - 'extends' => '2', - 'is_quick_config' => '1', - 'is_reserved' => '1', - 'min_amount' => '0.00', - 'entity' => [], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetBasicPriceSet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceSetTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Profile/Apply.ex.php b/api/v3/examples/Profile/Apply.ex.php deleted file mode 100644 index abd71e114c..0000000000 --- a/api/v3/examples/Profile/Apply.ex.php +++ /dev/null @@ -1,114 +0,0 @@ - 31, - 'contact_id' => 5, - 'first_name' => 'abc2', - 'last_name' => 'xyz2', - 'email-Primary' => 'abc2.xyz2@gmail.com', - 'phone-1-1' => '022 321 826', - 'country-1' => '1013', - 'state_province-1' => '1000', - ]; - - try { - $result = civicrm_api3('Profile', 'apply', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function profile_apply_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 11, - 'values' => [ - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'contact_id' => 5, - 'version' => 3, - 'debug' => 1, - 'profile_id' => 31, - 'first_name' => 'abc2', - 'last_name' => 'xyz2', - 'email' => [ - '1' => [ - 'location_type_id' => '1', - 'is_primary' => 1, - 'email' => 'abc2.xyz2@gmail.com', - ], - ], - 'phone' => [ - '2' => [ - 'location_type_id' => '1', - 'is_primary' => 1, - 'phone_type_id' => '1', - 'phone' => '022 321 826', - ], - ], - 'address' => [ - '1' => [ - 'location_type_id' => '1', - 'is_primary' => 1, - 'country_id' => '1013', - 'state_province_id' => '1000', - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testProfileApply" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ProfileTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Profile/Get.ex.php b/api/v3/examples/Profile/Get.ex.php deleted file mode 100644 index c67491aa48..0000000000 --- a/api/v3/examples/Profile/Get.ex.php +++ /dev/null @@ -1,112 +0,0 @@ - [ - '0' => 16, - '1' => 1, - '2' => 'Billing', - ], - 'contact_id' => 5, - ]; - - try { - $result = civicrm_api3('Profile', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function profile_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 3, - 'values' => [ - '16' => [ - 'postal_code-1' => '90210', - 'state_province-1' => '1021', - 'country-1' => '1228', - 'phone-1-1' => '021 512 755', - 'email-Primary' => 'abc1.xyz1@yahoo.com', - 'last_name' => 'xyz1', - 'first_name' => 'abc1', - 'email-primary' => 'abc1.xyz1@yahoo.com', - ], - '1' => [ - 'first_name' => 'abc1', - 'last_name' => 'xyz1', - 'street_address-1' => '5 Saint Helier St', - 'city-1' => 'Gotham City', - 'postal_code-1' => '90210', - 'country-1' => '1228', - 'state_province-1' => '1021', - ], - 'Billing' => [ - 'billing_first_name' => 'abc1', - 'billing_middle_name' => 'J.', - 'billing_last_name' => 'xyz1', - 'billing_street_address-5' => '5 Saint Helier St', - 'billing_city-5' => 'Gotham City', - 'billing_state_province_id-5' => '1021', - 'billing_country_id-5' => '1228', - 'billing_postal_code-5' => '90210', - 'billing-email-5' => 'abc1.xyz1@yahoo.com', - 'email-5' => 'abc1.xyz1@yahoo.com', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testProfileGetMultiple" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ProfileTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Profile/GetFields.ex.php b/api/v3/examples/Profile/GetFields.ex.php deleted file mode 100644 index 79902a2704..0000000000 --- a/api/v3/examples/Profile/GetFields.ex.php +++ /dev/null @@ -1,343 +0,0 @@ - 'submit', - 'profile_id' => 23, - ]; - - try { - $result = civicrm_api3('Profile', 'getfields', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function profile_getfields_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 9, - 'values' => [ - 'custom_1' => [ - 'id' => '1', - 'label' => '_addCustomFieldToProfile', - 'headerPattern' => '//', - 'title' => 'first_name', - 'custom_field_id' => '1', - 'groupTitle' => '_addCustomFieldToProfile', - 'data_type' => 'String', - 'name' => 'custom_1', - 'type' => 2, - 'html_type' => 'Text', - 'default_value' => 'defaultValue', - 'text_length' => '', - 'options_per_line' => '', - 'custom_group_id' => '1', - 'extends' => 'Contact', - 'is_search_range' => 0, - 'extends_entity_column_value' => '', - 'extends_entity_column_id' => '', - 'is_view' => 0, - 'is_multiple' => 0, - 'option_group_id' => '', - 'date_format' => '', - 'time_format' => '', - 'is_required' => 0, - 'table_name' => 'civicrm_value__addcustomfie_1', - 'column_name' => '_addcustomfieldtoprofile_1', - 'serialize' => 0, - 'where' => 'civicrm_value__addcustomfie_1._addcustomfieldtoprofile_1', - 'extends_table' => 'civicrm_contact', - 'search_table' => 'contact_a', - 'api.required' => '1', - 'help_pre' => '', - 'help_post' => '', - 'entity' => 'contact', - 'weight' => '1', - 'api.aliases' => [], - ], - 'postal_code-1' => [ - 'name' => 'postal_code', - 'type' => 2, - 'title' => 'State Province', - 'description' => 'Store both US (zip5) AND international postal codes. App is responsible for country/region appropriate validation.', - 'maxlength' => 64, - 'size' => 6, - 'import' => TRUE, - 'where' => 'civicrm_address.postal_code', - 'headerPattern' => '/postal|zip/i', - 'dataPattern' => '/\\d?\\d{4}(-\\d{4})?/', - 'export' => TRUE, - 'table_name' => 'civicrm_address', - 'entity' => 'address', - 'bao' => 'CRM_Core_BAO_Address', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 64, - 'size' => 6, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.required' => 0, - 'help_pre' => '', - 'help_post' => '', - 'weight' => '2', - 'api.aliases' => [], - ], - 'state_province-1' => [ - 'name' => 'state_province_id', - 'type' => 1, - 'title' => 'State Province', - 'description' => 'Which State_Province does this address belong to.', - 'where' => 'civicrm_address.state_province_id', - 'table_name' => 'civicrm_address', - 'entity' => 'address', - 'bao' => 'CRM_Core_BAO_Address', - 'localizable' => 0, - 'localize_context' => 'province', - 'FKClassName' => 'CRM_Core_DAO_StateProvince', - 'html' => [ - 'type' => 'ChainSelect', - 'label' => 'State/Province', - 'controlField' => 'country_id', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'table' => 'civicrm_state_province', - 'keyColumn' => 'id', - 'labelColumn' => 'name', - 'abbrColumn' => 'abbreviation', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'FKApiName' => 'StateProvince', - 'api.required' => '1', - 'help_pre' => '', - 'help_post' => '', - 'weight' => '3', - 'api.aliases' => [], - ], - 'country-1' => [ - 'name' => 'country_id', - 'type' => 1, - 'title' => 'Country', - 'description' => 'Which Country does this address belong to.', - 'where' => 'civicrm_address.country_id', - 'table_name' => 'civicrm_address', - 'entity' => 'address', - 'bao' => 'CRM_Core_BAO_Address', - 'localizable' => 0, - 'localize_context' => 'country', - 'FKClassName' => 'CRM_Core_DAO_Country', - 'html' => [ - 'type' => 'Select', - 'label' => 'Country', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'table' => 'civicrm_country', - 'keyColumn' => 'id', - 'labelColumn' => 'name', - 'nameColumn' => 'iso_code', - 'abbrColumn' => 'iso_code', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'FKApiName' => 'Country', - 'api.required' => '1', - 'help_pre' => '', - 'help_post' => '', - 'weight' => '4', - 'api.aliases' => [], - ], - 'phone-1-1' => [ - 'name' => 'phone', - 'type' => 2, - 'title' => 'Phone', - 'description' => 'Complete phone number.', - 'maxlength' => 32, - 'size' => 20, - 'import' => TRUE, - 'where' => 'civicrm_phone.phone', - 'headerPattern' => '/phone/i', - 'dataPattern' => '/^[\\d\\(\\)\\-\\.\\s]+$/', - 'export' => TRUE, - 'table_name' => 'civicrm_phone', - 'entity' => 'phone', - 'bao' => 'CRM_Core_BAO_Phone', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Phone', - 'maxlength' => 32, - 'size' => 20, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.required' => '1', - 'help_pre' => '', - 'help_post' => '', - 'weight' => '5', - 'api.aliases' => [], - ], - 'email-primary' => [ - 'name' => 'email', - 'type' => 2, - 'title' => 'Email', - 'description' => 'Email address', - 'maxlength' => 254, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_email.email', - 'headerPattern' => '/e.?mail/i', - 'dataPattern' => '/^[a-zA-Z][\\w\\.-]*[a-zA-Z0-9]@[a-zA-Z0-9][\\w\\.-]*[a-zA-Z0-9]\\.[a-zA-Z][a-zA-Z\\.]*[a-zA-Z]$/', - 'export' => TRUE, - 'rule' => 'email', - 'table_name' => 'civicrm_email', - 'entity' => 'email', - 'bao' => 'CRM_Core_BAO_Email', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 254, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.required' => '1', - 'help_pre' => '', - 'help_post' => '', - 'weight' => '6', - 'api.aliases' => [ - '0' => 'email-Primary', - ], - ], - 'last_name' => [ - 'name' => 'last_name', - 'type' => 2, - 'title' => 'Last Name', - 'description' => 'Last Name.', - 'maxlength' => 64, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.last_name', - 'headerPattern' => '/^last|(l(ast\\s)?name)$/i', - 'dataPattern' => '/^\\w+(\\s\\w+)?+$/', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'Last Name', - 'maxlength' => 64, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.required' => '1', - 'help_pre' => '', - 'help_post' => '', - 'weight' => '7', - 'api.aliases' => [], - ], - 'first_name' => [ - 'name' => 'first_name', - 'type' => 2, - 'title' => 'First Name', - 'description' => 'First Name.', - 'maxlength' => 64, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_contact.first_name', - 'headerPattern' => '/^first|(f(irst\\s)?name)$/i', - 'dataPattern' => '/^\\w+$/', - 'export' => TRUE, - 'contactType' => 'Individual', - 'table_name' => 'civicrm_contact', - 'entity' => 'contact', - 'bao' => 'CRM_Contact_BAO_Contact', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'label' => 'First Name', - 'maxlength' => 64, - 'size' => 30, - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.required' => '1', - 'help_pre' => '', - 'help_post' => '', - 'weight' => '8', - 'api.aliases' => [], - ], - 'profile_id' => [ - 'api.required' => TRUE, - 'title' => 'Profile ID', - 'name' => 'profile_id', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetFields" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ProfileTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Profile/Submit.ex.php b/api/v3/examples/Profile/Submit.ex.php deleted file mode 100644 index 571118dfde..0000000000 --- a/api/v3/examples/Profile/Submit.ex.php +++ /dev/null @@ -1,134 +0,0 @@ - 25, - 'contact_id' => 5, - 'first_name' => 'abc2', - 'last_name' => 'xyz2', - 'email-primary' => 'abc2.xyz2@gmail.com', - 'phone-1-1' => '022 321 826', - 'country-1' => '1013', - 'state_province-1' => '1000', - ]; - - try { - $result = civicrm_api3('Profile', 'submit', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function profile_submit_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 5, - 'values' => [ - '5' => [ - 'id' => '5', - 'contact_type' => 'Individual', - 'contact_sub_type' => '', - 'do_not_email' => 0, - 'do_not_phone' => 0, - 'do_not_mail' => 0, - 'do_not_sms' => 0, - 'do_not_trade' => 0, - 'is_opt_out' => 0, - 'legal_identifier' => '', - 'external_identifier' => '', - 'sort_name' => 'xyz2, abc2', - 'display_name' => 'Mr. abc2 xyz2 II', - 'nick_name' => '', - 'legal_name' => '', - 'image_URL' => '', - 'preferred_communication_method' => '', - 'preferred_language' => 'en_US', - 'hash' => '67eac7789eaee00', - 'api_key' => '', - 'first_name' => 'abc2', - 'middle_name' => 'J.', - 'last_name' => 'xyz2', - 'prefix_id' => '3', - 'suffix_id' => '3', - 'formal_title' => '', - 'communication_style_id' => '1', - 'email_greeting_id' => '1', - 'email_greeting_custom' => '', - 'email_greeting_display' => 'Dear abc1', - 'postal_greeting_id' => '1', - 'postal_greeting_custom' => '', - 'postal_greeting_display' => 'Dear abc1', - 'addressee_id' => '1', - 'addressee_custom' => '', - 'addressee_display' => 'Mr. abc1 J. xyz1 II', - 'job_title' => '', - 'gender_id' => '', - 'birth_date' => '', - 'is_deceased' => 0, - 'deceased_date' => '', - 'household_name' => '', - 'primary_contact_id' => '', - 'organization_name' => '', - 'sic_code' => '', - 'user_unique_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testProfileSubmit" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ProfileTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Relationship/BetweenRelationshipType.ex.php b/api/v3/examples/Relationship/BetweenRelationshipType.ex.php deleted file mode 100644 index 63c181afb4..0000000000 --- a/api/v3/examples/Relationship/BetweenRelationshipType.ex.php +++ /dev/null @@ -1,113 +0,0 @@ - [ - 'BETWEEN' => [ - '0' => 56, - '1' => 58, - ], - ], - ]; - - try { - $result = civicrm_api3('Relationship', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 3, - 'values' => [ - '2' => [ - 'id' => '2', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '56', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - '3' => [ - 'id' => '3', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '57', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - '4' => [ - 'id' => '4', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '58', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetTypeOperators" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Relationship/Create.ex.php b/api/v3/examples/Relationship/Create.ex.php deleted file mode 100644 index 75124b5db7..0000000000 --- a/api/v3/examples/Relationship/Create.ex.php +++ /dev/null @@ -1,96 +0,0 @@ - 3, - 'contact_id_b' => 5, - 'relationship_type_id' => 26, - 'start_date' => '2010-10-30', - 'end_date' => '2010-12-30', - 'is_active' => 1, - 'note' => 'note', - ]; - - try { - $result = civicrm_api3('Relationship', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '26', - 'start_date' => '2013-07-29 00:00:00', - 'end_date' => '2013-08-04 00:00:00', - 'is_active' => '1', - 'description' => '', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - 'case_id' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testRelationshipCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Relationship/Delete.ex.php b/api/v3/examples/Relationship/Delete.ex.php deleted file mode 100644 index 2aff8d4278..0000000000 --- a/api/v3/examples/Relationship/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Relationship', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 'Deleted relationship successfully', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testRelationshipDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Relationship/Get.ex.php b/api/v3/examples/Relationship/Get.ex.php deleted file mode 100644 index f48b9c04e4..0000000000 --- a/api/v3/examples/Relationship/Get.ex.php +++ /dev/null @@ -1,89 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Relationship', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '33', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - 'custom_1' => 'custom string', - 'custom_1_1' => 'custom string', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetWithCustom" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Relationship/INRelationshipType.ex.php b/api/v3/examples/Relationship/INRelationshipType.ex.php deleted file mode 100644 index eab2a8acbc..0000000000 --- a/api/v3/examples/Relationship/INRelationshipType.ex.php +++ /dev/null @@ -1,103 +0,0 @@ - [ - 'IN' => [ - '0' => 56, - '1' => 57, - ], - ], - ]; - - try { - $result = civicrm_api3('Relationship', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '56', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - '3' => [ - 'id' => '3', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '57', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetTypeOperators" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Relationship/NotBetweenRelationshipType.ex.php b/api/v3/examples/Relationship/NotBetweenRelationshipType.ex.php deleted file mode 100644 index c4e79bd809..0000000000 --- a/api/v3/examples/Relationship/NotBetweenRelationshipType.ex.php +++ /dev/null @@ -1,94 +0,0 @@ - [ - 'NOT BETWEEN' => [ - '0' => 56, - '1' => 58, - ], - ], - ]; - - try { - $result = civicrm_api3('Relationship', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '55', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetTypeOperators" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Relationship/NotInRelationshipType.ex.php b/api/v3/examples/Relationship/NotInRelationshipType.ex.php deleted file mode 100644 index 818472ecba..0000000000 --- a/api/v3/examples/Relationship/NotInRelationshipType.ex.php +++ /dev/null @@ -1,103 +0,0 @@ - [ - 'NOT IN' => [ - '0' => 56, - '1' => 57, - ], - ], - ]; - - try { - $result = civicrm_api3('Relationship', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '55', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - '4' => [ - 'id' => '4', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '58', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetTypeOperators" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Relationship/filterIsCurrent.ex.php b/api/v3/examples/Relationship/filterIsCurrent.ex.php deleted file mode 100644 index 452e7005a4..0000000000 --- a/api/v3/examples/Relationship/filterIsCurrent.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - [ - 'is_current' => 1, - ], - ]; - - try { - $result = civicrm_api3('Relationship', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'contact_id_a' => '3', - 'contact_id_b' => '5', - 'relationship_type_id' => '53', - 'start_date' => '2013-07-29 00:00:00', - 'is_active' => '1', - 'is_permission_a_b' => 0, - 'is_permission_b_a' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetIsCurrent" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/RelationshipType/Create.ex.php b/api/v3/examples/RelationshipType/Create.ex.php deleted file mode 100644 index cfc602faf1..0000000000 --- a/api/v3/examples/RelationshipType/Create.ex.php +++ /dev/null @@ -1,97 +0,0 @@ - 'Relation 1 for relationship type create', - 'name_b_a' => 'Relation 2 for relationship type create', - 'contact_type_a' => 'Individual', - 'contact_type_b' => 'Organization', - 'is_reserved' => 1, - 'is_active' => 1, - 'sequential' => 1, - ]; - - try { - $result = civicrm_api3('RelationshipType', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_type_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'name_a_b' => 'Relation 1 for relationship type create', - 'label_a_b' => 'Relation 1 for relationship type create', - 'name_b_a' => 'Relation 2 for relationship type create', - 'label_b_a' => 'Relation 2 for relationship type create', - 'description' => '', - 'contact_type_a' => 'Individual', - 'contact_type_b' => 'Organization', - 'contact_sub_type_a' => '', - 'contact_sub_type_b' => '', - 'is_reserved' => '1', - 'is_active' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testRelationshipTypeCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/RelationshipType/Delete.ex.php b/api/v3/examples/RelationshipType/Delete.ex.php deleted file mode 100644 index f4cddd5020..0000000000 --- a/api/v3/examples/RelationshipType/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('RelationshipType', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function relationship_type_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testRelationshipTypeDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTypeTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ReportTemplate/Getrows.ex.php b/api/v3/examples/ReportTemplate/Getrows.ex.php deleted file mode 100644 index d948f5019b..0000000000 --- a/api/v3/examples/ReportTemplate/Getrows.ex.php +++ /dev/null @@ -1,153 +0,0 @@ - 'Mailing/opened', - 'options' => [ - 'metadata' => [ - '0' => 'labels', - '1' => 'title', - ], - ], - ]; - - try { - $result = civicrm_api3('ReportTemplate', 'getrows', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function report_template_getrows_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 5, - 'values' => [ - '0' => [ - 'civicrm_contact_id' => '102', - 'civicrm_contact_sort_name' => 'One, Test', - 'civicrm_mailing_mailing_name' => 'Second Test Mailing Events', - 'civicrm_mailing_mailing_name_alias' => 'Second Test Mailing Events', - 'civicrm_mailing_mailing_subject' => 'Hello again, {contact.display_name}', - 'civicrm_mailing_event_opened_id' => '17', - 'civicrm_mailing_event_opened_time_stamp' => '2011-05-26 13:23:22', - 'class' => '', - 'civicrm_contact_sort_name_link' => '/index.php?q=civicrm/contact/view&reset=1&cid=102', - 'civicrm_contact_sort_name_hover' => 'View Contact details for this contact.', - ], - '1' => [ - 'civicrm_contact_id' => '109', - 'civicrm_contact_sort_name' => 'Five, Test', - 'civicrm_mailing_mailing_name' => 'First Mailing Events', - 'civicrm_mailing_mailing_name_alias' => 'First Mailing Events', - 'civicrm_mailing_mailing_subject' => 'Hello {contact.display_name}', - 'civicrm_mailing_event_opened_id' => '9', - 'civicrm_mailing_event_opened_time_stamp' => '2011-05-26 13:19:03', - 'class' => '', - 'civicrm_contact_sort_name_link' => '/index.php?q=civicrm/contact/view&reset=1&cid=109', - 'civicrm_contact_sort_name_hover' => 'View Contact details for this contact.', - ], - '2' => [ - 'civicrm_contact_id' => '110', - 'civicrm_contact_sort_name' => 'Six, Test', - 'civicrm_mailing_mailing_name' => 'First Mailing Events', - 'civicrm_mailing_mailing_name_alias' => 'First Mailing Events', - 'civicrm_mailing_mailing_subject' => 'Hello {contact.display_name}', - 'civicrm_mailing_event_opened_id' => '5', - 'civicrm_mailing_event_opened_time_stamp' => '2011-05-26 13:17:54', - 'class' => '', - 'civicrm_contact_sort_name_link' => '/index.php?q=civicrm/contact/view&reset=1&cid=110', - 'civicrm_contact_sort_name_hover' => 'View Contact details for this contact.', - ], - '3' => [ - 'civicrm_contact_id' => '111', - 'civicrm_contact_sort_name' => 'Seven, Test', - 'civicrm_mailing_mailing_name' => 'First Mailing Events', - 'civicrm_mailing_mailing_name_alias' => 'First Mailing Events', - 'civicrm_mailing_mailing_subject' => 'Hello {contact.display_name}', - 'civicrm_mailing_event_opened_id' => '15', - 'civicrm_mailing_event_opened_time_stamp' => '2011-05-26 13:20:59', - 'class' => '', - 'civicrm_contact_sort_name_link' => '/index.php?q=civicrm/contact/view&reset=1&cid=111', - 'civicrm_contact_sort_name_hover' => 'View Contact details for this contact.', - ], - '4' => [ - 'civicrm_contact_id' => '112', - 'civicrm_contact_sort_name' => 'Eight, Test', - 'civicrm_mailing_mailing_name' => 'First Mailing Events', - 'civicrm_mailing_mailing_name_alias' => 'First Mailing Events', - 'civicrm_mailing_mailing_subject' => 'Hello {contact.display_name}', - 'civicrm_mailing_event_opened_id' => '11', - 'civicrm_mailing_event_opened_time_stamp' => '2011-05-26 13:19:44', - 'class' => '', - 'civicrm_contact_sort_name_link' => '/index.php?q=civicrm/contact/view&reset=1&cid=112', - 'civicrm_contact_sort_name_hover' => 'View Contact details for this contact.', - ], - ], - 'metadata' => [ - 'title' => 'ERROR: Title is not Set', - 'labels' => [ - 'civicrm_contact_sort_name' => 'Contact Name', - 'civicrm_mailing_mailing_name' => 'Mailing Name', - 'civicrm_mailing_mailing_subject' => 'Mailing Subject', - 'civicrm_mailing_event_opened_time_stamp' => 'Open Date', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testReportTemplateGetRowsMailingUniqueOpened" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ReportTemplateTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/ReportTemplate/Getstatistics.ex.php b/api/v3/examples/ReportTemplate/Getstatistics.ex.php deleted file mode 100644 index 59d83f26b5..0000000000 --- a/api/v3/examples/ReportTemplate/Getstatistics.ex.php +++ /dev/null @@ -1,87 +0,0 @@ - 'contribute/deferredrevenue', - ]; - - try { - $result = civicrm_api3('ReportTemplate', 'getstatistics', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function report_template_getstatistics_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 3, - 'values' => [ - 'counts' => [ - 'rowCount' => [ - 'title' => 'Row(s) Listed', - 'value' => 0, - 'type' => 1, - ], - ], - 'groups' => [], - 'filters' => [], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testReportTemplateGetStatisticsAllReports" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ReportTemplateTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/SavedSearch/Create.ex.php b/api/v3/examples/SavedSearch/Create.ex.php deleted file mode 100644 index 517cdb1b19..0000000000 --- a/api/v3/examples/SavedSearch/Create.ex.php +++ /dev/null @@ -1,142 +0,0 @@ - '2021-08-08', - 'form_values' => [ - 'relation_type_id' => '6_a_b', - 'relation_target_name' => 'Default Organization', - ], - 'api.Group.create' => [ - 'name' => 'my_smartgroup', - 'title' => 'my smartgroup', - 'description' => 'Volunteers for the default organization', - 'saved_search_id' => '$value.id', - 'is_active' => 1, - 'visibility' => 'User and User Admin Only', - 'is_hidden' => 0, - 'is_reserved' => 0, - ], - ]; - - try { - $result = civicrm_api3('SavedSearch', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function saved_search_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'name' => '', - 'label' => '', - 'form_values' => [ - 'relation_type_id' => '6_a_b', - 'relation_target_name' => 'Default Organization', - ], - 'mapping_id' => '', - 'search_custom_id' => '', - 'api_entity' => '', - 'api_params' => '', - 'created_id' => '', - 'modified_id' => '', - 'expires_date' => '20210808000000', - 'created_date' => '', - 'modified_date' => '', - 'description' => '', - 'api.Group.create' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'name' => 'my_smartgroup', - 'title' => 'my smartgroup', - 'description' => 'Volunteers for the default organization', - 'source' => '', - 'saved_search_id' => '3', - 'is_active' => '1', - 'visibility' => 'User and User Admin Only', - 'where_clause' => '', - 'select_tables' => '', - 'where_tables' => '', - 'group_type' => '', - 'cache_date' => '', - 'refresh_date' => '', - 'parents' => '', - 'children' => '', - 'is_hidden' => 0, - 'is_reserved' => 0, - 'created_id' => '', - 'modified_id' => '', - 'frontend_title' => '', - 'frontend_description' => '', - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSavedSearchWithSmartGroup" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SavedSearchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/SavedSearch/Delete.ex.php b/api/v3/examples/SavedSearch/Delete.ex.php deleted file mode 100644 index 7a09625346..0000000000 --- a/api/v3/examples/SavedSearch/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 6, - ]; - - try { - $result = civicrm_api3('SavedSearch', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function saved_search_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteSavedSearch" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SavedSearchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/SavedSearch/Get.ex.php b/api/v3/examples/SavedSearch/Get.ex.php deleted file mode 100644 index 9fef1a9e82..0000000000 --- a/api/v3/examples/SavedSearch/Get.ex.php +++ /dev/null @@ -1,87 +0,0 @@ - 2, - ]; - - try { - $result = civicrm_api3('SavedSearch', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function saved_search_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'form_values' => [ - 'relation_type_id' => '6_a_b', - 'relation_target_name' => 'Default Organization', - ], - 'expires_date' => '2021-08-08 00:00:00', - 'created_date' => '2013-07-28 08:49:19', - 'modified_date' => '2012-11-14 16:02:35', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateAndGetSavedSearch" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SavedSearchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/Create.ex.php b/api/v3/examples/Setting/Create.ex.php deleted file mode 100644 index 8fffe7d5c3..0000000000 --- a/api/v3/examples/Setting/Create.ex.php +++ /dev/null @@ -1,81 +0,0 @@ - 21, - 'uniq_email_per_site' => 1, - ]; - - try { - $result = civicrm_api3('Setting', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 21, - 'values' => [ - '21' => [ - 'uniq_email_per_site' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSetting" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/CreateAllDomains.ex.php b/api/v3/examples/Setting/CreateAllDomains.ex.php deleted file mode 100644 index 281f8e62b9..0000000000 --- a/api/v3/examples/Setting/CreateAllDomains.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - 'all', - 'uniq_email_per_site' => 1, - ]; - - try { - $result = civicrm_api3('Setting', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 4, - 'values' => [ - '37' => [ - 'uniq_email_per_site' => '1', - ], - '38' => [ - 'uniq_email_per_site' => '1', - ], - '1' => [ - 'uniq_email_per_site' => '1', - ], - '2' => [ - 'uniq_email_per_site' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSettingMultipleDomains" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/CreateSettingCurrentDomain.ex.php b/api/v3/examples/Setting/CreateSettingCurrentDomain.ex.php deleted file mode 100644 index 057ad5b4af..0000000000 --- a/api/v3/examples/Setting/CreateSettingCurrentDomain.ex.php +++ /dev/null @@ -1,82 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('Setting', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'uniq_email_per_site' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSetting" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/CreateSpecifiedDomains.ex.php b/api/v3/examples/Setting/CreateSpecifiedDomains.ex.php deleted file mode 100644 index 115f8b0b7c..0000000000 --- a/api/v3/examples/Setting/CreateSpecifiedDomains.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - [ - '0' => 1, - '1' => 38, - ], - 'uniq_email_per_site' => 0, - ]; - - try { - $result = civicrm_api3('Setting', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '1' => [ - 'uniq_email_per_site' => 0, - ], - '38' => [ - 'uniq_email_per_site' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSettingMultipleDomains" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/Get.ex.php b/api/v3/examples/Setting/Get.ex.php deleted file mode 100644 index 6366789307..0000000000 --- a/api/v3/examples/Setting/Get.ex.php +++ /dev/null @@ -1,81 +0,0 @@ - 41, - 'return' => 'uniq_email_per_site', - ]; - - try { - $result = civicrm_api3('Setting', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 41, - 'values' => [ - '41' => [ - 'uniq_email_per_site' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetSetting" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/GetAllDomains.ex.php b/api/v3/examples/Setting/GetAllDomains.ex.php deleted file mode 100644 index f4f545cfc1..0000000000 --- a/api/v3/examples/Setting/GetAllDomains.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - 'all', - 'return' => 'uniq_email_per_site', - ]; - - try { - $result = civicrm_api3('Setting', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 4, - 'values' => [ - '37' => [ - 'uniq_email_per_site' => '1', - ], - '38' => [ - 'uniq_email_per_site' => '1', - ], - '1' => [ - 'uniq_email_per_site' => '1', - ], - '2' => [ - 'uniq_email_per_site' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSettingMultipleDomains" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/GetDefaults.ex.php b/api/v3/examples/Setting/GetDefaults.ex.php deleted file mode 100644 index eaa1158e1f..0000000000 --- a/api/v3/examples/Setting/GetDefaults.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 'address_format', - ]; - - try { - $result = civicrm_api3('Setting', 'getdefaults', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_getdefaults_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'address_format' => '{contact.address_name} -{contact.street_address} -{contact.supplemental_address_1} -{contact.supplemental_address_2} -{contact.supplemental_address_3} -{contact.city}{, }{contact.state_province}{ }{contact.postal_code} -{contact.country}', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetDefaults" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/GetFields.ex.php b/api/v3/examples/Setting/GetFields.ex.php deleted file mode 100644 index 5a8e31280a..0000000000 --- a/api/v3/examples/Setting/GetFields.ex.php +++ /dev/null @@ -1,3353 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_getfields_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 195, - 'values' => [ - 'address_standardization_provider' => [ - 'group_name' => 'Address Preferences', - 'group' => 'address', - 'name' => 'address_standardization_provider', - 'type' => 'String', - 'html_type' => 'select', - 'default' => '', - 'add' => '4.1', - 'title' => 'Address Standardization Provider.', - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::addressProvider', - ], - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => 'CiviCRM includes an optional plugin for interfacing with the United States Postal Services (USPS) Address Standardization web service. You must register to use the USPS service at https://www.usps.com/business/web-tools-apis/address-information.htm. If you are approved, they will provide you with a User ID and the URL for the service. Plugins for other address standardization services may be available from 3rd party developers. If installed, they will be included in the drop-down below. ', - ], - 'address_standardization_userid' => [ - 'group_name' => 'Address Preferences', - 'group' => 'address', - 'name' => 'address_standardization_userid', - 'type' => 'String', - 'html_type' => 'text', - 'default' => '', - 'add' => '4.1', - 'title' => 'Provider service user ID', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'address_standardization_url' => [ - 'group_name' => 'Address Preferences', - 'group' => 'address', - 'name' => 'address_standardization_url', - 'type' => 'Text', - 'html_type' => 'text', - 'default' => '', - 'add' => '4.1', - 'title' => 'Provider Service URL', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => 'Web Service URL', - 'validate_callback' => 'CRM_Utils_Rule::url', - ], - 'hideCountryMailingLabels' => [ - 'group_name' => 'Address Preferences', - 'group' => 'address', - 'name' => 'hideCountryMailingLabels', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.7', - 'title' => 'Hide Country in Mailing Labels when same as domain country', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Do not display the country field in mailing labels when the country is the same as that of the domain', - 'help_text' => '', - ], - 'tag_unconfirmed' => [ - 'group_name' => 'Campaign Preferences', - 'group' => 'campaign', - 'name' => 'tag_unconfirmed', - 'type' => 'String', - 'html_type' => 'text', - 'default' => 'Unconfirmed', - 'add' => '4.1', - 'title' => 'Tag for Unconfirmed Petition Signers', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If set, new contacts that are created when signing a petition are assigned a tag of this name.', - 'help_text' => '', - 'settings_pages' => [ - 'campaign' => [ - 'weight' => 10, - ], - ], - ], - 'petition_contacts' => [ - 'group_name' => 'Campaign Preferences', - 'group' => 'campaign', - 'name' => 'petition_contacts', - 'type' => 'String', - 'html_type' => 'text', - 'default' => 'Petition Contacts', - 'add' => '4.1', - 'title' => 'Petition Signers Group', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'All contacts that have signed a CiviCampaign petition will be added to this group. The group will be created if it does not exist (it is required for email verification).', - 'help_text' => '', - 'settings_pages' => [ - 'campaign' => [ - 'weight' => 20, - ], - ], - ], - 'civicaseRedactActivityEmail' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'civicaseRedactActivityEmail', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [], - 'default' => 'default', - 'add' => '4.7', - 'title' => 'Redact Activity Email', - 'is_domain' => 1, - 'is_contact' => 0, - 'pseudoconstant' => [ - 'callback' => 'CRM_Case_Info::getRedactOptions', - ], - 'description' => 'Should activity emails be redacted? (Set \"Default\" to load setting from the legacy \"Settings.xml\" file.)', - 'help_text' => '', - ], - 'civicaseAllowMultipleClients' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'civicaseAllowMultipleClients', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [], - 'default' => 'default', - 'add' => '4.7', - 'title' => 'Allow Multiple Case Clients', - 'is_domain' => 1, - 'is_contact' => 0, - 'pseudoconstant' => [ - 'callback' => 'CRM_Case_Info::getMultiClientOptions', - ], - 'description' => 'How many clients may be associated with a given case? (Set \"Default\" to load setting from the legacy \"Settings.xml\" file.)', - 'help_text' => '', - ], - 'civicaseNaturalActivityTypeSort' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'civicaseNaturalActivityTypeSort', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [], - 'default' => 'default', - 'add' => '4.7', - 'title' => 'Activity Type Sorting', - 'is_domain' => 1, - 'is_contact' => 0, - 'pseudoconstant' => [ - 'callback' => 'CRM_Case_Info::getSortOptions', - ], - 'description' => 'How to sort activity-types on the \"Manage Case\" screen? (Set \"Default\" to load setting from the legacy \"Settings.xml\" file.)', - 'help_text' => '', - ], - 'civicaseShowCaseActivities' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'civicaseShowCaseActivities', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => '', - 'html_type' => 'radio', - 'add' => '5.24', - 'title' => 'Include case activities in general activity views.', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'e.g. the Contact form\'s Activity tab listing. Without this ticked, activities that belong to a case are hidden (default behavior). Warning: enabling this option means that all case activities relating to a contact will be listed which could result in users without \"access all cases and activities\" permission being able to see see the summarized details (date, subject, assignees, status etc.). Such users will still be prevented from managing the case and viewing/editing the activity.', - 'help_text' => '', - ], - 'cvv_backoffice_required' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'cvv_backoffice_required', - 'type' => 'Boolean', - 'html_type' => 'radio', - 'quick_form_type' => 'YesNo', - 'default' => '1', - 'add' => '4.1', - 'title' => 'CVV required for backoffice?', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Is the CVV code required for back office credit card transactions', - 'help_text' => 'If set it back-office credit card transactions will required a cvv code. Leave as required unless you have a very strong reason to change', - 'settings_pages' => [ - 'contribute' => [ - 'weight' => 10, - ], - ], - ], - 'contribution_invoice_settings' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'contribution_invoice_settings', - 'type' => 'Array', - 'add' => '4.7', - 'title' => 'Deprecated, virtualized setting', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'invoicing' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'invoicing', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'Element', - 'default' => 0, - 'add' => '4.7', - 'title' => 'Enable Tax and Invoicing', - 'is_domain' => 1, - 'is_contact' => 0, - 'on_change' => [ - '0' => 'CRM_Invoicing_Utils::onToggle', - ], - 'settings_pages' => [ - 'contribute' => [ - 'weight' => 90, - ], - ], - ], - 'invoice_prefix' => [ - 'default' => 'INV_', - 'html_type' => 'text', - 'name' => 'invoice_prefix', - 'add' => '5.23', - 'type' => 2, - 'title' => 'Invoice Prefix', - 'description' => 'Enter prefix to be be preprended when creating an invoice number', - 'is_domain' => 1, - 'is_contact' => 0, - ], - 'invoice_due_date' => [ - 'default' => '10', - 'name' => 'invoice_due_date', - 'html_type' => 'text', - 'title' => 'Due Date', - 'add' => '5.23', - 'type' => 1, - 'is_domain' => 1, - 'is_contact' => 0, - ], - 'invoice_due_date_period' => [ - 'default' => 'days', - 'html_type' => 'select', - 'name' => 'invoice_due_date_period', - 'title' => 'For transmission', - 'weight' => 4, - 'add' => '5.23', - 'type' => 2, - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Select the interval for due date.', - 'options' => [ - 'select' => '- select -', - 'days' => 'Days', - 'months' => 'Months', - 'years' => 'Years', - ], - ], - 'invoice_notes' => [ - 'default' => '', - 'name' => 'invoice_notes', - 'html_type' => 'wysiwyg', - 'title' => 'Notes or Standard Terms', - 'type' => 2, - 'add' => '5.23', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Enter note or message to be displayed on PDF invoice or credit notes ', - 'attributes' => [ - 'rows' => 2, - 'cols' => 40, - ], - ], - 'invoice_is_email_pdf' => [ - 'name' => 'invoice_is_email_pdf', - 'html_type' => 'checkbox', - 'add' => '5.23', - 'type' => 16, - 'is_domain' => 1, - 'is_contact' => 0, - 'title' => 'Automatically email invoice when user purchases online', - 'description' => 'Should a pdf invoice be emailed automatically?', - ], - 'tax_term' => [ - 'default' => 'Sales Tax', - 'name' => 'tax_term', - 'html_type' => 'text', - 'add' => '5.23', - 'title' => 'Tax Term', - 'type' => 2, - 'is_domain' => 1, - 'is_contact' => 0, - ], - 'tax_display_settings' => [ - 'default' => 'Inclusive', - 'html_type' => 'select', - 'name' => 'tax_display_settings', - 'type' => 2, - 'add' => '5.23', - 'title' => 'Tax Display Settings', - 'is_domain' => 1, - 'is_contact' => 0, - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::taxDisplayOptions', - ], - ], - 'deferred_revenue_enabled' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'deferred_revenue_enabled', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'Element', - 'default' => 0, - 'add' => '4.7', - 'title' => 'Enable Deferred Revenue', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'settings_pages' => [ - 'contribute' => [ - 'weight' => 50, - ], - ], - ], - 'default_invoice_page' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'default_invoice_page', - 'type' => 'Integer', - 'quick_form_type' => 'Select', - 'default' => '', - 'pseudoconstant' => [ - 'table' => 'civicrm_contribution_page', - 'keyColumn' => 'id', - 'labelColumn' => 'title', - ], - 'html_type' => 'select', - 'add' => '4.7', - 'title' => 'Default invoice payment page', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'settings_pages' => [ - 'contribute' => [ - 'weight' => 70, - ], - ], - ], - 'always_post_to_accounts_receivable' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'always_post_to_accounts_receivable', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'Element', - 'default' => 0, - 'add' => '4.7', - 'title' => 'Always post to Accounts Receivable?', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'settings_pages' => [ - 'contribute' => [ - 'weight' => 40, - ], - ], - ], - 'update_contribution_on_membership_type_change' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'update_contribution_on_membership_type_change', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'Element', - 'default' => 0, - 'add' => '4.7', - 'title' => 'Automatically update related contributions when Membership Type is changed', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Enabling this setting will update related contribution of membership(s) except if the membership is paid for with a recurring contribution.', - 'help_text' => '', - 'settings_pages' => [ - 'contribute' => [ - 'weight' => 20, - ], - ], - ], - 'contact_view_options' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'contact_view_options', - 'type' => 'String', - 'html_type' => 'checkboxes', - 'pseudoconstant' => [ - 'optionGroupName' => 'contact_view_options', - ], - 'default' => '123456789101113', - 'add' => '4.1', - 'title' => 'Viewing Contacts', - 'is_domain' => '1', - 'is_contact' => 0, - 'description' => 'Select the tabs that should be displayed when viewing a contact record. EXAMPLE: If your organization does not keep track of \'Relationships\', then un-check this option to simplify the screen display. Tabs for Contributions, Pledges, Memberships, Events, Grants and Cases are also hidden if the corresponding component is not enabled. Go to Administer > System Settings > Enable Components to modify the components which are available for your site.', - 'help_text' => '', - 'serialize' => 1, - ], - 'contact_edit_options' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'contact_edit_options', - 'type' => 'String', - 'html_type' => 'checkboxes', - 'pseudoconstant' => [ - 'optionGroupName' => 'contact_edit_options', - ], - 'default' => '123456789111214151617', - 'add' => '4.1', - 'title' => 'Editing Contacts', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Select the sections that should be included when adding or editing a contact record. EXAMPLE: If your organization does not record Gender and Birth Date for individuals, then simplify the form by un-checking this option. Drag interface allows you to change the order of the panes displayed on contact add/edit screen.', - 'help_text' => '', - 'serialize' => 1, - ], - 'advanced_search_options' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'advanced_search_options', - 'type' => 'String', - 'html_type' => 'checkboxes', - 'pseudoconstant' => [ - 'optionGroupName' => 'advanced_search_options', - ], - 'default' => '123456789101112131516171819', - 'add' => '4.1', - 'title' => 'Contact Search', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Select the sections that should be included in the Basic and Advanced Search forms. EXAMPLE: If you don\'t track Relationships - then you do not need this section included in the advanced search form. Simplify the form by un-checking this option.', - 'serialize' => 1, - ], - 'user_dashboard_options' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'user_dashboard_options', - 'type' => 'String', - 'html_type' => 'checkboxes', - 'pseudoconstant' => [ - 'optionGroupName' => 'user_dashboard_options', - ], - 'default' => '1234578', - 'add' => '4.1', - 'title' => 'Contact Dashboard', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Select the sections that should be included in the Contact Dashboard. EXAMPLE: If you don\'t want constituents to view their own contribution history, un-check that option.', - 'help_text' => '', - 'serialize' => 1, - ], - 'address_options' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'address_options', - 'type' => 'String', - 'html_type' => 'checkboxes', - 'pseudoconstant' => [ - 'optionGroupName' => 'address_options', - ], - 'default' => '12345689101112', - 'add' => '4.1', - 'title' => 'Address Fields', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - 'serialize' => 1, - ], - 'address_format' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'address_format', - 'type' => 'String', - 'html_type' => 'textarea', - 'default' => '{contact.address_name} -{contact.street_address} -{contact.supplemental_address_1} -{contact.supplemental_address_2} -{contact.supplemental_address_3} -{contact.city}{, }{contact.state_province}{ }{contact.postal_code} -{contact.country}', - 'add' => '4.1', - 'title' => 'Address Display Format', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'mailing_format' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'mailing_format', - 'type' => 'String', - 'html_type' => 'textarea', - 'default' => '{contact.addressee} -{contact.street_address} -{contact.supplemental_address_1} -{contact.supplemental_address_2} -{contact.supplemental_address_3} -{contact.city}{, }{contact.state_province}{ }{contact.postal_code} -{contact.country}', - 'add' => '4.1', - 'title' => 'Mailing Label Format', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'display_name_format' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'display_name_format', - 'type' => 'String', - 'html_type' => 'textarea', - 'default' => '{contact.individual_prefix}{ }{contact.first_name}{ }{contact.last_name}{ }{contact.individual_suffix}', - 'add' => '4.1', - 'title' => 'Individual Display Name Format', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Display name format for individual contact display names.', - ], - 'sort_name_format' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'sort_name_format', - 'type' => 'String', - 'html_type' => 'textarea', - 'default' => '{contact.last_name}{, }{contact.first_name}', - 'add' => '4.1', - 'title' => 'Individual Sort Name Format', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Sort name format for individual contact display names.', - ], - 'remote_profile_submissions' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'remote_profile_submissions', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => '', - 'html_type' => 'radio', - 'add' => '4.7', - 'title' => 'Accept profile submissions from external sites', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, CiviCRM will permit submissions from external sites to profiles. This is disabled by default to limit abuse.', - 'help_text' => '', - ], - 'allow_alert_autodismissal' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'allow_alert_autodismissal', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => TRUE, - 'html_type' => 'radio', - 'add' => '4.7', - 'title' => 'Allow alerts to auto-dismiss?', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If disabled, CiviCRM will not automatically dismiss any alerts after 10 seconds.', - 'help_text' => '', - ], - 'editor_id' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'editor_id', - 'type' => 'String', - 'html_type' => 'select', - 'default' => 'CKEditor', - 'add' => '4.1', - 'title' => 'Wysiwig Editor', - 'pseudoconstant' => [ - 'optionGroupName' => 'wysiwyg_editor', - 'keyColumn' => 'name', - ], - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'contact_ajax_check_similar' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'contact_ajax_check_similar', - 'type' => 'String', - 'html_type' => 'radio', - 'default' => '1', - 'add' => '4.1', - 'title' => 'Check for Similar Contacts', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - 'options' => [ - '1' => 'While Typing', - '0' => 'When Saving', - '2' => 'Never', - ], - ], - 'ajaxPopupsEnabled' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'ajaxPopupsEnabled', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 1, - 'add' => '4.5', - 'title' => 'Enable Popup Forms', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'defaultExternUrl' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'defaultExternUrl', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'default' => 'router', - 'add' => '5.27', - 'title' => 'Extern URL Style', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'This setting provides transitional support. It should be set to \"Prefer normal router.\" If your deployment requires \"Prefer standalone script\", then please ensure that the issue is tracked in lab.civicrm.org.', - 'help_text' => '', - 'options' => [ - 'standalone' => 'Prefer standalone scripts', - 'router' => 'Prefer normal router', - ], - ], - 'activity_assignee_notification' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'activity_assignee_notification', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => '1', - 'add' => '4.1', - 'title' => 'Notify Activity Assignees', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'activity_assignee_notification_ics' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'activity_assignee_notification_ics', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.3', - 'title' => 'Include ICal Invite to Activity Assignees', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'contact_autocomplete_options' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'contact_autocomplete_options', - 'type' => 'String', - 'html_type' => 'checkboxes', - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Search::getContactAutocompleteOptions', - ], - 'default' => '12', - 'add' => '4.1', - 'title' => 'Autocomplete Contact Search', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Selected fields will be displayed in back-office autocomplete dropdown search results (Quick Search, etc.). Contact Name is always included.', - 'help_text' => '', - 'serialize' => 1, - 'validate_callback' => 'CRM_Admin_Form_Setting_Search::enableOptionOne', - ], - 'contact_reference_options' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'contact_reference_options', - 'type' => 'String', - 'html_type' => 'checkboxes', - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Search::getContactReferenceOptions', - ], - 'default' => '12', - 'add' => '4.1', - 'title' => 'Contact Reference Options', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Selected fields will be displayed in autocomplete dropdown search results for \'Contact Reference\' custom fields. Contact Name is always included. NOTE: You must assign \'access contact reference fields\' permission to the anonymous role if you want to use custom contact reference fields in profiles on public pages. For most situations, you should use the \'Limit List to Group\' setting when configuring a contact reference field which will be used in public forms to prevent exposing your entire contact list.', - 'help_text' => '', - 'serialize' => 1, - 'validate_callback' => 'CRM_Admin_Form_Setting_Search::enableOptionOne', - ], - 'contact_smart_group_display' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'contact_smart_group_display', - 'type' => 'String', - 'html_type' => 'radio', - 'default' => '1', - 'add' => '4.7', - 'title' => 'Viewing Smart Groups', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Controls display of the smart groups that a contact is part of in each contact\'s \"Groups\" tab. \"Show on Demand\" provides the best performance, and is recommended for most sites.', - 'help_text' => '', - 'pseudoconstant' => [ - 'optionGroupName' => 'contact_smart_group_display', - ], - ], - 'smart_group_cache_refresh_mode' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'smart_group_cache_refresh_mode', - 'type' => 'String', - 'html_type' => 'radio', - 'default' => 'opportunistic', - 'add' => '4.7', - 'title' => 'Smart Group Refresh Mode', - 'is_domain' => 1, - 'is_contact' => 0, - 'pseudoconstant' => [ - 'callback' => 'CRM_Contact_BAO_GroupContactCache::getModes', - ], - 'description' => 'Should the smart groups be flushed by cron jobs or user actions', - 'help_text' => 'In \"Opportunistic Flush\" mode, caches are flushed in response to user actions; this mode is broadly compatible but may add latency during form-submissions. In \"Cron Flush\" mode, you should schedule a cron job to flush caches; this can improve latency on form-submissions but requires more setup.', - ], - 'acl_cache_refresh_mode' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'acl_cache_refresh_mode', - 'type' => 'String', - 'html_type' => 'radio', - 'default' => 'opportunistic', - 'add' => '5.37.0', - 'title' => 'ACL Group Refresh Mode', - 'is_domain' => 1, - 'is_contact' => 0, - 'pseudoconstant' => [ - 'callback' => 'CRM_Contact_BAO_GroupContactCache::getModes', - ], - 'description' => 'Should the acl cache be flushed by cron jobs or user actions', - 'help_text' => 'In \"Opportunistic Flush\" mode, caches are flushed in response to user actions; this mode is broadly compatible but may add latency during form-submissions. In \"Cron Flush\" mode, you should schedule a cron job to flush caches if your site uses ACLs; this can improve latency on form-submissions but requires more setup.', - ], - 'installed' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'installed', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => '', - 'add' => '4.7', - 'title' => 'System Installed', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'A flag indicating whether this system has run a post-installation routine', - 'help_text' => '', - ], - 'max_attachments' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'max_attachments', - 'legacy_key' => 'maxAttachments', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - 'maxlength' => 8, - ], - 'default' => 3, - 'add' => '4.3', - 'title' => 'Maximum Attachments', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Maximum number of files (documents, images, etc.) which can be attached to emails or activities. This setting applies to UI forms and limits the number of fields available on the form.', - 'help_text' => '', - ], - 'max_attachments_backend' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'max_attachments_backend', - 'legacy_key' => 'maxAttachmentsBackend', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - 'maxlength' => 8, - ], - 'default' => 100, - 'add' => '5.20', - 'title' => 'Maximum Attachments For Backend Processes', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Maximum number of files (documents, images, etc.) which can be processed during backend processing such as automated inbound email processing. This should be a big number higher than the other Maximum Attachments setting above. This setting here merely provides an upper limit to prevent attacks that might overload the server.', - 'help_text' => '', - ], - 'maxFileSize' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'maxFileSize', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - 'maxlength' => 8, - ], - 'default' => 3, - 'add' => '4.3', - 'title' => 'Maximum File Size (in MB)', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Maximum Size of file (documents, images, etc.) which can be attached to emails or activities.
Note: php.ini should support this file size.', - 'help_text' => '', - ], - 'contact_undelete' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'contact_undelete', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.3', - 'title' => 'Contact Trash and Undelete', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, deleted contacts will be moved to trash (instead of being destroyed). Users with the proper permission are able to search for the deleted contacts and restore them (or delete permanently).', - 'help_text' => '', - ], - 'allowPermDeleteFinancial' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'allowPermDeleteFinancial', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => '', - 'add' => '4.3', - 'title' => 'Contact Permanent Delete', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Allow Permanent Delete for contacts who are linked to live financial transactions', - 'help_text' => '', - ], - 'securityAlert' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'securityAlert', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.4', - 'title' => 'Status Alerts', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, CiviCRM will display pop-up notifications (no more than once per day) for security and misconfiguration issues identified in the system check.', - 'help_text' => '', - ], - 'doNotAttachPDFReceipt' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'doNotAttachPDFReceipt', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.3', - 'title' => 'Attach PDF copy to receipts', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, CiviCRM sends PDF receipt as an attachment during event signup or online contribution.', - 'help_text' => '', - ], - 'recordGeneratedLetters' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'recordGeneratedLetters', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'default' => 'multiple', - 'add' => '4.7', - 'title' => 'Record generated letters', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'When generating a letter (PDF/Word) via mail-merge, how should the letter be recorded?', - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Contact_Form_Task_PDFLetterCommon::getLoggingOptions', - ], - ], - 'dompdf_font_dir' => [ - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'dompdf_font_dir', - 'title' => 'DOMPDF Font Folder', - 'description' => 'Additional folder where DOMPDF will look for fonts.', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 256, - ], - 'default' => '', - 'help_text' => '', - 'add' => '5.43', - ], - 'dompdf_chroot' => [ - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'dompdf_chroot', - 'title' => 'DOMPDF Local Images Folder', - 'description' => 'Folder to restrict where DOMPDF looks when loading local images. By default it is the DOMPDF folder itself for security reasons. It will search in subfolders.', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 256, - ], - 'default' => '', - 'help_text' => '', - 'add' => '5.43', - ], - 'dompdf_enable_remote' => [ - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'dompdf_enable_remote', - 'title' => 'DOMPDF Enable Remote Images', - 'description' => 'Enable the use of remote images. By default this is enabled, but if not using remote images you may wish to turn it off for security reasons.', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'html_type' => '', - 'default' => TRUE, - 'help_text' => '', - 'add' => '5.43', - ], - 'dompdf_log_output_file' => [ - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'dompdf_log_output_file', - 'title' => 'DOMPDF Log File', - 'description' => 'DOMPDF will log debugging output in this file.', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 256, - ], - 'default' => '', - 'help_text' => '', - 'add' => '5.43', - ], - 'wkhtmltopdfPath' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'wkhtmltopdfPath', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 256, - ], - 'html_type' => 'text', - 'default' => '', - 'add' => '4.3', - 'title' => 'Path to wkhtmltopdf executable', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'checksum_timeout' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'checksum_timeout', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_attributes' => [ - 'size' => 2, - 'maxlength' => 8, - ], - 'html_type' => 'text', - 'default' => 7, - 'add' => '4.3', - 'title' => 'Checksum Lifespan', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'blogUrl' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'blogUrl', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 128, - ], - 'html_type' => 'text', - 'default' => '*default*', - 'add' => '4.3', - 'title' => 'Blog Feed URL', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Blog feed URL used by the blog dashlet', - 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL', - ], - 'communityMessagesUrl' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'communityMessagesUrl', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 128, - ], - 'html_type' => 'text', - 'default' => '*default*', - 'add' => '4.3', - 'title' => 'Community Messages URL', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Service providing CiviCRM community messages', - 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL', - ], - 'gettingStartedUrl' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'gettingStartedUrl', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 128, - ], - 'html_type' => 'text', - 'default' => '*default*', - 'add' => '4.3', - 'title' => 'Getting Started URL', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Service providing the Getting Started data', - 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL', - ], - 'resCacheCode' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'resCacheCode', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'default' => '', - 'add' => '4.3', - 'title' => 'resCacheCode', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Code appended to resource URLs (JS/CSS) to coerce HTTP caching', - 'help_text' => '', - ], - 'verifySSL' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'verifySSL', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.3', - 'title' => 'Verify SSL?', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If disabled, outbound web-service requests will allow unverified, insecure HTTPS connections', - 'help_text' => 'Unless you are absolutely unable to configure your server to check the SSL certificate of the remote server you should leave this set to Yes', - ], - 'enableSSL' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'enableSSL', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.5', - 'title' => 'Force SSL?', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, inbound HTTP requests for sensitive pages will be redirected to HTTPS.', - 'help_text' => 'If enabled, inbound HTTP requests for sensitive pages will be redirected to HTTPS.', - ], - 'wpBasePage' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'wpBasePage', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.3', - 'title' => 'WordPress Base Page', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If set, CiviCRM will use this setting as the base url.', - 'help_text' => 'By default, CiviCRM will generate front-facing pages using the home page at http://wp/ as its base. If you want to use a different template for CiviCRM pages, set the path here.', - ], - 'secondDegRelPermissions' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'secondDegRelPermissions', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.3', - 'title' => 'Allow second-degree relationship permissions', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, contacts with the permission to edit a related contact will inherit that contact\'s permission to edit other related contacts', - 'help_text' => '', - ], - 'enable_components' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'enable_components', - 'type' => 'Array', - 'html_type' => 'checkboxes', - 'default' => '', - 'add' => '4.4', - 'title' => 'Enable Components', - 'is_domain' => '1', - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - 'on_change' => [ - '0' => 'CRM_Case_Info::onToggleComponents', - ], - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::getComponentSelectValues', - ], - ], - 'disable_core_css' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'disable_core_css', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.4', - 'title' => 'Disable CiviCRM css', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Prevent the stylesheet \"civicrm.css\" from being loaded.', - 'help_text' => '', - ], - 'empoweredBy' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'empoweredBy', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.5', - 'title' => 'Display \"empowered by CiviCRM\"', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'When enabled, \"empowered by CiviCRM\" is displayed at the bottom of public forms.', - 'help_text' => '', - ], - 'logging_no_trigger_permission' => [ - 'add' => '4.7', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'help_text' => '(EXPERIMENTAL) If the MySQL user does not have permission to administer triggers, then you must create the triggers outside CiviCRM. No support is provided for this configuration.', - 'name' => 'logging_no_trigger_permission', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'html_type' => '', - 'default' => 0, - 'title' => '(EXPERIMENTAL) MySQL user does not have trigger permissions', - 'description' => 'Set this when you intend to manage trigger creation outside of CiviCRM', - ], - 'logging' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'logging', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'html_type' => '', - 'default' => 0, - 'title' => 'Logging', - 'description' => 'If enabled, all actions will be logged with a complete record of changes.', - 'validate_callback' => 'CRM_Logging_Schema::checkLoggingSupport', - 'on_change' => [ - '0' => 'CRM_Logging_Schema::onToggle', - ], - ], - 'logging_uniqueid_date' => [ - 'add' => '4.7', - 'help_text' => 'This is the date when CRM-18193 was implemented', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'logging_uniqueid_date', - 'type' => 'Date', - 'quick_form_type' => 'DateTime', - 'html_type' => '', - 'default' => '', - 'title' => 'Logging Unique ID not recorded before', - 'description' => 'This is the date when CRM-18193 was implemented', - ], - 'logging_all_tables_uniquid' => [ - 'add' => '4.7', - 'help_text' => 'This indicates there are no tables holdng pre-uniqid log_conn_id values (CRM-18193)', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'logging_all_tables_uniquid', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'html_type' => '', - 'default' => 0, - 'title' => 'All tables use Unique Connection ID', - 'description' => 'Do some tables pre-date CRM-18193?', - ], - 'userFrameworkUsersTableName' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'userFrameworkUsersTableName', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '32', - 'maxlength' => '64', - ], - 'default' => 'users', - 'title' => 'CMS Users Table Name', - 'description' => '', - ], - 'wpLoadPhp' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'wpLoadPhp', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.6', - 'title' => 'WordPress Path to wp-load.php', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'CiviCRM will use this setting as path to bootstrap WP.', - 'help_text' => '', - ], - 'secure_cache_timeout_minutes' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'secure_cache_timeout_minutes', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - 'maxlength' => 8, - ], - 'default' => 20, - 'add' => '4.7', - 'title' => 'Secure Cache Timeout', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Maximum number of minutes that secure form data should linger', - 'help_text' => '', - ], - 'site_id' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'site_id', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'default' => '', - 'add' => '4.6', - 'title' => 'Unique Site ID', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - ], - 'recentItemsMaxCount' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'recentItemsMaxCount', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - 'maxlength' => 3, - ], - 'default' => 20, - 'add' => '4.7', - 'title' => 'Size of \"Recent Items\" stack', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'How many items should CiviCRM store in it\'s \"Recently viewed\" list.', - 'help_text' => '', - ], - 'recentItemsProviders' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'recentItemsProviders', - 'type' => 'Array', - 'html_type' => 'Select', - 'quick_form_type' => 'Select', - 'html_attributes' => [ - 'multiple' => 1, - 'class' => 'crm-select2', - ], - 'default' => '', - 'add' => '4.7', - 'title' => 'Recent Items Providers', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'What providers may save views in CiviCRM\'s \"Recently viewed\" list. If empty, all are in.', - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Utils_Recent::getProviders', - ], - ], - 'dedupe_default_limit' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'dedupe_default_limit', - 'type' => 'Integer', - 'default' => 0, - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'add' => '4.7', - 'title' => 'Default limit for dedupe screen', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Default to only loading matches against this number of contacts', - 'help_text' => 'Deduping larger databases can crash the server. By configuring a limit other than 0 here the dedupe query will only search for matches against a limited number of contacts.', - ], - 'syncCMSEmail' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'syncCMSEmail', - 'type' => 'Boolean', - 'html_type' => 'YesNo', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.7', - 'title' => 'Sync CMS Email', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, then CMS email id will be synchronised with CiviCRM contacts\'s primary email.', - 'help_text' => '', - ], - 'preserve_activity_tab_filter' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'preserve_activity_tab_filter', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.7', - 'title' => 'Preserve activity filters as a user preference', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'When enabled, any filter settings a user selects on the contact\'s Activity tab will be remembered as they visit other contacts.', - ], - 'do_not_notify_assignees_for' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'do_not_notify_assignees_for', - 'type' => 'Array', - 'add' => '4.7', - 'is_domain' => 1, - 'is_contact' => 0, - 'default' => [], - 'title' => 'Do not notify assignees for', - 'description' => 'These activity types will be excluded from automated email notifications to assignees.', - 'html_type' => 'select', - 'html_attributes' => [ - 'multiple' => 1, - 'class' => 'huge crm-select2', - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'activity_type', - ], - 'quick_form_type' => 'Select', - ], - 'menubar_position' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'menubar_position', - 'type' => 'String', - 'html_type' => 'select', - 'default' => 'over-cms-menu', - 'add' => '5.12', - 'title' => 'Menubar position', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Location of the CiviCRM main menu.', - 'help_text' => '', - 'options' => [ - 'over-cms-menu' => 'Replace website menu', - 'below-cms-menu' => 'Below website menu', - 'above-crm-container' => 'Above content area', - 'none' => 'None - disable menu', - ], - ], - 'menubar_color' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'menubar_color', - 'type' => 'String', - 'html_type' => 'color', - 'default' => '#1b1b1b', - 'add' => '5.13', - 'title' => 'Menubar color', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Color of the CiviCRM main menu.', - 'help_text' => '', - 'validate_callback' => 'CRM_Utils_Color::normalize', - ], - 'requestableMimeTypes' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'requestableMimeTypes', - 'type' => 'String', - 'html_type' => 'Text', - 'default' => 'image/jpeg,image/pjpeg,image/gif,image/x-png,image/png,image/jpg,text/html,application/pdf', - 'add' => '5.13', - 'title' => 'Mime Types that can be passed as URL params', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Acceptable Mime Types that can be used as part of file urls', - 'help_text' => '', - ], - 'theme_frontend' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'theme_frontend', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'pseudoconstant' => [ - 'callback' => 'call://themes/getAvailable', - ], - 'default' => 'default', - 'add' => '5.16', - 'title' => 'Frontend Theme', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Theme to use on frontend pages', - 'help_text' => '', - ], - 'theme_backend' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'theme_backend', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'pseudoconstant' => [ - 'callback' => 'call://themes/getAvailable', - ], - 'default' => 'default', - 'add' => '5.16', - 'title' => 'Backend Theme', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Theme to use on backend pages', - 'help_text' => '', - ], - 'http_timeout' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'http_timeout', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - 'maxlength' => 3, - ], - 'default' => 5, - 'add' => '5.14', - 'title' => 'HTTP request timeout', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'How long should HTTP requests through Guzzle application run for in seconds', - 'help_text' => 'Set the number of seconds http requests should run for before terminating', - ], - 'assetCache' => [ - 'group_name' => 'Developer Preferences', - 'group' => 'developer', - 'name' => 'assetCache', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [], - 'default' => 'auto', - 'add' => '4.7', - 'title' => 'Asset Caching', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Store computed JS/CSS content in cache files? (Note: In \"Auto\" mode, the \"Debug\" setting will determine whether to activate the cache.)', - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => '\Civi\Core\AssetBuilder::getCacheModes', - ], - ], - 'userFrameworkLogging' => [ - 'group_name' => 'Developer Preferences', - 'group' => 'developer', - 'name' => 'userFrameworkLogging', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.3', - 'title' => 'Enable Drupal Watchdog Logging', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Set this value to Yes if you want CiviCRM error/debugging messages to appear in the Drupal error logs.', - 'help_text' => 'Set this value to Yes if you want CiviCRM error/debugging messages the appear in your CMS\' error log. In the case of Drupal, this will cause all CiviCRM error messages to appear in the watchdog (assuming you have Drupal\'s watchdog enabled)', - ], - 'debug_enabled' => [ - 'group_name' => 'Developer Preferences', - 'group' => 'developer', - 'name' => 'debug_enabled', - 'config_key' => 'debug', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.3', - 'title' => 'Enable Debugging', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Set this value to Yes if you want to use one of CiviCRM\'s debugging tools. This feature should NOT be enabled for production sites.', - 'help_text' => 'Do not turn this on on production sites', - ], - 'backtrace' => [ - 'group_name' => 'Developer Preferences', - 'group' => 'developer', - 'name' => 'backtrace', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.3', - 'title' => 'Display Backtrace', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Set this value to Yes if you want to display a backtrace listing when a fatal error is encountered. This feature should NOT be enabled for production sites.', - ], - 'environment' => [ - 'group_name' => 'Developer Preferences', - 'group' => 'developer', - 'name' => 'environment', - 'type' => 'String', - 'html_type' => 'Select', - 'quick_form_type' => 'Select', - 'default' => 'Production', - 'pseudoconstant' => [ - 'optionGroupName' => 'environment', - ], - 'add' => '4.7', - 'title' => 'Environment', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Setting to define the environment in which this CiviCRM instance is running.', - 'on_change' => [ - '0' => 'CRM_Core_BAO_Setting::onChangeEnvironmentSetting', - ], - ], - 'fatalErrorHandler' => [ - 'group_name' => 'Developer Preferences', - 'group' => 'developer', - 'name' => 'fatalErrorHandler', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'default' => '', - 'add' => '4.3', - 'title' => 'Fatal Error Handler', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Enter the path and class for a custom PHP error-handling function if you want to override built-in CiviCRM error handling for your site.', - ], - 'uploadDir' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group_name' => 'Directory Preferences', - 'group' => 'directory', - 'name' => 'uploadDir', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'title' => 'Temporary Files Directory', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => 'File system path where temporary CiviCRM files - such as import data files - are uploaded.', - ], - 'imageUploadDir' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group_name' => 'Directory Preferences', - 'group' => 'directory', - 'name' => 'imageUploadDir', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'title' => 'Image Directory', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'File system path where image files are uploaded. Currently, this path is used for images associated with premiums (CiviContribute thank-you gifts).', - 'help_text' => '', - ], - 'customFileUploadDir' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group_name' => 'Directory Preferences', - 'group' => 'directory', - 'name' => 'customFileUploadDir', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'title' => 'Custom Files Directory', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Path where documents and images which are attachments to contact records are stored (e.g. contact photos, resumes, contracts, etc.). These attachments are defined using \'file\' type custom fields.', - 'help_text' => '', - ], - 'customTemplateDir' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group_name' => 'Directory Preferences', - 'group' => 'directory', - 'name' => 'customTemplateDir', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'title' => 'Custom Template Directory', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Path where site specific templates are stored if any. This directory is searched first if set. Custom JavaScript code can be added to templates by creating files named templateFile.extra.tpl. (learn more...)', - 'help_text' => '', - ], - 'customPHPPathDir' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group_name' => 'Directory Preferences', - 'group' => 'directory', - 'name' => 'customPHPPathDir', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'title' => 'Custom PHP Directory', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Path where site specific PHP code files are stored if any. This directory is searched first if set.', - 'help_text' => '', - ], - 'extensionsDir' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group_name' => 'Directory Preferences', - 'group' => 'directory', - 'name' => 'extensionsDir', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'title' => 'Extensions Directory', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Path where CiviCRM extensions are stored.', - 'help_text' => '', - ], - 'show_events' => [ - 'name' => 'show_events', - 'group_name' => 'Event Preferences', - 'group' => 'event', - 'settings_pages' => [ - 'event' => [ - 'weight' => 20, - ], - ], - 'type' => 'Integer', - 'quick_form_type' => 'Select', - 'default' => 10, - 'add' => '4.5', - 'title' => 'Dashboard entries', - 'html_type' => 'select', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Configure how many events should be shown on the dashboard. This overrides the default value of 10 entries.', - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::getDashboardEntriesCount', - ], - ], - 'ext_repo_url' => [ - 'group_name' => 'Extension Preferences', - 'group' => 'ext', - 'name' => 'ext_repo_url', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 128, - ], - 'html_type' => 'text', - 'default' => 'https://civicrm.org/extdir/ver={ver}|cms={uf}', - 'add' => '4.3', - 'title' => 'Extension Repo URL', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'customTranslateFunction' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'customTranslateFunction', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '30', - 'maxlength' => '100', - ], - 'default' => '', - 'title' => 'Custom Translate Function', - ], - 'monetaryThousandSeparator' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'monetaryThousandSeparator', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - ], - 'default' => ',', - 'add' => '4.3', - 'title' => 'Thousands Separator', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'monetaryDecimalPoint' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'monetaryDecimalPoint', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - ], - 'default' => '.', - 'add' => '4.3', - 'title' => 'Decimal Delimiter', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'moneyformat' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'moneyformat', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'default' => '%c %a', - 'add' => '4.3', - 'title' => 'Monetary Amount Display', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'moneyvalueformat' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'moneyvalueformat', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'default' => '%!i', - 'add' => '4.3', - 'title' => 'Monetary Value Display', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'defaultCurrency' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'defaultCurrency', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'default' => 'USD', - 'add' => '4.3', - 'title' => 'Default Currency', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Default currency assigned to contributions and other monetary transactions.', - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Localization::getCurrencySymbols', - ], - 'on_change' => [ - '0' => 'CRM_Admin_Form_Setting_Localization::onChangeDefaultCurrency', - ], - ], - 'defaultContactCountry' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'defaultContactCountry', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [], - 'add' => '4.4', - 'title' => 'Default Country', - 'is_domain' => 1, - 'is_contact' => 0, - 'is_required' => '', - 'description' => 'This value is selected by default when adding a new contact address.', - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries', - ], - ], - 'defaultContactStateProvince' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'defaultContactStateProvince', - 'type' => 'Integer', - 'quick_form_type' => 'ChainSelect', - 'html_type' => 'ChainSelect', - 'chain_select_settings' => [ - 'control_field' => 'defaultContactCountry', - ], - 'default' => '', - 'title' => 'Default State/Province', - 'description' => 'This value is selected by default when adding a new contact address.', - ], - 'countryLimit' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'countryLimit', - 'type' => 'Array', - 'quick_form_type' => 'Element', - 'html_type' => 'advmultiselect', - 'html_attributes' => [ - 'size' => 5, - 'style' => 'width:150px', - 'class' => 'advmultiselect', - ], - 'default' => [], - 'add' => '4.3', - 'title' => 'Available Countries', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries', - ], - ], - 'provinceLimit' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'provinceLimit', - 'type' => 'Array', - 'quick_form_type' => 'Element', - 'html_type' => 'advmultiselect', - 'html_attributes' => [ - 'size' => 5, - 'style' => 'width:150px', - 'class' => 'advmultiselect', - ], - 'default' => [], - 'add' => '4.3', - 'title' => 'Available States and Provinces (by Country)', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries', - ], - ], - 'inheritLocale' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'inheritLocale', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.3', - 'title' => 'Inherit CMS Language', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'description' => 'If Yes, the initial session language will be set by the CMS, which can later be changed if using the CiviCRM language switcher.', - ], - 'dateformatDatetime' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'dateformatDatetime', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'default' => '%B %E%f, %Y %l:%M %P', - 'add' => '4.3', - 'title' => 'Date Format: Complete Date and Time', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'dateformatFull' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'dateformatFull', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'default' => '%B %E%f, %Y', - 'add' => '4.3', - 'title' => 'Date Format: Complete Date', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'dateformatPartial' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'dateformatPartial', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'default' => '%B %Y', - 'add' => '4.3', - 'title' => 'Date Format: Month and Year', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'dateformatTime' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'dateformatTime', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '12', - 'maxlength' => '60', - ], - 'default' => '%l:%M %P', - 'title' => 'Date Format: Time Only', - ], - 'dateformatYear' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'dateformatYear', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '12', - 'maxlength' => '60', - ], - 'default' => '%Y', - 'title' => 'Date Format: Year Only', - ], - 'dateformatFinancialBatch' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'dateformatFinancialBatch', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '12', - 'maxlength' => '60', - ], - 'default' => '%m/%d/%Y', - 'title' => 'Date Format: Financial Batch', - ], - 'dateformatshortdate' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'dateformatshortdate', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '12', - 'maxlength' => '60', - ], - 'default' => '%m/%d/%Y', - 'title' => 'Date Format: Short date Month Day Year', - ], - 'dateInputFormat' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'dateInputFormat', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::getDatePluginInputFormats', - ], - 'default' => 'mm/dd/yy', - 'title' => 'Date Input Format', - ], - 'fieldSeparator' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'fieldSeparator', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '2', - 'maxlength' => '8', - ], - 'default' => ',', - 'title' => 'Import / Export Field Separator', - 'description' => 'Global CSV separator character. Modify this setting to enable import and export of different kinds of CSV files (for example: \',\' \';\' \':\' \'|\' ).', - ], - 'fiscalYearStart' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'fiscalYearStart', - 'type' => 'Array', - 'quick_form_type' => 'MonthDay', - 'html_type' => 'MonthDay', - 'default' => [ - 'M' => 1, - 'd' => 1, - ], - 'title' => 'Fiscal Year Start', - ], - 'languageLimit' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'languageLimit', - 'type' => 'Array', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'multiple' => 1, - 'class' => 'crm-select2', - ], - 'default' => '', - 'add' => '4.3', - 'title' => 'Available Languages (Multi-lingual)', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_I18n::languages', - ], - ], - 'uiLanguages' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'uiLanguages', - 'type' => 'Array', - 'quick_form_type' => 'Select', - 'html_type' => 'select', - 'html_attributes' => [ - 'multiple' => 1, - 'class' => 'crm-select2', - ], - 'default' => '', - 'add' => '5.9', - 'title' => 'Available Languages', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => 'User Interface languages available to users', - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_I18n::languages', - ], - ], - 'lcMessages' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'lcMessages', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'default' => 'en_US', - 'add' => '4.3', - 'title' => 'Default Language', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Localization::getDefaultLocaleOptions', - ], - 'on_change' => [ - '0' => 'CRM_Admin_Form_Setting_Localization::onChangeLcMessages', - ], - ], - 'legacyEncoding' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'legacyEncoding', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '12', - 'maxlength' => '30', - ], - 'default' => 'Windows-1252', - 'title' => 'Legacy Encoding', - 'description' => 'If import files are NOT encoded as UTF-8, specify an alternate character encoding for these files. The default of Windows-1252 will work for Excel-created .CSV files on many computers.', - ], - 'timeInputFormat' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'timeInputFormat', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::getTimeFormats', - ], - 'default' => '1', - 'title' => 'Time Input Format', - 'on_change' => [ - '0' => 'CRM_Core_BAO_PreferencesDate::onChangeSetting', - ], - ], - 'weekBegins' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'weekBegins', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'pseudoconstant' => [ - 'callback' => 'CRM_Utils_Date::getFullWeekdayNames', - ], - 'default' => 0, - 'add' => '4.7', - 'title' => 'Week begins on', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'contact_default_language' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'contact_default_language', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Localization::getDefaultLanguageOptions', - ], - 'default' => '*default*', - 'add' => '4.7', - 'title' => 'Default Language for contacts', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Default language (if any) for contact records.', - 'help_text' => 'If a contact is created with no language this setting will determine the language data (if any) to save.You may or may not wish to make an assumption here about whether it matches the site language', - ], - 'pinnedContactCountries' => [ - 'group_name' => 'Localization Preferences', - 'group' => 'localization', - 'name' => 'pinnedContactCountries', - 'type' => 'Array', - 'quick_form_type' => 'Element', - 'html_type' => 'advmultiselect', - 'html_attributes' => [ - 'size' => 5, - 'style' => 'width:150px', - 'class' => 'advmultiselect', - ], - 'default' => [], - 'add' => '5.33', - 'title' => 'Pinned Countries', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Appear in Top section of select list', - 'help_text' => 'Selected countries will appear in top section of country list', - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries', - ], - ], - 'profile_double_optin' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'profile_double_optin', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => '1', - 'add' => '4.1', - 'title' => 'Enable Double Opt-in for Profile Group(s) field', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'When CiviMail is enabled, users who \"subscribe\" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.', - 'help_text' => '', - ], - 'track_civimail_replies' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'track_civimail_replies', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.1', - 'title' => 'Track replies using VERP in Reply-To header', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If checked, mailings will default to tracking replies using VERP-ed Reply-To.', - 'help_text' => '', - 'validate_callback' => 'CRM_Core_BAO_Setting::validateBoolSetting', - ], - 'civimail_workflow' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'civimail_workflow', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.1', - 'title' => 'Enable workflow support for CiviMail', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Drupal-only. Rules module must be enabled (beta feature - use with caution).', - 'help_text' => '', - ], - 'civimail_server_wide_lock' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'civimail_server_wide_lock', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.1', - 'title' => 'Enable global server wide lock for CiviMail', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'replyTo' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'replyTo', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.6', - 'title' => 'Enable Custom Reply-To', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Allow CiviMail users to send mailings with a custom Reply-To header.', - 'help_text' => '', - ], - 'mailing_backend' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'mailing_backend', - 'type' => 'Array', - 'html_type' => 'checkbox', - 'default' => [ - 'outBound_option' => '3', - ], - 'add' => '4.1', - 'title' => 'Mailing Backend', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'profile_add_to_group_double_optin' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'profile_add_to_group_double_optin', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.1', - 'title' => 'Enable Double Opt-in for Profiles which use the \"Add to Group\" setting', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'When CiviMail is enabled and a profile uses the \"Add to Group\" setting, users who complete the profile form will receive a confirmation email. They must respond (opt-in) before they are added to the group.', - 'help_text' => '', - ], - 'disable_mandatory_tokens_check' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'disable_mandatory_tokens_check', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.4', - 'title' => 'Disable check for mandatory tokens', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Don\'t check for presence of mandatory tokens (domain address; unsubscribe/opt-out) before sending mailings. WARNING: Mandatory tokens are a safe-guard which facilitate compliance with the US CAN-SPAM Act. They should only be disabled if your organization adopts other mechanisms for compliance or if your organization is not subject to CAN-SPAM.', - 'help_text' => '', - ], - 'dedupe_email_default' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'dedupe_email_default', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 1, - 'add' => '4.5', - 'title' => 'CiviMail dedupes e-mail addresses by default', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Set the \"dedupe e-mail\" option when sending a new mailing to \"true\" by default.', - 'help_text' => '', - ], - 'hash_mailing_url' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'hash_mailing_url', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.5', - 'title' => 'Hashed Mailing URL\'s', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, a randomized hash key will be used to reference the mailing URL in the mailing.viewUrl token, instead of the mailing ID.', - 'help_text' => '', - ], - 'civimail_multiple_bulk_emails' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'civimail_multiple_bulk_emails', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => 0, - 'add' => '4.5', - 'title' => 'Enable multiple bulk email address for a contact.', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'CiviMail will deliver a copy of the email to each bulk email listed for the contact. Enabling this setting will also change the options for the \"Email on Hold\" field in Advanced Search.', - 'help_text' => '', - ], - 'include_message_id' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'include_message_id', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'default' => '', - 'add' => '4.5', - 'title' => 'Enable CiviMail to generate Message-ID header', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'mailerBatchLimit' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'mailerBatchLimit', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 4, - 'maxlength' => 8, - ], - 'default' => 0, - 'add' => '4.7', - 'title' => 'Mailer Batch Limit', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Throttle email delivery by setting the maximum number of emails sent during each CiviMail run (0 = unlimited).', - 'help_text' => '', - ], - 'mailerJobSize' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'mailerJobSize', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 4, - 'maxlength' => 8, - ], - 'default' => 0, - 'add' => '4.7', - 'title' => 'Mailer Job Size', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If you want to utilize multi-threading enter the size you want your sub jobs to be split into. Recommended values are between 1,000 and 10,000. Use a lower value if your server has multiple cron jobs running simultaneously, but do not use values smaller than 1,000. Enter \"0\" to disable multi-threading and process mail as one single job - batch limits still apply.', - 'help_text' => '', - ], - 'mailerJobsMax' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'mailerJobsMax', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 4, - 'maxlength' => 8, - ], - 'default' => 0, - 'add' => '4.7', - 'title' => 'Mailer Cron Job Limit', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'The maximum number of mailer delivery jobs executing simultaneously (0 = allow as many processes to execute as started by cron).', - 'help_text' => '', - ], - 'mailThrottleTime' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'mailThrottleTime', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 4, - 'maxlength' => 8, - ], - 'default' => 0, - 'add' => '4.7', - 'title' => 'Mailer Throttle Time', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'The time to sleep in between each e-mail in micro seconds. Setting this above 0 allows you to control the rate at which e-mail messages are sent to the mail server, avoiding filling up the mail queue very quickly. Set to 0 to disable.', - 'help_text' => '', - ], - 'verpSeparator' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'verpSeparator', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 4, - 'maxlength' => 32, - ], - 'default' => '.', - 'add' => '4.7', - 'title' => 'VERP Separator', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Separator character used when CiviMail generates VERP (variable envelope return path) Mail-From addresses.', - 'help_text' => '', - ], - 'write_activity_record' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'write_activity_record', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'CheckBox', - 'default' => '1', - 'add' => '4.7', - 'title' => 'Enable CiviMail to create activities on delivery', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'simple_mail_limit' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'simple_mail_limit', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 4, - 'maxlength' => 8, - ], - 'default' => 50, - 'title' => 'Simple mail limit', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'The number of emails sendable via simple mail. Make sure you understand the implications for your spam reputation and legal requirements for bulk emails before editing. As there is some risk both to your spam reputation and the products if this is misused it is a hidden setting.', - 'help_text' => 'CiviCRM forces users sending more than this number of mails to use CiviMails. CiviMails have additional precautions: not sending to contacts who do not want bulk mail, adding domain name and opt out links. You should familiarise yourself with the law relevant to you on bulk mailings if changing this setting. For the US https://en.wikipedia.org/wiki/CAN-SPAM_Act_of_2003 is a good place to start.', - ], - 'auto_recipient_rebuild' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'auto_recipient_rebuild', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'CheckBox', - 'default' => '1', - 'title' => 'Enable automatic CiviMail recipient count display', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Enable this setting to rebuild recipient list automatically during composing mail. Disable will allow you to rebuild recipient manually.', - 'help_text' => 'CiviMail automatically fetches recipient list and count whenever mailing groups are included or excluded while composing bulk mail. This phenomena may degrade performance for large sites, so disable this setting to build and fetch recipients for selected groups, manually.', - ], - 'allow_mail_from_logged_in_contact' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'allow_mail_from_logged_in_contact', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'title' => 'Allow mail from logged in contact', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Allow sending email from the logged in contact\'s email address.', - 'help_text' => 'CiviCRM allows you to send email from the domain from email addresses and the logged in contact id addresses by default. Disable this if you only want to allow the domain from addresses to be used.', - ], - 'url_tracking_default' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'url_tracking_default', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'CheckBox', - 'default' => '1', - 'title' => 'Enable click-through tracking by default', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If checked, mailings will have click-through tracking enabled by default.', - 'help_text' => '', - ], - 'open_tracking_default' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'open_tracking_default', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'CheckBox', - 'default' => '1', - 'title' => 'Enable open tracking by default', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If checked, mailings will have open tracking enabled by default.', - 'help_text' => '', - ], - 'civimail_sync_interval' => [ - 'group_name' => 'Mailing Preferences', - 'group' => 'mailing', - 'name' => 'civimail_sync_interval', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 4, - 'maxlength' => 8, - ], - 'default' => 10, - 'title' => 'Database Update Frequency', - 'add' => '5.28', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'The frequency that CiviMail updates its sent mail database.', - 'help_text' => '', - ], - 'geoAPIKey' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Map Preferences', - 'group' => 'map', - 'name' => 'geoAPIKey', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '32', - 'maxlength' => '64', - ], - 'default' => '', - 'title' => 'Geo Provider Key', - 'description' => 'Enter the API key or Application ID associated with your geocoding provider.', - ], - 'geoProvider' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Map Preferences', - 'group' => 'map', - 'name' => 'geoProvider', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::geoProvider', - ], - 'default' => '', - 'title' => 'Geocoding Provider', - 'description' => 'This can be the same or different from the mapping provider selected.', - ], - 'mapAPIKey' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Map Preferences', - 'group' => 'map', - 'name' => 'mapAPIKey', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => '32', - 'maxlength' => '64', - ], - 'default' => '', - 'title' => 'Map Provider Key', - 'description' => 'Enter your API Key or Application ID. An API Key is required for the Google Maps API. Refer to developers.google.com for the latest information.', - ], - 'mapProvider' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'Map Preferences', - 'group' => 'map', - 'name' => 'mapProvider', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::mapProvider', - ], - 'default' => '', - 'title' => 'Mapping Provider', - 'description' => 'Choose the mapping provider that has the best coverage for the majority of your contact addresses.', - ], - 'default_renewal_contribution_page' => [ - 'group_name' => 'Member Preferences', - 'group' => 'member', - 'name' => 'default_renewal_contribution_page', - 'type' => 'Integer', - 'html_type' => 'select', - 'default' => '', - 'pseudoconstant' => [ - 'callback' => 'CRM_Contribute_PseudoConstant::contributionPage', - ], - 'add' => '4.1', - 'title' => 'Default online membership renewal page', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If you select a default online contribution page for self-service membership renewals, a \"renew\" link pointing to that page will be displayed on the Contact Dashboard for memberships which were entered offline. You will need to ensure that the membership block for the selected online contribution page includes any currently available memberships.', - 'help_text' => '', - ], - 'is_enabled' => [ - 'group_name' => 'Multi Site Preferences', - 'group' => 'multisite', - 'name' => 'is_enabled', - 'title' => 'Enable Multi Site Configuration', - 'html_type' => 'checkbox', - 'type' => 'Boolean', - 'default' => 0, - 'add' => '4.1', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Make CiviCRM aware of multiple domains. You should configure a domain group if enabled', - 'documentation_link' => [ - 'page' => 'Multi Site Installation', - 'resource' => 'wiki', - ], - 'help_text' => '', - 'settings_pages' => [ - 'multisite' => [ - 'weight' => 10, - ], - ], - ], - 'domain_group_id' => [ - 'group_name' => 'Multi Site Preferences', - 'group' => 'multisite', - 'name' => 'domain_group_id', - 'title' => 'Multisite Domain Group', - 'type' => 'Integer', - 'html_type' => 'entity_reference', - 'entity_reference_options' => [ - 'entity' => 'Group', - 'select' => [ - 'minimumInputLength' => 0, - ], - ], - 'default' => 0, - 'add' => '4.1', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Contacts created on this site are added to this group', - 'help_text' => '', - 'settings_pages' => [ - 'multisite' => [ - 'weight' => 20, - ], - ], - ], - 'event_price_set_domain_id' => [ - 'group_name' => 'Multi Site Preferences', - 'group' => 'multisite', - 'name' => 'event_price_set_domain_id', - 'title' => 'Domain Event Price Set', - 'type' => 'Integer', - 'default' => 0, - 'add' => '4.1', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'uniq_email_per_site' => [ - 'group_name' => 'Multi Site Preferences', - 'group' => 'multisite', - 'name' => 'uniq_email_per_site', - 'type' => 'Integer', - 'title' => 'Unique Email per Domain?', - 'default' => 0, - 'add' => '4.1', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - ], - 'search_autocomplete_count' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'search_autocomplete_count', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'number', - 'default' => 10, - 'add' => '4.3', - 'title' => 'Autocomplete Results', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'The maximum number of contacts to show at a time when typing in an autocomplete field.', - 'help_text' => '', - ], - 'enable_innodb_fts' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'enable_innodb_fts', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.4', - 'title' => 'InnoDB Full Text Search', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Enable InnoDB full-text search optimizations. (Requires MySQL 5.6+)', - 'help_text' => '', - 'on_change' => [ - '0' => [ - '0' => 'CRM_Core_InnoDBIndexer', - '1' => 'onToggleFts', - ], - ], - ], - 'includeOrderByClause' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'includeOrderByClause', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.6', - 'title' => 'Include Order By Clause', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If disabled, the search results will not be ordered. This may improve response time on search results on large datasets.', - 'help_text' => '', - ], - 'includeWildCardInName' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'includeWildCardInName', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.6', - 'title' => 'Automatic Wildcard', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, wildcards are automatically added to the beginning AND end of the search term when users search for contacts by Name. EXAMPLE: Searching for \'ada\' will return any contact whose name includes those letters - e.g. \'Adams, Janet\', \'Nadal, Jorge\', etc. If disabled, a wildcard is added to the end of the search term only. EXAMPLE: Searching for \'ada\' will return any contact whose last name begins with those letters - e.g. \'Adams, Janet\' but NOT \'Nadal, Jorge\'. Disabling this feature will speed up search significantly for larger databases, but users must manually enter wildcards (\'%\' or \'_\') to the beginning of the search term if they want to find all records which contain those letters. EXAMPLE: \'%ada\' will return \'Nadal, Jorge\'.', - 'help_text' => '', - ], - 'includeEmailInName' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'includeEmailInName', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.6', - 'title' => 'Include Email', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, email addresses are automatically included when users search by Name. Disabling this feature will speed up search significantly for larger databases, but users will need to use the Email search fields (from Advanced Search, Search Builder, or Profiles) to find contacts by email address.', - 'help_text' => '', - ], - 'includeNickNameInName' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'includeNickNameInName', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 0, - 'add' => '4.6', - 'title' => 'Include Nickname', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, nicknames are automatically included when users search by Name.', - 'help_text' => '', - ], - 'includeAlphabeticalPager' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'includeAlphabeticalPager', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.6', - 'title' => 'Include Alphabetical Pager', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If disabled, the alphabetical pager will not be displayed on the search screens. This will improve response time on search results on large datasets.', - 'help_text' => '', - ], - 'smartGroupCacheTimeout' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'smartGroupCacheTimeout', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'number', - 'default' => 5, - 'add' => '4.6', - 'title' => 'Smart group cache timeout', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'The number of minutes to cache smart group contacts. We strongly recommend that this value be greater than zero, since a value of zero means no caching at all. If your contact data changes frequently, you should set this value to at least 5 minutes.', - 'help_text' => '', - ], - 'defaultSearchProfileID' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'defaultSearchProfileID', - 'type' => 'Integer', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [ - 'class' => 'crm-select2', - ], - 'pseudoconstant' => [ - 'callback' => 'CRM_Admin_Form_Setting_Search::getAvailableProfiles', - ], - 'default' => '', - 'add' => '4.6', - 'title' => 'Default Contact Search Profile', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If set, this will be the default profile used for contact search.', - 'help_text' => '', - ], - 'prevNextBackend' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'prevNextBackend', - 'type' => 'String', - 'quick_form_type' => 'Select', - 'html_type' => 'Select', - 'html_attributes' => [], - 'default' => 'default', - 'add' => '5.9', - 'title' => 'PrevNext Cache', - 'is_domain' => 1, - 'is_contact' => 0, - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_BAO_PrevNextCache::getPrevNextBackends', - ], - 'description' => 'When performing a search, how should the search-results be cached?', - 'help_text' => '', - ], - 'searchPrimaryDetailsOnly' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'searchPrimaryDetailsOnly', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'default' => 1, - 'add' => '4.7', - 'title' => 'Search Primary Details Only', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'If enabled, only primary details (eg contact\'s primary email, phone, etc) will be included in Basic and Advanced Search results. Disabling this feature will allow users to match contacts using any email, phone etc detail.', - 'help_text' => '', - ], - 'quicksearch_options' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'quicksearch_options', - 'type' => 'string', - 'serialize' => 1, - 'html_type' => 'checkboxes', - 'sortable' => TRUE, - 'pseudoconstant' => [ - 'callback' => 'CRM_Core_SelectValues::quicksearchOptions', - ], - 'default' => [ - '0' => 'sort_name', - '1' => 'contact_id', - '2' => 'external_identifier', - '3' => 'first_name', - '4' => 'last_name', - '5' => 'email', - '6' => 'phone_numeric', - '7' => 'street_address', - '8' => 'city', - '9' => 'postal_code', - '10' => 'job_title', - ], - 'add' => '5.8', - 'title' => 'Quicksearch options', - 'is_domain' => '1', - 'is_contact' => 0, - 'description' => 'Which fields can be searched on in the menubar quicksearch box? Don\'t see your custom field here? Make sure it is marked as Searchable.', - 'help_text' => '', - ], - 'default_pager_size' => [ - 'group_name' => 'Search Preferences', - 'group' => 'Search Preferences', - 'name' => 'default_pager_size', - 'type' => 'Integer', - 'quick_form_type' => 'Element', - 'html_type' => 'text', - 'html_attributes' => [ - 'size' => 2, - 'maxlength' => 3, - ], - 'default' => 50, - 'add' => '5.39', - 'title' => 'Default Search Pager size', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'What is the default number of records to show on a search', - 'help_text' => '', - ], - 'userFrameworkResourceURL' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group' => 'url', - 'group_name' => 'URL Preferences', - 'name' => 'userFrameworkResourceURL', - 'title' => 'CiviCRM Resource URL', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Absolute URL of the location where the civicrm module or component has been installed.', - 'help_text' => '', - 'validate_callback' => 'CRM_Utils_Rule::urlish', - ], - 'imageUploadURL' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group' => 'url', - 'group_name' => 'URL Preferences', - 'title' => 'Image Upload URL', - 'name' => 'imageUploadURL', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'URL of the location for uploaded image files.', - 'help_text' => '', - 'validate_callback' => 'CRM_Utils_Rule::urlish', - ], - 'customCSSURL' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group' => 'url', - 'group_name' => 'URL Preferences', - 'name' => 'customCSSURL', - 'title' => 'Custom CSS URL', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'You can modify the look and feel of CiviCRM by adding your own stylesheet. For small to medium sized modifications, use your css file to override some of the styles in civicrm.css. Or if you need to make drastic changes, you can choose to disable civicrm.css completely.', - 'help_text' => '', - 'validate_callback' => 'CRM_Utils_Rule::urlish', - ], - 'extensionsURL' => [ - 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().', - 'group' => 'url', - 'group_name' => 'URL Preferences', - 'title' => 'Extension Resource URL', - 'name' => 'extensionsURL', - 'type' => 'String', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'default' => '', - 'add' => '4.1', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Base URL for extension resources (images, stylesheets, etc). This should match extensionsDir.', - 'help_text' => '', - 'validate_callback' => 'CRM_Utils_Rule::urlish', - ], - 'enable_cart' => [ - 'name' => 'enable_cart', - 'group_name' => 'Event Preferences', - 'settings_pages' => [ - 'event' => [ - 'weight' => 10, - ], - ], - 'group' => 'event', - 'type' => 'Boolean', - 'quick_form_type' => 'CheckBox', - 'default' => 0, - 'add' => '4.1', - 'title' => 'Use Shopping Cart Style Event Registration', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'This feature allows users to register for more than one event at a time. When enabled, users will add event(s) to a \"cart\" and then pay for them all at once. Enabling this setting will affect online registration for all active events. The code is an alpha state, and you will potentially need to have developer resources to debug and fix sections of the codebase while testing and deploying it', - 'help_text' => '', - 'documentation_link' => [ - 'page' => 'CiviEvent Cart Checkout', - 'resource' => 'wiki', - ], - ], - 'acl_financial_type' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'acl_financial_type', - 'type' => 'Boolean', - 'html_type' => 'checkbox', - 'quick_form_type' => 'Element', - 'default' => 0, - 'add' => '4.7', - 'title' => 'Enable Access Control by Financial Type', - 'is_domain' => 1, - 'is_contact' => 0, - 'help_text' => '', - 'help' => [ - 'id' => 'acl_financial_type', - ], - 'settings_pages' => [ - 'contribute' => [ - 'weight' => 30, - ], - ], - 'on_change' => [ - '0' => 'financialacls_toggle', - ], - ], - 'recaptchaPublicKey' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'recaptchaPublicKey', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 64, - ], - 'html_type' => 'text', - 'default' => '', - 'add' => '4.3', - 'title' => 'reCAPTCHA Site Key', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - 'settings_pages' => [ - 'recaptcha' => [ - 'weight' => 10, - ], - ], - ], - 'recaptchaPrivateKey' => [ - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'recaptchaPrivateKey', - 'type' => 'String', - 'quick_form_type' => 'Element', - 'html_attributes' => [ - 'size' => 64, - 'maxlength' => 64, - ], - 'html_type' => 'text', - 'default' => '', - 'add' => '4.3', - 'title' => 'reCAPTCHA Secret Key', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => '', - 'help_text' => '', - 'settings_pages' => [ - 'recaptcha' => [ - 'weight' => 10, - ], - ], - ], - 'forceRecaptcha' => [ - 'add' => '4.7', - 'help_text' => '', - 'is_domain' => 1, - 'is_contact' => 0, - 'group_name' => 'CiviCRM Preferences', - 'group' => 'core', - 'name' => 'forceRecaptcha', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'html_type' => '', - 'default' => 0, - 'title' => 'Force reCAPTCHA on Contribution pages', - 'description' => 'If enabled, reCAPTCHA will show on all contribution pages.', - 'settings_pages' => [ - 'recaptcha' => [ - 'weight' => 10, - ], - ], - ], - 'credit_notes_prefix' => [ - 'group_name' => 'Contribute Preferences', - 'group' => 'contribute', - 'name' => 'credit_notes_prefix', - 'html_type' => 'text', - 'quick_form_type' => 'Element', - 'add' => '5.23', - 'type' => 2, - 'title' => 'Credit Notes Prefix', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Prefix to be prepended to credit note ids', - 'default' => 'CN_', - 'help_text' => 'The credit note ID is generated when a contribution is set to Refunded, Cancelled or Chargeback. It is visible on invoices, if invoices are enabled', - 'settings_pages' => [ - 'contribute' => [ - 'weight' => 80, - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetFields" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/GetSettingCurrentDomain.ex.php b/api/v3/examples/Setting/GetSettingCurrentDomain.ex.php deleted file mode 100644 index b24dd50b40..0000000000 --- a/api/v3/examples/Setting/GetSettingCurrentDomain.ex.php +++ /dev/null @@ -1,82 +0,0 @@ - 'uniq_email_per_site', - ]; - - try { - $result = civicrm_api3('Setting', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'uniq_email_per_site' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetSetting" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/GetSpecifiedDomains.ex.php b/api/v3/examples/Setting/GetSpecifiedDomains.ex.php deleted file mode 100644 index e5b6f83f62..0000000000 --- a/api/v3/examples/Setting/GetSpecifiedDomains.ex.php +++ /dev/null @@ -1,90 +0,0 @@ - [ - '0' => 1, - '1' => 37, - ], - 'return' => [ - '0' => 'uniq_email_per_site', - ], - ]; - - try { - $result = civicrm_api3('Setting', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 2, - 'values' => [ - '1' => [ - 'uniq_email_per_site' => 0, - ], - '37' => [ - 'uniq_email_per_site' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSettingMultipleDomains" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/GetValue.ex.php b/api/v3/examples/Setting/GetValue.ex.php deleted file mode 100644 index 9125ca5256..0000000000 --- a/api/v3/examples/Setting/GetValue.ex.php +++ /dev/null @@ -1,73 +0,0 @@ - 'petition_contacts', - 'group' => 'Campaign Preferences', - ]; - - try { - $result = civicrm_api3('Setting', 'getvalue', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_getvalue_expectedresult() { - - $expectedResult = 'Petition Contacts'; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetValue" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Setting/Revert.ex.php b/api/v3/examples/Setting/Revert.ex.php deleted file mode 100644 index 5d414f9631..0000000000 --- a/api/v3/examples/Setting/Revert.ex.php +++ /dev/null @@ -1,94 +0,0 @@ - 'address_format', - ]; - - try { - $result = civicrm_api3('Setting', 'revert', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function setting_revert_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 5, - 'id' => 1, - 'values' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'address_format' => '{contact.address_name} -{contact.street_address} -{contact.supplemental_address_1} -{contact.supplemental_address_2} -{contact.supplemental_address_3} -{contact.city}{, }{contact.state_province}{ }{contact.postal_code} -{contact.country}', - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testRevert" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/StateProvince/Create.ex.php b/api/v3/examples/StateProvince/Create.ex.php deleted file mode 100644 index 2d07ecf6b2..0000000000 --- a/api/v3/examples/StateProvince/Create.ex.php +++ /dev/null @@ -1,86 +0,0 @@ - 'Wessex', - 'abbreviation' => 'WEX', - 'country_id' => 1226, - ]; - - try { - $result = civicrm_api3('StateProvince', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function state_province_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 14064, - 'values' => [ - '14064' => [ - 'id' => '14064', - 'name' => 'Wessex', - 'abbreviation' => 'WEX', - 'country_id' => '1226', - 'is_active' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateStateProvince" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/StateProvinceTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/StateProvince/Delete.ex.php b/api/v3/examples/StateProvince/Delete.ex.php deleted file mode 100644 index c51a5a0e69..0000000000 --- a/api/v3/examples/StateProvince/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 14066, - ]; - - try { - $result = civicrm_api3('StateProvince', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function state_province_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteStateProvince" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/StateProvinceTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/StateProvince/Get.ex.php b/api/v3/examples/StateProvince/Get.ex.php deleted file mode 100644 index 18d2a9ce4a..0000000000 --- a/api/v3/examples/StateProvince/Get.ex.php +++ /dev/null @@ -1,84 +0,0 @@ - 'Wessex', - ]; - - try { - $result = civicrm_api3('StateProvince', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function state_province_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 14068, - 'values' => [ - '14068' => [ - 'id' => '14068', - 'name' => 'Wessex', - 'abbreviation' => 'WEX', - 'country_id' => '1226', - 'is_active' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/StateProvinceTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/StatusPreference/Create.ex.php b/api/v3/examples/StatusPreference/Create.ex.php deleted file mode 100644 index 6eb9b4525d..0000000000 --- a/api/v3/examples/StatusPreference/Create.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - 'test_check', - 'domain_id' => 1, - 'hush_until' => '20151212', - 'ignore_severity' => 'cRItical', - 'check_info' => '', - ]; - - try { - $result = civicrm_api3('StatusPreference', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function status_preference_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 7, - 'values' => [ - '7' => [ - 'id' => '7', - 'domain_id' => '1', - 'name' => 'test_check', - 'hush_until' => '20151212000000', - 'ignore_severity' => '5', - 'prefs' => '', - 'check_info' => '', - 'is_active' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSeverityByName" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/StatusPreferenceTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/StatusPreference/Delete.ex.php b/api/v3/examples/StatusPreference/Delete.ex.php deleted file mode 100644 index a4582c6eec..0000000000 --- a/api/v3/examples/StatusPreference/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('StatusPreference', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function status_preference_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteStatusPreference" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/StatusPreferenceTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/StatusPreference/Get.ex.php b/api/v3/examples/StatusPreference/Get.ex.php deleted file mode 100644 index f94a270575..0000000000 --- a/api/v3/examples/StatusPreference/Get.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 5, - ]; - - try { - $result = civicrm_api3('StatusPreference', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function status_preference_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 5, - 'values' => [ - '5' => [ - 'id' => '5', - 'domain_id' => '1', - 'name' => 'test_check', - 'hush_until' => '2015-12-12', - 'ignore_severity' => '4', - 'is_active' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testStatusPreferenceGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/StatusPreferenceTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Survey/ChainedGetDelete.ex.php b/api/v3/examples/Survey/ChainedGetDelete.ex.php deleted file mode 100644 index 4a24b150d9..0000000000 --- a/api/v3/examples/Survey/ChainedGetDelete.ex.php +++ /dev/null @@ -1,98 +0,0 @@ - 'survey title', - 'api.survey.delete' => 1, - ]; - - try { - $result = civicrm_api3('Survey', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function survey_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 4, - 'values' => [ - '4' => [ - 'id' => '4', - 'title' => 'survey title', - 'activity_type_id' => '30', - 'instructions' => 'Call people, ask for money', - 'max_number_of_contacts' => '12', - 'is_active' => '1', - 'is_default' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'bypass_confirm' => 0, - 'is_share' => '1', - 'api.survey.delete' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetSurveyChainDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SurveyTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Survey/Create.ex.php b/api/v3/examples/Survey/Create.ex.php deleted file mode 100644 index ef2eba60f4..0000000000 --- a/api/v3/examples/Survey/Create.ex.php +++ /dev/null @@ -1,102 +0,0 @@ - 'survey title', - 'activity_type_id' => '30', - 'max_number_of_contacts' => 12, - 'instructions' => 'Call people, ask for money', - ]; - - try { - $result = civicrm_api3('Survey', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function survey_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'title' => 'survey title', - 'campaign_id' => '', - 'activity_type_id' => '30', - 'recontact_interval' => '', - 'instructions' => 'Call people, ask for money', - 'release_frequency' => '', - 'max_number_of_contacts' => '12', - 'default_number_of_contacts' => '', - 'is_active' => '', - 'is_default' => '', - 'created_id' => '', - 'created_date' => '2013-07-28 08:49:19', - 'last_modified_id' => '', - 'last_modified_date' => '', - 'result_id' => '', - 'bypass_confirm' => '', - 'thankyou_title' => '', - 'thankyou_text' => '', - 'is_share' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSurvey" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SurveyTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Survey/Delete.ex.php b/api/v3/examples/Survey/Delete.ex.php deleted file mode 100644 index b93ad2be83..0000000000 --- a/api/v3/examples/Survey/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 3, - ]; - - try { - $result = civicrm_api3('Survey', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function survey_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteSurvey" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SurveyTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Survey/Get.ex.php b/api/v3/examples/Survey/Get.ex.php deleted file mode 100644 index 06a257139e..0000000000 --- a/api/v3/examples/Survey/Get.ex.php +++ /dev/null @@ -1,92 +0,0 @@ - 'survey title', - 'activity_type_id' => '30', - 'max_number_of_contacts' => 12, - 'instructions' => 'Call people, ask for money', - ]; - - try { - $result = civicrm_api3('Survey', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function survey_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'title' => 'survey title', - 'activity_type_id' => '30', - 'instructions' => 'Call people, ask for money', - 'max_number_of_contacts' => '12', - 'is_active' => '1', - 'is_default' => 0, - 'created_date' => '2013-07-28 08:49:19', - 'bypass_confirm' => 0, - 'is_share' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetSurvey" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SurveyTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/SurveyRespondant/Get.ex.php b/api/v3/examples/SurveyRespondant/Get.ex.php deleted file mode 100644 index 87ad6fa333..0000000000 --- a/api/v3/examples/SurveyRespondant/Get.ex.php +++ /dev/null @@ -1,80 +0,0 @@ - '1', - 'survey_id' => 1, - ]; - - try { - $result = civicrm_api3('SurveyRespondant', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function survey_respondant_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => [], - 'deprecated' => 'The SurveyRespondant api is not currently supported.', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetSurveyRespondants" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SurveyRespondantTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/System/Flush.ex.php b/api/v3/examples/System/Flush.ex.php deleted file mode 100644 index 5e9f8acbdd..0000000000 --- a/api/v3/examples/System/Flush.ex.php +++ /dev/null @@ -1,75 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function system_flush_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testFlush" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SystemTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Tag/Create.ex.php b/api/v3/examples/Tag/Create.ex.php deleted file mode 100644 index 92da15c578..0000000000 --- a/api/v3/examples/Tag/Create.ex.php +++ /dev/null @@ -1,91 +0,0 @@ - 'Super Heros', - 'description' => 'Outside undie-wearers', - ]; - - try { - $result = civicrm_api3('Tag', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tag_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 17, - 'values' => [ - '17' => [ - 'id' => '17', - 'name' => 'Super Heros', - 'description' => 'Outside undie-wearers', - 'parent_id' => '', - 'is_selectable' => '', - 'is_reserved' => '', - 'is_tagset' => '', - 'used_for' => 'civicrm_contact', - 'created_id' => '', - 'color' => '', - 'created_date' => '2013-07-28 08:49:19', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Tag/Delete.ex.php b/api/v3/examples/Tag/Delete.ex.php deleted file mode 100644 index a00738ac35..0000000000 --- a/api/v3/examples/Tag/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - '24', - ]; - - try { - $result = civicrm_api3('Tag', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tag_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testTagDeleteCorrectSyntax" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Tag/Get.ex.php b/api/v3/examples/Tag/Get.ex.php deleted file mode 100644 index f2d1b724b6..0000000000 --- a/api/v3/examples/Tag/Get.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - '8', - 'name' => 'New Tag3', - ]; - - try { - $result = civicrm_api3('Tag', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tag_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 8, - 'values' => [ - '8' => [ - 'id' => '8', - 'name' => 'New Tag3', - 'description' => 'This is description for Our New Tag ', - 'is_selectable' => '1', - 'is_reserved' => 0, - 'is_tagset' => 0, - 'used_for' => 'civicrm_contact', - 'created_date' => '2013-07-28 08:49:19', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Tag/GetFields.ex.php b/api/v3/examples/Tag/GetFields.ex.php deleted file mode 100644 index c754b5a433..0000000000 --- a/api/v3/examples/Tag/GetFields.ex.php +++ /dev/null @@ -1,269 +0,0 @@ - 'create', - ]; - - try { - $result = civicrm_api3('Tag', 'getfields', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tag_getfields_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 11, - 'values' => [ - 'id' => [ - 'name' => 'id', - 'type' => 1, - 'title' => 'Tag ID', - 'description' => 'Tag ID', - 'required' => TRUE, - 'where' => 'civicrm_tag.id', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'html' => [ - 'type' => 'Number', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.aliases' => [ - '0' => 'tag', - ], - ], - 'name' => [ - 'name' => 'name', - 'type' => 2, - 'title' => 'Tag Name', - 'description' => 'Name of Tag.', - 'required' => TRUE, - 'maxlength' => 64, - 'size' => 30, - 'where' => 'civicrm_tag.name', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'add' => '1.1', - 'is_core_field' => TRUE, - 'api.required' => 1, - ], - 'description' => [ - 'name' => 'description', - 'type' => 2, - 'title' => 'Description', - 'description' => 'Optional verbose description of the tag.', - 'maxlength' => 255, - 'size' => 45, - 'where' => 'civicrm_tag.description', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'add' => '1.1', - 'is_core_field' => TRUE, - ], - 'parent_id' => [ - 'name' => 'parent_id', - 'type' => 1, - 'title' => 'Parent Tag ID', - 'description' => 'Optional parent id for this tag.', - 'where' => 'civicrm_tag.parent_id', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'FKClassName' => 'CRM_Core_DAO_Tag', - 'html' => [ - 'label' => 'Parent Tag', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'table' => 'civicrm_tag', - 'keyColumn' => 'id', - 'labelColumn' => 'name', - ], - 'add' => '1.1', - 'is_core_field' => TRUE, - 'FKApiName' => 'Tag', - ], - 'is_selectable' => [ - 'name' => 'is_selectable', - 'type' => 16, - 'title' => 'Display Tag?', - 'description' => 'Is this tag selectable / displayed', - 'where' => 'civicrm_tag.is_selectable', - 'default' => '1', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'add' => '2.1', - 'is_core_field' => TRUE, - ], - 'is_reserved' => [ - 'name' => 'is_reserved', - 'type' => 16, - 'title' => 'Reserved', - 'where' => 'civicrm_tag.is_reserved', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'add' => '3.2', - 'is_core_field' => TRUE, - ], - 'is_tagset' => [ - 'name' => 'is_tagset', - 'type' => 16, - 'title' => 'Tagset', - 'where' => 'civicrm_tag.is_tagset', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'add' => '3.2', - 'is_core_field' => TRUE, - ], - 'used_for' => [ - 'name' => 'used_for', - 'type' => 2, - 'title' => 'Used For', - 'maxlength' => 64, - 'size' => 30, - 'where' => 'civicrm_tag.used_for', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'serialize' => 5, - 'html' => [ - 'type' => 'Select', - 'maxlength' => 64, - 'size' => 30, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'tag_used_for', - 'optionEditPath' => 'civicrm/admin/options/tag_used_for', - ], - 'add' => '3.2', - 'is_core_field' => TRUE, - 'api.default' => 'civicrm_contact', - ], - 'created_id' => [ - 'name' => 'created_id', - 'type' => 1, - 'title' => 'Created By Contact ID', - 'description' => 'FK to civicrm_contact, who created this tag', - 'where' => 'civicrm_tag.created_id', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'html' => [ - 'label' => 'Created By', - 'size' => 6, - 'maxlength' => 14, - ], - 'add' => '3.4', - 'is_core_field' => TRUE, - 'FKApiName' => 'Contact', - ], - 'color' => [ - 'name' => 'color', - 'type' => 2, - 'title' => 'Color', - 'description' => 'Hex color value e.g. #ffffff', - 'maxlength' => 255, - 'size' => 45, - 'where' => 'civicrm_tag.color', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'add' => '4.7', - 'is_core_field' => TRUE, - ], - 'created_date' => [ - 'name' => 'created_date', - 'type' => 12, - 'title' => 'Tag Created Date', - 'description' => 'Date and time that tag was created.', - 'where' => 'civicrm_tag.created_date', - 'table_name' => 'civicrm_tag', - 'entity' => 'Tag', - 'bao' => 'CRM_Core_BAO_Tag', - 'localizable' => 0, - 'add' => '3.4', - 'is_core_field' => TRUE, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testTagGetfields" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Tag/GetList.ex.php b/api/v3/examples/Tag/GetList.ex.php deleted file mode 100644 index d5f540c033..0000000000 --- a/api/v3/examples/Tag/GetList.ex.php +++ /dev/null @@ -1,94 +0,0 @@ - 'New Tag3', - 'extra' => [ - '0' => 'used_for', - ], - ]; - - try { - $result = civicrm_api3('Tag', 'getlist', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tag_getlist_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 0, - 'values' => [ - '0' => [ - 'id' => '27', - 'label' => 'New Tag3', - 'description' => [ - '0' => 'This is description for Our New Tag ', - ], - 'extra' => [ - 'used_for' => 'civicrm_contact', - ], - ], - ], - 'page_num' => 1, - 'more_results' => '', - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testTagGetList" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Tag/GetReturnArray.ex.php b/api/v3/examples/Tag/GetReturnArray.ex.php deleted file mode 100644 index d5518b1e7e..0000000000 --- a/api/v3/examples/Tag/GetReturnArray.ex.php +++ /dev/null @@ -1,87 +0,0 @@ - '10', - 'name' => 'New Tag3', - 'return' => [ - '0' => 'name', - ], - ]; - - try { - $result = civicrm_api3('Tag', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tag_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 10, - 'values' => [ - '10' => [ - 'id' => '10', - 'name' => 'New Tag3', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetReturnArray" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/TaxContributionPage/Create.ex.php b/api/v3/examples/TaxContributionPage/Create.ex.php deleted file mode 100644 index 5c48e3b6be..0000000000 --- a/api/v3/examples/TaxContributionPage/Create.ex.php +++ /dev/null @@ -1,116 +0,0 @@ - 1, - 'receive_date' => '20120511', - 'total_amount' => '100', - 'financial_type_id' => 11, - 'contribution_page_id' => 1, - 'trxn_id' => 12345, - 'invoice_id' => 67890, - 'source' => 'SSF', - 'contribution_status_id' => 2, - ]; - - try { - $result = civicrm_api3('tax_contribution_page', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tax_contribution_page_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '1', - 'financial_type_id' => '11', - 'contribution_page_id' => '1', - 'payment_instrument_id' => '4', - 'receive_date' => '20120511000000', - 'non_deductible_amount' => '', - 'total_amount' => '120', - 'fee_amount' => 0, - 'net_amount' => '120', - 'trxn_id' => '12345', - 'invoice_id' => '67890', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '2', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => '20', - 'contribution_type_id' => '11', - ], - ], - ]; - - return $expectedResult; -} - -/** -* This example has been generated from the API test suite. -* The test that created it is called -* testCreateContributionPendingOnline -* and can be found in -* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TaxContributionPageTest.php. -* -* You can see the outcome of the API tests at -* https://test.civicrm.org/job/CiviCRM-master-git/ -* -* To Learn about the API read -* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API -* -* Browse the api on your own site with the api explorer -* http://MYSITE.ORG/path/to/civicrm/api -* -* Read more about testing here -* http://wiki.civicrm.org/confluence/display/CRM/Testing -* -* API Standards documentation: -* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards -*/ diff --git a/api/v3/examples/TaxContributionPage/CreateWithNestedLineItems.ex.php b/api/v3/examples/TaxContributionPage/CreateWithNestedLineItems.ex.php deleted file mode 100644 index d71a6e2751..0000000000 --- a/api/v3/examples/TaxContributionPage/CreateWithNestedLineItems.ex.php +++ /dev/null @@ -1,192 +0,0 @@ - 1, - 'receive_date' => '20120511', - 'total_amount' => '400', - 'financial_type_id' => 7, - 'trxn_id' => 12345, - 'invoice_id' => 67890, - 'source' => 'SSF', - 'contribution_status_id' => 1, - 'skipLineItem' => 1, - 'api.line_item.create' => [ - '0' => [ - 'price_field_id' => [ - '0' => 3, - ], - 'qty' => 1, - 'line_total' => '100', - 'unit_price' => '100', - 'financial_type_id' => 7, - ], - '1' => [ - 'price_field_id' => [ - '0' => 3, - ], - 'qty' => 1, - 'line_total' => '300', - 'unit_price' => '300', - 'financial_type_id' => 8, - ], - ], - ]; - - try { - $result = civicrm_api3('tax_contribution_page', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tax_contribution_page_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '1', - 'financial_type_id' => '7', - 'contribution_page_id' => '', - 'payment_instrument_id' => '4', - 'receive_date' => '20120511000000', - 'non_deductible_amount' => '', - 'total_amount' => '435', - 'fee_amount' => 0, - 'net_amount' => '435', - 'trxn_id' => '12345', - 'invoice_id' => '67890', - 'currency' => 'USD', - 'cancel_date' => '', - 'cancel_reason' => '', - 'receipt_date' => '', - 'thankyou_date' => '', - 'source' => 'SSF', - 'amount_level' => '', - 'contribution_recur_id' => '', - 'is_test' => '', - 'is_pay_later' => '', - 'contribution_status_id' => '1', - 'address_id' => '', - 'check_number' => '', - 'campaign_id' => '', - 'creditnote_id' => '', - 'tax_amount' => '35', - 'contribution_type_id' => '7', - 'api.line_item.create' => [ - '0' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'entity_table' => 'civicrm_contribution', - 'entity_id' => '1', - 'contribution_id' => '1', - 'price_field_id' => [ - '0' => '3', - ], - 'label' => 'line item', - 'qty' => '1', - 'unit_price' => '100', - 'line_total' => '100', - 'participant_count' => '', - 'price_field_value_id' => '', - 'financial_type_id' => '7', - 'deductible_amount' => '', - 'tax_amount' => '20', - ], - ], - ], - '1' => [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '0' => [ - 'id' => '2', - 'entity_table' => 'civicrm_contribution', - 'entity_id' => '1', - 'contribution_id' => '1', - 'price_field_id' => [ - '0' => '3', - ], - 'label' => 'line item', - 'qty' => '1', - 'unit_price' => '300', - 'line_total' => '300', - 'participant_count' => '', - 'price_field_value_id' => '', - 'financial_type_id' => '8', - 'deductible_amount' => '', - 'tax_amount' => '15', - ], - ], - ], - ], - ], - ], - ]; - - return $expectedResult; -} - -/** -* This example has been generated from the API test suite. -* The test that created it is called -* testCreateContributionChainedLineItems -* and can be found in -* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TaxContributionPageTest.php. -* -* You can see the outcome of the API tests at -* https://test.civicrm.org/job/CiviCRM-master-git/ -* -* To Learn about the API read -* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API -* -* Browse the api on your own site with the api explorer -* http://MYSITE.ORG/path/to/civicrm/api -* -* Read more about testing here -* http://wiki.civicrm.org/confluence/display/CRM/Testing -* -* API Standards documentation: -* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards -*/ diff --git a/api/v3/examples/TaxContributionPage/Delete.ex.php b/api/v3/examples/TaxContributionPage/Delete.ex.php deleted file mode 100644 index aab88461c9..0000000000 --- a/api/v3/examples/TaxContributionPage/Delete.ex.php +++ /dev/null @@ -1,78 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('tax_contribution_page', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'error' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function tax_contribution_page_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => 1, - ], - ]; - - return $expectedResult; -} - -/** -* This example has been generated from the API test suite. -* The test that created it is called -* testDeleteContribution -* and can be found in -* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TaxContributionPageTest.php. -* -* You can see the outcome of the API tests at -* https://test.civicrm.org/job/CiviCRM-master-git/ -* -* To Learn about the API read -* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API -* -* Browse the api on your own site with the api explorer -* http://MYSITE.ORG/path/to/civicrm/api -* -* Read more about testing here -* http://wiki.civicrm.org/confluence/display/CRM/Testing -* -* API Standards documentation: -* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards -*/ diff --git a/api/v3/examples/UFField/Create.ex.php b/api/v3/examples/UFField/Create.ex.php deleted file mode 100644 index 79587ab169..0000000000 --- a/api/v3/examples/UFField/Create.ex.php +++ /dev/null @@ -1,107 +0,0 @@ - 'phone', - 'field_type' => 'Contact', - 'visibility' => 'Public Pages and Listings', - 'weight' => 1, - 'label' => 'Test Phone', - 'is_searchable' => 1, - 'is_active' => 1, - 'location_type_id' => 1, - 'phone_type_id' => 1, - 'uf_group_id' => 11, - ]; - - try { - $result = civicrm_api3('UFField', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_field_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'uf_group_id' => '11', - 'field_name' => 'phone', - 'is_active' => '1', - 'is_view' => '', - 'is_required' => '', - 'weight' => '1', - 'help_post' => '', - 'help_pre' => '', - 'visibility' => 'Public Pages and Listings', - 'in_selector' => '', - 'is_searchable' => '1', - 'location_type_id' => '1', - 'phone_type_id' => '1', - 'website_type_id' => '', - 'label' => 'Test Phone', - 'field_type' => 'Contact', - 'is_reserved' => '', - 'is_multi_summary' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateUFField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFField/Delete.ex.php b/api/v3/examples/UFField/Delete.ex.php deleted file mode 100644 index 8b441b82de..0000000000 --- a/api/v3/examples/UFField/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 1, - ]; - - try { - $result = civicrm_api3('UFField', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_field_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => TRUE, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteUFField" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFField/Get.ex.php b/api/v3/examples/UFField/Get.ex.php deleted file mode 100644 index 7ed1b1546f..0000000000 --- a/api/v3/examples/UFField/Get.ex.php +++ /dev/null @@ -1,92 +0,0 @@ -getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_field_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'uf_group_id' => '11', - 'field_name' => 'phone', - 'is_active' => '1', - 'is_view' => 0, - 'is_required' => 0, - 'weight' => '1', - 'visibility' => 'Public Pages and Listings', - 'in_selector' => 0, - 'is_searchable' => '1', - 'location_type_id' => '1', - 'phone_type_id' => '1', - 'label' => 'Test Phone', - 'field_type' => 'Contact', - 'is_multi_summary' => 0, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetUFFieldSuccess" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFField/Replace.ex.php b/api/v3/examples/UFField/Replace.ex.php deleted file mode 100644 index a3da0d3a30..0000000000 --- a/api/v3/examples/UFField/Replace.ex.php +++ /dev/null @@ -1,173 +0,0 @@ - 11, - 'option.autoweight' => '', - 'values' => [ - '0' => [ - 'field_name' => 'first_name', - 'field_type' => 'Contact', - 'visibility' => 'Public Pages and Listings', - 'weight' => 3, - 'label' => 'Test First Name', - 'is_searchable' => 1, - 'is_active' => 1, - ], - '1' => [ - 'field_name' => 'country', - 'field_type' => 'Contact', - 'visibility' => 'Public Pages and Listings', - 'weight' => 2, - 'label' => 'Test Country', - 'is_searchable' => 1, - 'is_active' => 1, - 'location_type_id' => 1, - ], - '2' => [ - 'field_name' => 'phone', - 'field_type' => 'Contact', - 'visibility' => 'Public Pages and Listings', - 'weight' => 1, - 'label' => 'Test Phone', - 'is_searchable' => 1, - 'is_active' => 1, - 'location_type_id' => 1, - 'phone_type_id' => 1, - ], - ], - 'check_permissions' => TRUE, - ]; - - try { - $result = civicrm_api3('UFField', 'replace', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_field_replace_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 3, - 'values' => [ - '1' => [ - 'id' => '1', - 'uf_group_id' => '11', - 'field_name' => 'first_name', - 'is_active' => '1', - 'is_view' => '', - 'is_required' => '', - 'weight' => '3', - 'help_post' => '', - 'help_pre' => '', - 'visibility' => 'Public Pages and Listings', - 'in_selector' => '', - 'is_searchable' => '1', - 'location_type_id' => '', - 'phone_type_id' => '', - 'website_type_id' => '', - 'label' => 'Test First Name', - 'field_type' => 'Contact', - 'is_reserved' => '', - 'is_multi_summary' => '', - ], - '2' => [ - 'id' => '2', - 'uf_group_id' => '11', - 'field_name' => 'country', - 'is_active' => '1', - 'is_view' => '', - 'is_required' => '', - 'weight' => '2', - 'help_post' => '', - 'help_pre' => '', - 'visibility' => 'Public Pages and Listings', - 'in_selector' => '', - 'is_searchable' => '1', - 'location_type_id' => '1', - 'phone_type_id' => '', - 'website_type_id' => '', - 'label' => 'Test Country', - 'field_type' => 'Contact', - 'is_reserved' => '', - 'is_multi_summary' => '', - ], - '3' => [ - 'id' => '3', - 'uf_group_id' => '11', - 'field_name' => 'phone', - 'is_active' => '1', - 'is_view' => '', - 'is_required' => '', - 'weight' => '1', - 'help_post' => '', - 'help_pre' => '', - 'visibility' => 'Public Pages and Listings', - 'in_selector' => '', - 'is_searchable' => '1', - 'location_type_id' => '1', - 'phone_type_id' => '1', - 'website_type_id' => '', - 'label' => 'Test Phone', - 'field_type' => 'Contact', - 'is_reserved' => '', - 'is_multi_summary' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testReplaceUFFields" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFFieldTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFGroup/Create.ex.php b/api/v3/examples/UFGroup/Create.ex.php deleted file mode 100644 index baab92ae8c..0000000000 --- a/api/v3/examples/UFGroup/Create.ex.php +++ /dev/null @@ -1,125 +0,0 @@ - 1, - 'add_contact_to_group' => 1, - 'group' => 1, - 'cancel_url' => 'http://example.org/cancel', - 'created_date' => '2009-06-27 00:00:00', - 'created_id' => 1, - 'group_type' => 'Individual,Contact', - 'help_post' => 'help post', - 'help_pre' => 'help pre', - 'is_active' => 0, - 'is_cms_user' => 1, - 'is_edit_link' => 1, - 'is_map' => 1, - 'is_reserved' => 1, - 'is_uf_link' => 1, - 'is_update_dupe' => 1, - 'name' => 'Test_Group', - 'notify' => 'admin@example.org', - 'post_url' => 'http://example.org/post', - 'title' => 'Test Group', - ]; - - try { - $result = civicrm_api3('UFGroup', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_group_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'is_active' => 0, - 'group_type' => 'Individual,Contact', - 'title' => 'Test Group', - 'frontend_title' => '', - 'description' => '', - 'help_pre' => 'help pre', - 'help_post' => 'help post', - 'limit_listings_group_id' => '1', - 'post_url' => 'http://example.org/post', - 'add_to_group_id' => '1', - 'add_captcha' => '1', - 'is_map' => '1', - 'is_edit_link' => '1', - 'is_uf_link' => '1', - 'is_update_dupe' => '1', - 'cancel_url' => 'http://example.org/cancel', - 'is_cms_user' => '1', - 'notify' => 'admin@example.org', - 'is_reserved' => '1', - 'name' => 'Test_Group', - 'created_id' => '1', - 'created_date' => '2013-07-28 08:49:19', - 'is_proximity_search' => '', - 'cancel_button_text' => '', - 'submit_button_text' => '', - 'add_cancel_button' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testUFGroupCreate" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFGroup/Delete.ex.php b/api/v3/examples/UFGroup/Delete.ex.php deleted file mode 100644 index a1745bfb89..0000000000 --- a/api/v3/examples/UFGroup/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 2, - ]; - - try { - $result = civicrm_api3('UFGroup', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_group_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testUFGroupDelete" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFGroup/Get.ex.php b/api/v3/examples/UFGroup/Get.ex.php deleted file mode 100644 index 274b7c0c46..0000000000 --- a/api/v3/examples/UFGroup/Get.ex.php +++ /dev/null @@ -1,102 +0,0 @@ - 2, - ]; - - try { - $result = civicrm_api3('UFGroup', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_group_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 2, - 'values' => [ - '2' => [ - 'id' => '2', - 'is_active' => 0, - 'group_type' => 'Individual,Contact', - 'title' => 'Test Group', - 'help_pre' => 'help pre', - 'help_post' => 'help post', - 'limit_listings_group_id' => '1', - 'post_url' => 'http://example.org/post', - 'add_to_group_id' => '1', - 'add_captcha' => '1', - 'is_map' => '1', - 'is_edit_link' => '1', - 'is_uf_link' => '1', - 'is_update_dupe' => '1', - 'cancel_URL' => 'http://example.org/cancel', - 'is_cms_user' => '1', - 'notify' => 'admin@example.org', - 'is_reserved' => '1', - 'name' => 'Test_Group', - 'created_id' => '1', - 'created_date' => '2013-07-28 08:49:19', - 'is_proximity_search' => 0, - 'add_cancel_button' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testUFGroupGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFGroupTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFJoin/Create.ex.php b/api/v3/examples/UFJoin/Create.ex.php deleted file mode 100644 index 52fcc0975b..0000000000 --- a/api/v3/examples/UFJoin/Create.ex.php +++ /dev/null @@ -1,93 +0,0 @@ - 'CiviCampaign', - 'entity_table' => 'civicrm_survey', - 'entity_id' => 1, - 'weight' => 1, - 'uf_group_id' => 11, - 'is_active' => 1, - 'sequential' => 1, - ]; - - try { - $result = civicrm_api3('UFJoin', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_join_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 0, - 'values' => [ - '0' => [ - 'id' => '1', - 'is_active' => '1', - 'module' => 'CiviCampaign', - 'entity_table' => 'civicrm_survey', - 'entity_id' => '1', - 'weight' => '1', - 'uf_group_id' => '11', - 'module_data' => '', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateSurveyUFJoin" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFJoinTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFJoin/Get.ex.php b/api/v3/examples/UFJoin/Get.ex.php deleted file mode 100644 index 50ea381ebb..0000000000 --- a/api/v3/examples/UFJoin/Get.ex.php +++ /dev/null @@ -1,88 +0,0 @@ - 'civicrm_contribution_page', - 'entity_id' => 1, - 'sequential' => 1, - ]; - - try { - $result = civicrm_api3('UFJoin', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_join_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '0' => [ - 'id' => '1', - 'is_active' => '1', - 'module' => 'CiviContribute', - 'entity_table' => 'civicrm_contribution_page', - 'entity_id' => '1', - 'weight' => '1', - 'uf_group_id' => '11', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetUFJoinId" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFJoinTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/UFMatch/Get.ex.php b/api/v3/examples/UFMatch/Get.ex.php deleted file mode 100644 index d4d6e24c19..0000000000 --- a/api/v3/examples/UFMatch/Get.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 69, - ]; - - try { - $result = civicrm_api3('UFMatch', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function uf_match_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'domain_id' => '1', - 'uf_id' => '42', - 'contact_id' => '69', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetUFID" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFMatchTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/User/Get.ex.php b/api/v3/examples/User/Get.ex.php deleted file mode 100644 index e5879ca59f..0000000000 --- a/api/v3/examples/User/Get.ex.php +++ /dev/null @@ -1,83 +0,0 @@ - 3, - 'sequential' => 1, - ]; - - try { - $result = civicrm_api3('User', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function user_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 6, - 'values' => [ - '0' => [ - 'id' => '6', - 'name' => 'superman', - 'contact_id' => '3', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testUserGet" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UserTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/User/GetFields.ex.php b/api/v3/examples/User/GetFields.ex.php deleted file mode 100644 index 905194a08f..0000000000 --- a/api/v3/examples/User/GetFields.ex.php +++ /dev/null @@ -1,92 +0,0 @@ - 'get', - ]; - - try { - $result = civicrm_api3('User', 'getfields', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function user_getfields_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 3, - 'values' => [ - 'contact_id' => [ - 'title' => 'Contact ID', - 'type' => 1, - 'api.required' => 1, - 'name' => 'contact_id', - ], - 'id' => [ - 'title' => 'CMS User ID', - 'type' => 1, - 'name' => 'id', - ], - 'name' => [ - 'title' => 'Username', - 'type' => 2, - 'name' => 'name', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetFields" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UserTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Website/Create.ex.php b/api/v3/examples/Website/Create.ex.php deleted file mode 100644 index 2ec70d1cd3..0000000000 --- a/api/v3/examples/Website/Create.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 3, - 'url' => 'website.com', - 'website_type_id' => 1, - ]; - - try { - $result = civicrm_api3('Website', 'create', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function website_create_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => [ - '1' => [ - 'id' => '1', - 'contact_id' => '3', - 'url' => 'website.com', - 'website_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testCreateWebsite" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/WebsiteTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Website/Delete.ex.php b/api/v3/examples/Website/Delete.ex.php deleted file mode 100644 index c08be41dff..0000000000 --- a/api/v3/examples/Website/Delete.ex.php +++ /dev/null @@ -1,75 +0,0 @@ - 5, - ]; - - try { - $result = civicrm_api3('Website', 'delete', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function website_delete_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'values' => 1, - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testDeleteWebsite" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/WebsiteTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Website/Get.ex.php b/api/v3/examples/Website/Get.ex.php deleted file mode 100644 index 63b3a32b18..0000000000 --- a/api/v3/examples/Website/Get.ex.php +++ /dev/null @@ -1,85 +0,0 @@ - 5, - 'url' => 'website.com', - 'website_type_id' => 1, - ]; - - try { - $result = civicrm_api3('Website', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function website_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 3, - 'values' => [ - '3' => [ - 'id' => '3', - 'contact_id' => '5', - 'url' => 'website.com', - 'website_type_id' => '1', - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetWebsite" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/WebsiteTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Website/GetFields.ex.php b/api/v3/examples/Website/GetFields.ex.php deleted file mode 100644 index cb69653997..0000000000 --- a/api/v3/examples/Website/GetFields.ex.php +++ /dev/null @@ -1,165 +0,0 @@ - 'get', - ]; - - try { - $result = civicrm_api3('Website', 'getfields', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function website_getfields_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 4, - 'values' => [ - 'id' => [ - 'name' => 'id', - 'type' => 1, - 'title' => 'Website ID', - 'description' => 'Unique Website ID', - 'required' => TRUE, - 'where' => 'civicrm_website.id', - 'table_name' => 'civicrm_website', - 'entity' => 'Website', - 'bao' => 'CRM_Core_BAO_Website', - 'localizable' => 0, - 'html' => [ - 'type' => 'Number', - 'size' => 6, - 'maxlength' => 14, - ], - 'readonly' => TRUE, - 'add' => '3.2', - 'is_core_field' => TRUE, - 'api.aliases' => [ - '0' => 'website_id', - ], - ], - 'contact_id' => [ - 'name' => 'contact_id', - 'type' => 1, - 'title' => 'Contact ID', - 'description' => 'FK to Contact ID', - 'where' => 'civicrm_website.contact_id', - 'table_name' => 'civicrm_website', - 'entity' => 'Website', - 'bao' => 'CRM_Core_BAO_Website', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'html' => [ - 'label' => 'Contact', - 'size' => 6, - 'maxlength' => 14, - ], - 'add' => '3.2', - 'is_core_field' => TRUE, - 'FKApiName' => 'Contact', - ], - 'url' => [ - 'name' => 'url', - 'type' => 2, - 'title' => 'Website', - 'description' => 'Website', - 'maxlength' => 128, - 'size' => 30, - 'import' => TRUE, - 'where' => 'civicrm_website.url', - 'headerPattern' => '/Website/i', - 'dataPattern' => '/^[A-Za-z][0-9A-Za-z]{20,}$/', - 'export' => TRUE, - 'table_name' => 'civicrm_website', - 'entity' => 'Website', - 'bao' => 'CRM_Core_BAO_Website', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => 128, - 'size' => 30, - ], - 'add' => '3.2', - 'is_core_field' => TRUE, - ], - 'website_type_id' => [ - 'name' => 'website_type_id', - 'type' => 1, - 'title' => 'Website Type', - 'description' => 'Which Website type does this website belong to.', - 'where' => 'civicrm_website.website_type_id', - 'table_name' => 'civicrm_website', - 'entity' => 'Website', - 'bao' => 'CRM_Core_BAO_Website', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => 6, - 'maxlength' => 14, - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'website_type', - 'optionEditPath' => 'civicrm/admin/options/website_type', - ], - 'add' => '3.2', - 'is_core_field' => TRUE, - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetFields" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/WebsiteTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/api/v3/examples/Website/GetWithMetadata.ex.php b/api/v3/examples/Website/GetWithMetadata.ex.php deleted file mode 100644 index 652a3c562b..0000000000 --- a/api/v3/examples/Website/GetWithMetadata.ex.php +++ /dev/null @@ -1,174 +0,0 @@ - [ - 'metadata' => [ - '0' => 'fields', - ], - ], - ]; - - try { - $result = civicrm_api3('Website', 'get', $params); - } - catch (CRM_Core_Exception $e) { - // Handle error here. - $errorMessage = $e->getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - } - - return $result; -} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function website_get_expectedresult() { - - $expectedResult = [ - 'is_error' => 0, - 'version' => 3, - 'count' => 0, - 'values' => [], - 'metadata' => [ - 'fields' => [ - 'id' => [ - 'name' => 'id', - 'type' => '1', - 'title' => 'Website ID', - 'description' => 'Unique Website ID', - 'required' => '1', - 'where' => 'civicrm_website.id', - 'table_name' => 'civicrm_website', - 'entity' => 'Website', - 'bao' => 'CRM_Core_BAO_Website', - 'localizable' => 0, - 'html' => [ - 'type' => 'Number', - 'size' => '6', - 'maxlength' => '14', - ], - 'readonly' => '1', - 'add' => '3.2', - 'is_core_field' => '1', - 'api.aliases' => [ - '0' => 'website_id', - ], - ], - 'contact_id' => [ - 'name' => 'contact_id', - 'type' => '1', - 'title' => 'Contact ID', - 'description' => 'FK to Contact ID', - 'where' => 'civicrm_website.contact_id', - 'table_name' => 'civicrm_website', - 'entity' => 'Website', - 'bao' => 'CRM_Core_BAO_Website', - 'localizable' => 0, - 'FKClassName' => 'CRM_Contact_DAO_Contact', - 'html' => [ - 'label' => 'Contact', - 'size' => '6', - 'maxlength' => '14', - ], - 'add' => '3.2', - 'is_core_field' => '1', - 'FKApiName' => 'Contact', - ], - 'url' => [ - 'name' => 'url', - 'type' => '2', - 'title' => 'Website', - 'description' => 'Website', - 'maxlength' => '128', - 'size' => '30', - 'import' => '1', - 'where' => 'civicrm_website.url', - 'headerPattern' => '/Website/i', - 'dataPattern' => '/^[A-Za-z][0-9A-Za-z]{20,}$/', - 'export' => '1', - 'table_name' => 'civicrm_website', - 'entity' => 'Website', - 'bao' => 'CRM_Core_BAO_Website', - 'localizable' => 0, - 'html' => [ - 'type' => 'Text', - 'maxlength' => '128', - 'size' => '30', - ], - 'add' => '3.2', - 'is_core_field' => '1', - ], - 'website_type_id' => [ - 'name' => 'website_type_id', - 'type' => '1', - 'title' => 'Website Type', - 'description' => 'Which Website type does this website belong to.', - 'where' => 'civicrm_website.website_type_id', - 'table_name' => 'civicrm_website', - 'entity' => 'Website', - 'bao' => 'CRM_Core_BAO_Website', - 'localizable' => 0, - 'html' => [ - 'type' => 'Select', - 'size' => '6', - 'maxlength' => '14', - ], - 'pseudoconstant' => [ - 'optionGroupName' => 'website_type', - 'optionEditPath' => 'civicrm/admin/options/website_type', - ], - 'add' => '3.2', - 'is_core_field' => '1', - ], - ], - ], - ]; - - return $expectedResult; -} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "testGetMetadata" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/WebsiteTest.php - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */ diff --git a/templates/CRM/Admin/Page/APIExplorer.js b/templates/CRM/Admin/Page/APIExplorer.js index 6ef22537bf..e54d6bcd80 100644 --- a/templates/CRM/Admin/Page/APIExplorer.js +++ b/templates/CRM/Admin/Page/APIExplorer.js @@ -808,36 +808,6 @@ }); } - /** - * Fetch list of example files for a given entity - */ - function getExamples() { - CRM.utils.setOptions($('#example-action').prop('disabled', true).addClass('loading'), []); - $.getJSON(CRM.url('civicrm/ajax/apiexample', {entity: $(this).val()})) - .then(function(result) { - CRM.utils.setOptions($('#example-action').prop('disabled', false).removeClass('loading'), result); - }); - } - - /** - * Fetch and display an example file - */ - function getExample() { - var - entity = $('#example-entity').val(), - action = $('#example-action').val(); - if (entity && action) { - $('#example-result').block(); - $.get(CRM.url('civicrm/ajax/apiexample', {file: entity + '/' + action})) - .then(function(result) { - $('#example-result').unblock().text(result); - prettyPrint('#example-result'); - }); - } else { - $('#example-result').text($('#example-result').attr('placeholder')); - } - } - /** * Fetch entity docs & actions */ @@ -1002,7 +972,7 @@ }); // Initialize widgets - $('#api-entity, #example-entity, #doc-entity').crmSelect2({ + $('#api-entity, #doc-entity').crmSelect2({ // Add strikethough class to selection to indicate deprecated apis formatSelection: function(option) { return $(option.element).hasClass('strikethrough') ? '' + option.text + '' : option.text; @@ -1051,8 +1021,6 @@ items: '.api-chain-row, .api-param-row' }); $('#api-join').on('change', 'input', onSelectJoin); - $('#example-entity').on('change', getExamples); - $('#example-action').on('change', getExample); $('#doc-entity').on('change', getDocEntity); $('#doc-action').on('change', getDocAction); $('#api-params-add').on('click', function(e) { diff --git a/templates/CRM/Admin/Page/APIExplorer.tpl b/templates/CRM/Admin/Page/APIExplorer.tpl index 6e97653060..f541fcb568 100644 --- a/templates/CRM/Admin/Page/APIExplorer.tpl +++ b/templates/CRM/Admin/Page/APIExplorer.tpl @@ -23,8 +23,7 @@ max-height: 50em; } pre#api-result, - div#doc-result, - pre#example-result { + div#doc-result { padding:1em; border: 1px solid lightgrey; margin-top: 1em; @@ -234,9 +233,6 @@
  • {ts}Explorer{/ts}
    • -
  • - {ts}Examples{/ts} -
  • {ts}Code Docs{/ts}
    • @@ -320,30 +316,6 @@ -
    -
    -
    - - -    - - -
    -{ts}Results are displayed here.{/ts}
-
    -
    -
    -
    -
    diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index 08b5e7eadf..4606fa54d9 100644 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -44,7 +44,7 @@ use Civi\Api4\UFGroup; use Civi\Core\Transaction\Manager; use Civi\Payment\System; use Civi\Api4\OptionValue; -use Civi\Test\Api3DocTrait; +use Civi\Test\Api3TestTrait; use Civi\Test\ContactTestTrait; use Civi\Test\DbTestTrait; use Civi\Test\EventTestTrait; @@ -79,7 +79,7 @@ define('API_LATEST_VERSION', 3); */ class CiviUnitTestCase extends PHPUnit\Framework\TestCase { - use Api3DocTrait; + use Api3TestTrait; use EventTestTrait; use GenericAssertionsTrait; use DbTestTrait; diff --git a/tests/phpunit/api/v3/ActivityTest.php b/tests/phpunit/api/v3/ActivityTest.php index 06bcf2a8ae..9032d166f6 100644 --- a/tests/phpunit/api/v3/ActivityTest.php +++ b/tests/phpunit/api/v3/ActivityTest.php @@ -469,21 +469,6 @@ class api_v3_ActivityTest extends CiviUnitTestCase { $this->customGroupDelete($ids['custom_group_id']); } - /** - * Test civicrm_activity_create() using example code. - */ - public function testActivityCreateExample() { - require_once 'api/v3/examples/Activity/Create.ex.php'; - $result = activity_create_example(); - $expectedResult = activity_create_expectedresult(); - // Compare everything *except* timestamps. - unset($result['values'][1]['created_date']); - unset($result['values'][1]['modified_date']); - unset($expectedResult['values'][1]['created_date']); - unset($expectedResult['values'][1]['modified_date']); - $this->assertEquals($result, $expectedResult); - } - /** * Test civicrm_activity_create() with valid parameters and custom data. */ diff --git a/tests/phpunit/api/v3/ContributionTest.php b/tests/phpunit/api/v3/ContributionTest.php index 6578318196..cae82ee1d5 100644 --- a/tests/phpunit/api/v3/ContributionTest.php +++ b/tests/phpunit/api/v3/ContributionTest.php @@ -1067,20 +1067,6 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]); } - /** - * Test using example code. - */ - public function testContributionCreateExample() { - //make sure at least on page exists since there is a truncate in tear down - $this->callAPISuccess('contribution_page', 'create', $this->pageParams); - require_once 'api/v3/examples/Contribution/Create.ex.php'; - $result = contribution_create_example(); - $id = $result['id']; - $expectedResult = contribution_create_expectedresult(); - $this->checkArrayEquals($expectedResult, $result); - $this->contributionDelete($id); - } - /** * Function tests that additional financial records are created when fee amount is recorded. */ diff --git a/tests/phpunit/api/v3/PaymentProcessorTest.php b/tests/phpunit/api/v3/PaymentProcessorTest.php index 3caf5fdd9b..4b55869a63 100644 --- a/tests/phpunit/api/v3/PaymentProcessorTest.php +++ b/tests/phpunit/api/v3/PaymentProcessorTest.php @@ -128,16 +128,6 @@ class api_v3_PaymentProcessorTest extends CiviUnitTestCase { $this->checkArrayEquals($expectedResult, $result['values'][$result['id']]); } - /** - * Test using example code. - */ - public function testPaymentProcessorCreateExample() { - require_once 'api/v3/examples/PaymentProcessor/Create.ex.php'; - $result = payment_processor_create_example(); - $expectedResult = payment_processor_create_expectedresult(); - $this->assertAPISuccess($result); - } - /** * Check payment processor delete. * @dataProvider versionThreeAndFour diff --git a/tests/phpunit/api/v3/PaymentProcessorTypeTest.php b/tests/phpunit/api/v3/PaymentProcessorTypeTest.php index 165c5b8043..7eecbbd1e1 100644 --- a/tests/phpunit/api/v3/PaymentProcessorTypeTest.php +++ b/tests/phpunit/api/v3/PaymentProcessorTypeTest.php @@ -73,16 +73,6 @@ class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { $this->assertDBState('CRM_Financial_DAO_PaymentProcessorType', $result['id'], $params); } - /** - * Test using example code. - */ - public function testPaymentProcessorTypeCreateExample() { - require_once 'api/v3/examples/PaymentProcessorType/Create.ex.php'; - $result = payment_processor_type_create_example(); - $expectedResult = payment_processor_type_create_expectedresult(); - $this->assertAPISuccess($result); - } - ///////////////// civicrm_payment_processor_type_delete methods /** diff --git a/tests/phpunit/api/v3/RelationshipTypeTest.php b/tests/phpunit/api/v3/RelationshipTypeTest.php index 0548a97a24..dc5bd038f0 100644 --- a/tests/phpunit/api/v3/RelationshipTypeTest.php +++ b/tests/phpunit/api/v3/RelationshipTypeTest.php @@ -75,19 +75,6 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { $this->assertDBState('CRM_Contact_DAO_RelationshipType', $result['id'], $params); } - /** - * Test using example code. - * @param int $version - * @dataProvider versionThreeAndFour - */ - public function testRelationshipTypeCreateExample($version) { - $this->_apiversion = $version; - require_once 'api/v3/examples/RelationshipType/Create.ex.php'; - $result = relationship_type_create_example(); - $expectedResult = relationship_type_create_expectedresult(); - $this->assertAPISuccess($result); - } - /** * Check if required fields are not passed. * @param int $version diff --git a/tests/templates/documentFunction.tpl b/tests/templates/documentFunction.tpl deleted file mode 100644 index 5812a47b64..0000000000 --- a/tests/templates/documentFunction.tpl +++ /dev/null @@ -1,81 +0,0 @@ -{literal}getMessage(); - $errorCode = $e->getErrorCode(); - $errorData = $e->getExtraParams(); - return [ - 'is_error' => 1, - 'error_message' => $errorMessage, - 'error_code' => $errorCode, - 'error_data' => $errorData, - ]; - }{/literal} - - return $result; -{literal}}{/literal} - -/** - * Function returns array of result expected from previous function. - * - * @return array - * API result array - */ -function {$function}_expectedresult() {literal}{{/literal} - - $expectedResult = {$result|@print_array}; - - return $expectedResult; -{literal}}{/literal} - -/* - * This example has been generated from the API test suite. - * The test that created it is called "{$testFunction}" - * and can be found at: - * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/{$testFile} - * - * You can see the outcome of the API tests at - * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ - * - * To Learn about the API read - * https://docs.civicrm.org/dev/en/latest/api/ - * - * Browse the API on your own site with the API Explorer. It is in the main - * CiviCRM menu, under: Support > Development > API Explorer. - * - * Read more about testing here - * https://docs.civicrm.org/dev/en/latest/testing/ - * - * API Standards documentation: - * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ - */