api/v3/examples/MailingGroup/Subscribe.php

   1 <?php
   2 /**
   3  * Test Generated example of using mailing_group subscribe API
   4  * *
   5  */
   6 function mailing_group_subscribe_example(){
   7 $params = array(
   8   'email' => 'test@test.test',
   9   'group_id' => 2,
  10   'contact_id' => 3,
  11   'hash' => 'b15de8b64e2cec34',
  12   'time_stamp' => '20101212121212',
  13 );
  14
  15 try{
  16   $result = civicrm_api3('mailing_group', 'subscribe', $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('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  24 }
  25
  26 return $result;
  27 }
  28
  29 /**
  30  * Function returns array of result expected from previous function
  31  */
  32 function mailing_group_subscribe_expectedresult(){
  33
  34   $expectedResult = array(
  35   'is_error' => 0,
  36   'version' => 3,
  37   'count' => 1,
  38   'id' => 1,
  39   'values' => array(
  40       '1' => array(
  41           'contact_id' => '3',
  42           'subscribe_id' => '1',
  43           'hash' => '67eac7789eaee00',
  44         ),
  45     ),
  46 );
  47
  48   return $expectedResult;
  49 }
  50
  51
  52 /*
  53 * This example has been generated from the API test suite. The test that created it is called
  54 *
  55 * testMailerGroupSubscribeGivenContactId and can be found in
  56 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingGroupTest.php
  57 *
  58 * You can see the outcome of the API tests at
  59 * https://test.civicrm.org/job/CiviCRM-master-git/
  60 *
  61 * To Learn about the API read
  62 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  63 *
  64 * Browse the api on your own site with the api explorer
  65 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  66 *
  67 * Read more about testing here
  68 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  69 *
  70 * API Standards documentation:
  71 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  72 */