api/v3/examples/MailingEventSubscribe/Create.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the MailingEventSubscribe.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function mailing_event_subscribe_create_example() {
   9   $params = array(
  10     'email' => 'test@test.test',
  11     'group_id' => 2,
  12     'contact_id' => 3,
  13     'hash' => 'b15de8b64e2cec34',
  14     'time_stamp' => '20101212121212',
  15   );
  16
  17   try{
  18     $result = civicrm_api3('MailingEventSubscribe', 'create', $params);
  19   }
  20   catch (CiviCRM_API3_Exception $e) {
  21     // Handle error here.
  22     $errorMessage = $e->getMessage();
  23     $errorCode = $e->getErrorCode();
  24     $errorData = $e->getExtraParams();
  25     return array(
  26       'is_error' => 1,
  27       'error_message' => $errorMessage,
  28       'error_code' => $errorCode,
  29       'error_data' => $errorData,
  30     );
  31   }
  32
  33   return $result;
  34 }
  35
  36 /**
  37  * Function returns array of result expected from previous function.
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function mailing_event_subscribe_create_expectedresult() {
  43
  44   $expectedResult = array(
  45     'is_error' => 0,
  46     'version' => 3,
  47     'count' => 1,
  48     'id' => 1,
  49     'values' => array(
  50       '1' => array(
  51         'contact_id' => '3',
  52         'subscribe_id' => '1',
  53         'hash' => '67eac7789eaee00',
  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 "testMailerGroupSubscribeGivenContactId"
  64 * and can be found at:
  65 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingGroupTest.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 */