api/v3/examples/Address/AddressParse.php

   1 <?php
   2 /**
   3  * Test Generated example of using address create API
   4  * Demonstrates Use of address parsing param *
   5  */
   6 function address_create_example(){
   7 $params = array(
   8   'street_parsing' => 1,
   9   'street_address' => '54A Excelsior Ave. Apt 1C',
  10   'location_type_id' => 7,
  11   'contact_id' => 4,
  12 );
  13
  14 try{
  15   $result = civicrm_api3('address', 'create', $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_create_expectedresult(){
  32
  33   $expectedResult = array(
  34   'is_error' => 0,
  35   'version' => 3,
  36   'count' => 1,
  37   'id' => 3,
  38   'values' => array(
  39       '3' => array(
  40           'id' => '3',
  41           'contact_id' => '4',
  42           'location_type_id' => '7',
  43           'is_primary' => '1',
  44           'is_billing' => 0,
  45           'street_address' => '54A Excelsior Ave. Apt 1C',
  46           'street_number' => '54',
  47           'street_number_suffix' => 'A',
  48           'street_name' => 'Excelsior Ave.',
  49           'street_unit' => 'Apt 1C',
  50           'manual_geo_code' => 0,
  51         ),
  52     ),
  53 );
  54
  55   return $expectedResult;
  56 }
  57
  58
  59 /*
  60 * This example has been generated from the API test suite. The test that created it is called
  61 *
  62 * testCreateAddressParsing and can be found in
  63 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php
  64 *
  65 * You can see the outcome of the API tests at
  66 * https://test.civicrm.org/job/CiviCRM-master-git/
  67 *
  68 * To Learn about the API read
  69 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  70 *
  71 * Browse the api on your own site with the api explorer
  72 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  73 *
  74 * Read more about testing here
  75 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  76 *
  77 * API Standards documentation:
  78 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  79 */