api/v3/examples/Campaign/Get.php

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