Merge pull request #2714 from jitendrapurohit/CRMTestFix
[civicrm-core.git] / api / v3 / examples / Address / AddressParse.php
CommitLineData
6a488035 1<?php
fb32de45 2/**
3 * Test Generated example of using address create API
4 * Demonstrates Use of address parsing param *
6a488035
TO
5 */
6function address_create_example(){
edb0d67a 7$params = array(
6a488035
TO
8 'street_parsing' => 1,
9 'street_address' => '54A Excelsior Ave. Apt 1C',
10 'location_type_id' => 7,
11 'contact_id' => 4,
12);
13
fb32de45 14try{
15 $result = civicrm_api3('address', 'create', $params);
16}
17catch (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}
6a488035 24
fb32de45 25return $result;
6a488035
TO
26}
27
fb32de45 28/**
6a488035
TO
29 * Function returns array of result expected from previous function
30 */
31function address_create_expectedresult(){
32
edb0d67a 33 $expectedResult = array(
6a488035
TO
34 'is_error' => 0,
35 'version' => 3,
36 'count' => 1,
37 'id' => 3,
edb0d67a 38 'values' => array(
39 '3' => array(
6a488035
TO
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
fb32de45 55 return $expectedResult;
6a488035
TO
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
69d79249 63* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php
6a488035
TO
64*
65* You can see the outcome of the API tests at
69d79249 66* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
67*
68* To Learn about the API read
69d79249 69* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 70*
69d79249
E
71* Browse the api on your own site with the api explorer
72* http://MYSITE.ORG/path/to/civicrm/api/explorer
6a488035
TO
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
b259a4ab 79*/