crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/api/v3/examples/Address/AddressParse.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Address.create API.
   4  *
   5  * Demonstrates Use of address parsing param.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function address_create_example() {
  11   $params = array(
  12     'street_parsing' => 1,
  13     'street_address' => '54A Excelsior Ave. Apt 1C',
  14     'location_type_id' => 7,
  15     'contact_id' => 4,
  16   );
  17
  18   try{
  19     $result = civicrm_api3('Address', 'create', $params);
  20   }
  21   catch (CiviCRM_API3_Exception $e) {
  22     // Handle error here.
  23     $errorMessage = $e->getMessage();
  24     $errorCode = $e->getErrorCode();
  25     $errorData = $e->getExtraParams();
  26     return array(
  27       'error' => $errorMessage,
  28       'error_code' => $errorCode,
  29       'error_data' => $errorData,
  30     );
  31   }
  32
  33   return $result;
  34 }
  35
  36 /**
  37  * Function returns array of result expected from previous function.
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function address_create_expectedresult() {
  43
  44   $expectedResult = array(
  45     'is_error' => 0,
  46     'version' => 3,
  47     'count' => 1,
  48     'id' => 1,
  49     'values' => array(
  50       '1' => array(
  51         'id' => '1',
  52         'contact_id' => '4',
  53         'location_type_id' => '7',
  54         'is_primary' => '1',
  55         'is_billing' => 0,
  56         'street_address' => '54A Excelsior Ave. Apt 1C',
  57         'street_number' => '54',
  58         'street_number_suffix' => 'A',
  59         'street_name' => 'Excelsior Ave.',
  60         'street_unit' => 'Apt 1C',
  61         'manual_geo_code' => 0,
  62       ),
  63     ),
  64   );
  65
  66   return $expectedResult;
  67 }
  68
  69 /*
  70 * This example has been generated from the API test suite.
  71 * The test that created it is called "testCreateAddressParsing"
  72 * and can be found at:
  73 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php
  74 *
  75 * You can see the outcome of the API tests at
  76 * https://test.civicrm.org/job/CiviCRM-master-git/
  77 *
  78 * To Learn about the API read
  79 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  80 *
  81 * Browse the api on your own site with the api explorer
  82 * http://MYSITE.ORG/path/to/civicrm/api
  83 *
  84 * Read more about testing here
  85 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  86 *
  87 * API Standards documentation:
  88 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  89 */