api/v3/examples/Campaign/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using campaign get API
   4  * *
   5  */
   6 function campaign_get_example(){
   7 $params = array(
   8   'title' => 'campaign title',
   9   'description' => 'Call people, ask for money',
  10   'created_date' => 'first sat of July 2008',
  11 );
  12
  13 try{
  14   $result = civicrm_api3('campaign', 'get', $params);
  15 }
  16 catch (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 }
  23
  24 return $result;
  25 }
  26
  27 /**
  28  * Function returns array of result expected from previous function
  29  */
  30 function campaign_get_expectedresult(){
  31
  32   $expectedResult = array(
  33   'is_error' => 0,
  34   'version' => 3,
  35   'count' => 1,
  36   'id' => 2,
  37   'values' => array(
  38       '2' => array(
  39           'id' => '2',
  40           'name' => 'campaign_title',
  41           'title' => 'campaign title',
  42           'description' => 'Call people, ask for money',
  43           'is_active' => '1',
  44           'created_date' => '2013-07-28 08:49:19',
  45         ),
  46     ),
  47 );
  48
  49   return $expectedResult;
  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
  57 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CampaignTest.php
  58 *
  59 * You can see the outcome of the API tests at
  60 * https://test.civicrm.org/job/CiviCRM-master-git/
  61 *
  62 * To Learn about the API read
  63 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  64 *
  65 * Browse the api on your own site with the api explorer
  66 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  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
  73 */