api/v3/examples/Survey/ChainedGetDelete.php

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