api/v3/examples/Address/AddressLike.php

   1 <?php
   2 /**
   3  * Test Generated example of using address get API
   4  * Demonstrates Use of Like *
   5  */
   6 function address_get_example(){
   7 $params = array(
   8   'street_address' => array(
   9       'LIKE' => '%mb%',
  10     ),
  11   'sequential' => 1,
  12 );
  13
  14 try{
  15   $result = civicrm_api3('address', 'get', $params);
  16 }
  17 catch (CiviCRM_API3_Exception $e) {
  18   // handle error here
  19   $errorMessage = $e->getMessage();
  20   $errorCode = $e->getErrorCode();
  21   $errorData = $e->getExtraParams();
  22   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  23 }
  24
  25 return $result;
  26 }
  27
  28 /**
  29  * Function returns array of result expected from previous function
  30  */
  31 function address_get_expectedresult(){
  32
  33   $expectedResult = array(
  34   'is_error' => 0,
  35   'version' => 3,
  36   'count' => 1,
  37   'id' => 10,
  38   'values' => array(
  39       '0' => array(
  40           'id' => '10',
  41           'contact_id' => '12',
  42           'location_type_id' => '15',
  43           'is_primary' => '1',
  44           'is_billing' => 0,
  45           'street_address' => 'Ambachtstraat 23',
  46           'street_number' => '23',
  47           'street_name' => 'Ambachtstraat',
  48           'city' => 'Brummen',
  49           'postal_code' => '6971 BN',
  50           'country_id' => '1152',
  51           'manual_geo_code' => 0,
  52         ),
  53     ),
  54 );
  55
  56   return $expectedResult;
  57 }
  58
  59
  60 /*
  61 * This example has been generated from the API test suite. The test that created it is called
  62 *
  63 * testGetAddressLikeSuccess and can be found in
  64 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/AddressTest.php
  65 *
  66 * You can see the outcome of the API tests at
  67 * http://tests.dev.civicrm.org/trunk/results-api_v3
  68 *
  69 * To Learn about the API read
  70 * http://book.civicrm.org/developer/current/techniques/api/
  71 *
  72 * and review the wiki at
  73 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  74 *
  75 * Read more about testing here
  76 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  77 *
  78 * API Standards documentation:
  79 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  80 */