Merge pull request #2704 from jitendrapurohit/CRM_TestFix
[civicrm-core.git] / api / v3 / examples / Campaign / Get.php
CommitLineData
6a488035 1<?php
fb32de45 2/**
3 * Test Generated example of using campaign get API
4 * *
6a488035
TO
5 */
6function campaign_get_example(){
edb0d67a 7$params = array(
6a488035
TO
8 'title' => 'campaign title',
9 'description' => 'Call people, ask for money',
10 'created_date' => 'first sat of July 2008',
11);
12
fb32de45 13try{
14 $result = civicrm_api3('campaign', 'get', $params);
15}
16catch (CiviCRM_API3_Exception $e) {
17 // handle error here
18 $errorMessage = $e->getMessage();
19 $errorCode = $e->getErrorCode();
20 $errorData = $e->getExtraParams();
21 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
22}
6a488035 23
fb32de45 24return $result;
6a488035
TO
25}
26
fb32de45 27/**
6a488035
TO
28 * Function returns array of result expected from previous function
29 */
30function campaign_get_expectedresult(){
31
edb0d67a 32 $expectedResult = array(
6a488035
TO
33 'is_error' => 0,
34 'version' => 3,
35 'count' => 1,
36 'id' => 2,
edb0d67a 37 'values' => array(
38 '2' => array(
6a488035
TO
39 'id' => '2',
40 'name' => 'campaign_title',
41 'title' => 'campaign title',
42 'description' => 'Call people, ask for money',
43 'is_active' => '1',
f27f2724 44 'created_date' => '2013-07-28 08:49:19',
6a488035
TO
45 ),
46 ),
47);
48
fb32de45 49 return $expectedResult;
6a488035
TO
50}
51
52
53/*
54* This example has been generated from the API test suite. The test that created it is called
55*
56* testGetCampaign and can be found in
69d79249 57* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CampaignTest.php
6a488035
TO
58*
59* You can see the outcome of the API tests at
69d79249 60* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
61*
62* To Learn about the API read
69d79249 63* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 64*
69d79249
E
65* Browse the api on your own site with the api explorer
66* http://MYSITE.ORG/path/to/civicrm/api/explorer
6a488035
TO
67*
68* Read more about testing here
69* http://wiki.civicrm.org/confluence/display/CRM/Testing
70*
71* API Standards documentation:
72* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b259a4ab 73*/