api/v3/examples/MailingGroupSubscribe.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' => 4,
  38   'values' => array(
  39       'contact_id' => '3',
  40       'subscribe_id' => '1',
  41       'hash' => 'bf4d724dbbb38c0c',
  42       'is_error' => 0,
  43     ),
  44 );
  45
  46   return $expectedResult;
  47 }
  48
  49
  50 /*
  51 * This example has been generated from the API test suite. The test that created it is called
  52 *
  53 * testMailerGroupSubscribeGivenContactId and can be found in
  54 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/MailingGroupTest.php
  55 *
  56 * You can see the outcome of the API tests at
  57 * http://tests.dev.civicrm.org/trunk/results-api_v3
  58 *
  59 * To Learn about the API read
  60 * http://book.civicrm.org/developer/current/techniques/api/
  61 *
  62 * and review the wiki at
  63 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  64 *
  65 * Read more about testing here
  66 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  67 *
  68 * API Standards documentation:
  69 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  70 */