api/v3/examples/Survey/ChainedGetDelete.php

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