CRM-15988 - Update generated examples
[civicrm-core.git] / api / v3 / examples / Website / Create.php
CommitLineData
6a488035 1<?php
50fb255d 2/**
a828d7b8 3 * Test Generated example demonstrating the Website.create API.
50fb255d 4 *
50fb255d 5 * @return array
6 * API result array
7 */
8function website_create_example() {
9 $params = array(
10 'contact_id' => 3,
11 'url' => 'website.com',
12 'website_type_id' => 1,
13 );
6a488035 14
50fb255d 15 try{
a828d7b8 16 $result = civicrm_api3('Website', 'create', $params);
50fb255d 17 }
18 catch (CiviCRM_API3_Exception $e) {
19 // Handle error here.
20 $errorMessage = $e->getMessage();
21 $errorCode = $e->getErrorCode();
22 $errorData = $e->getExtraParams();
23 return array(
24 'error' => $errorMessage,
25 'error_code' => $errorCode,
26 'error_data' => $errorData,
27 );
28 }
29
30 return $result;
6a488035
TO
31}
32
fb32de45 33/**
50fb255d 34 * Function returns array of result expected from previous function.
35 *
36 * @return array
37 * API result array
6a488035 38 */
50fb255d 39function website_create_expectedresult() {
6a488035 40
ee600d6f 41 $expectedResult = array(
50fb255d 42 'is_error' => 0,
43 'version' => 3,
44 'count' => 1,
45 'id' => 1,
46 'values' => array(
ee600d6f 47 '1' => array(
50fb255d 48 'id' => '1',
49 'contact_id' => '3',
50 'url' => 'website.com',
51 'website_type_id' => '1',
52 ),
6a488035 53 ),
50fb255d 54 );
6a488035 55
fb32de45 56 return $expectedResult;
6a488035
TO
57}
58
a828d7b8 59/*
50fb255d 60* This example has been generated from the API test suite.
a828d7b8
CW
61* The test that created it is called "testCreateWebsite"
62* and can be found at:
69d79249 63* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/WebsiteTest.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 71* Browse the api on your own site with the api explorer
41d4d31f 72* http://MYSITE.ORG/path/to/civicrm/api
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*/