3 * Test Generated example of using website get API
4 * Demonostrates returning field metadata *
6 function website_get_example(){
16 $result = civicrm_api3('website', 'get', $params);
18 catch (CiviCRM_API3_Exception
$e) {
20 $errorMessage = $e->getMessage();
21 $errorCode = $e->getErrorCode();
22 $errorData = $e->getExtraParams();
23 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
30 * Function returns array of result expected from previous function
32 function website_get_expectedresult(){
34 $expectedResult = array(
44 'title' => 'Website ID',
46 'api.aliases' => array(
50 'contact_id' => array(
51 'name' => 'contact_id',
54 'FKClassName' => 'CRM_Contact_DAO_Contact',
63 'where' => 'civicrm_website.url',
64 'headerPattern' => '/Website/i',
65 'dataPattern' => '/^[A-Za-z][0-9A-Za-z]{20,}$/',
71 'website_type_id' => array(
72 'name' => 'website_type_id',
74 'title' => 'Website Type',
78 'pseudoconstant' => array(
79 'optionGroupName' => 'website_type',
86 return $expectedResult;
91 * This example has been generated from the API test suite. The test that created it is called
93 * testGetMetadata and can be found in
94 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/WebsiteTest.php
96 * You can see the outcome of the API tests at
97 * https://test.civicrm.org/job/CiviCRM-master-git/
99 * To Learn about the API read
100 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
102 * Browse the api on your own site with the api explorer
103 * http://MYSITE.ORG/path/to/civicrm/api/explorer
105 * Read more about testing here
106 * http://wiki.civicrm.org/confluence/display/CRM/Testing
108 * API Standards documentation:
109 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards