api/v3/examples/Address/AddressParse.php

   1 <?php
   2
   3 /*
   4  Demonstrates Use of address parsing param
   5  */
   6 function address_create_example(){
   7 $params = array(
   8   'version' => 3,
   9   'street_parsing' => 1,
  10   'street_address' => '54A Excelsior Ave. Apt 1C',
  11   'location_type_id' => 7,
  12   'contact_id' => 4,
  13 );
  14
  15   $result = civicrm_api( 'address','create',$params );
  16
  17   return $result;
  18 }
  19
  20 /*
  21  * Function returns array of result expected from previous function
  22  */
  23 function address_create_expectedresult(){
  24
  25   $expectedResult = array(
  26   'is_error' => 0,
  27   'version' => 3,
  28   'count' => 1,
  29   'id' => 3,
  30   'values' => array(
  31       '3' => array(
  32           'id' => '3',
  33           'contact_id' => '4',
  34           'location_type_id' => '7',
  35           'is_primary' => '1',
  36           'is_billing' => 0,
  37           'street_address' => '54A Excelsior Ave. Apt 1C',
  38           'street_number' => '54',
  39           'street_number_suffix' => 'A',
  40           'street_name' => 'Excelsior Ave.',
  41           'street_unit' => 'Apt 1C',
  42           'manual_geo_code' => 0,
  43         ),
  44     ),
  45 );
  46
  47   return $expectedResult  ;
  48 }
  49
  50
  51 /*
  52 * This example has been generated from the API test suite. The test that created it is called
  53 *
  54 * testCreateAddressParsing and can be found in
  55 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/AddressTest.php
  56 *
  57 * You can see the outcome of the API tests at
  58 * http://tests.dev.civicrm.org/trunk/results-api_v3
  59 *
  60 * To Learn about the API read
  61 * http://book.civicrm.org/developer/current/techniques/api/
  62 *
  63 * and review the wiki at
  64 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  65 *
  66 * Read more about testing here
  67 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  68 *
  69 * API Standards documentation:
  70 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  71 */