api/v3/examples/MailingAB/Create.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the MailingAB.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function mailing_a_b_create_example() {
   9   $params = [
  10     'mailing_id_a' => 1,
  11     'mailing_id_b' => 2,
  12     'mailing_id_c' => 3,
  13     'testing_criteria' => 'subject',
  14     'winner_criteria' => 'open',
  15     'declare_winning_time' => '+2 days',
  16     'group_percentage' => 10,
  17   ];
  18
  19   try{
  20     $result = civicrm_api3('MailingAB', 'create', $params);
  21   }
  22   catch (CiviCRM_API3_Exception $e) {
  23     // Handle error here.
  24     $errorMessage = $e->getMessage();
  25     $errorCode = $e->getErrorCode();
  26     $errorData = $e->getExtraParams();
  27     return [
  28       'is_error' => 1,
  29       'error_message' => $errorMessage,
  30       'error_code' => $errorCode,
  31       'error_data' => $errorData,
  32     ];
  33   }
  34
  35   return $result;
  36 }
  37
  38 /**
  39  * Function returns array of result expected from previous function.
  40  *
  41  * @return array
  42  *   API result array
  43  */
  44 function mailing_a_b_create_expectedresult() {
  45
  46   $expectedResult = [
  47     'is_error' => 0,
  48     'version' => 3,
  49     'count' => 1,
  50     'id' => 1,
  51     'values' => [
  52       '1' => [
  53         'id' => '1',
  54         'name' => '',
  55         'status' => '',
  56         'mailing_id_a' => '1',
  57         'mailing_id_b' => '2',
  58         'mailing_id_c' => '3',
  59         'domain_id' => '1',
  60         'testing_criteria' => 'subject',
  61         'winner_criteria' => 'open',
  62         'specific_url' => '',
  63         'declare_winning_time' => '20170209023708',
  64         'group_percentage' => '10',
  65         'created_id' => '3',
  66         'created_date' => '2013-07-28 08:49:19',
  67       ],
  68     ],
  69   ];
  70
  71   return $expectedResult;
  72 }
  73
  74 /*
  75 * This example has been generated from the API test suite.
  76 * The test that created it is called "testMailingABCreateSuccess"
  77 * and can be found at:
  78 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingABTest.php
  79 *
  80 * You can see the outcome of the API tests at
  81 * https://test.civicrm.org/job/CiviCRM-master-git/
  82 *
  83 * To Learn about the API read
  84 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  85 *
  86 * Browse the api on your own site with the api explorer
  87 * http://MYSITE.ORG/path/to/civicrm/api
  88 *
  89 * Read more about testing here
  90 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  91 *
  92 * API Standards documentation:
  93 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  94 */