Merge pull request #2540 from eileenmcnaughton/CRM-14235

[civicrm-core.git] / api / v3 / examples / Website / GetWithMetadata.php

<?php
/**
 * Test Generated example of using website get API
 * Demonostrates returning field metadata *
 */
function website_get_example(){
$params = array(
  'options' => array(
      'metadata' => array(
          '0' => 'fields',
        ),
    ),
);

try{
  $result = civicrm_api3('website', 'get', $params);
}
catch (CiviCRM_API3_Exception $e) {
  // handle error here
  $errorMessage = $e->getMessage();
  $errorCode = $e->getErrorCode();
  $errorData = $e->getExtraParams();
  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
}

return $result;
}

/**
 * Function returns array of result expected from previous function
 */
function website_get_expectedresult(){

  $expectedResult = array(
  'is_error' => 0,
  'version' => 3,
  'count' => 0,
  'values' => array(),
  'metadata' => array(
      'fields' => array(
          'id' => array(
              'name' => 'id',
              'type' => '1',
              'title' => 'Website ID',
              'required' => '1',
              'api.aliases' => array(
                  '0' => 'website_id',
                ),
            ),
          'contact_id' => array(
              'name' => 'contact_id',
              'type' => '1',
              'title' => 'Contact',
              'FKClassName' => 'CRM_Contact_DAO_Contact',
            ),
          'url' => array(
              'name' => 'url',
              'type' => '2',
              'title' => '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',
            ),
          'website_type_id' => array(
              'name' => 'website_type_id',
              'type' => '1',
              'title' => 'Website Type',
              'pseudoconstant' => array(
                  'optionGroupName' => 'website_type',
                ),
            ),
        ),
    ),
);

  return $expectedResult;
}


/*
* This example has been generated from the API test suite. The test that created it is called
*
* testGetMetadata and can be found in
* 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-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/explorer
*
* 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
*/