api/v3/examples/CampaignCreate.php

   1 <?php
   2 /**
   3  * Test Generated example of using campaign create API
   4  * Create a campaign - Note use of relative dates here http://www.php.net/manual/en/datetime.formats.relative.php *
   5  */
   6 function campaign_create_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', 'create', $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_create_expectedresult(){
  31
  32   $expectedResult = array(
  33   'is_error' => 0,
  34   'version' => 3,
  35   'count' => 1,
  36   'id' => 1,
  37   'values' => array(
  38       '1' => array(
  39           'id' => '1',
  40           'name' => 'campaign_title',
  41           'title' => 'campaign title',
  42           'description' => 'Call people, ask for money',
  43           'start_date' => '',
  44           'end_date' => '',
  45           'campaign_type_id' => '',
  46           'status_id' => '',
  47           'external_identifier' => '',
  48           'parent_id' => '',
  49           'is_active' => '',
  50           'created_id' => '',
  51           'created_date' => '2013-07-28 08:49:19',
  52           'last_modified_id' => '',
  53           'last_modified_date' => '',
  54           'goal_general' => '',
  55           'goal_revenue' => '',
  56         ),
  57     ),
  58 );
  59
  60   return $expectedResult;
  61 }
  62
  63
  64 /*
  65 * This example has been generated from the API test suite. The test that created it is called
  66 *
  67 * testCreateCampaign and can be found in
  68 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/CampaignTest.php
  69 *
  70 * You can see the outcome of the API tests at
  71 * http://tests.dev.civicrm.org/trunk/results-api_v3
  72 *
  73 * To Learn about the API read
  74 * http://book.civicrm.org/developer/current/techniques/api/
  75 *
  76 * and review the wiki at
  77 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  78 *
  79 * Read more about testing here
  80 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  81 *
  82 * API Standards documentation:
  83 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  84 */