api/v3/examples/Campaign/Get.php

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