X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2Fexamples%2FEvent%2FIsFullOption.php;h=42b33bf7a99f4faeb6b7d6b17f57300e2b0ead00;hb=7a67a900ec8ee6322f2a199b59a0ab7fe1ea3e56;hp=bfa1cd0f7d8ed52de41dc5e64884c897ba608290;hpb=a5d44edbee5498fa4195c5f3571db6b820185fa8;p=civicrm-core.git

diff --git a/api/v3/examples/Event/IsFullOption.php b/api/v3/examples/Event/IsFullOption.php
index bfa1cd0f7d..42b33bf7a9 100644
--- a/api/v3/examples/Event/IsFullOption.php
+++ b/api/v3/examples/Event/IsFullOption.php
@@ -1,70 +1,82 @@
 <?php
 /**
- * Test Generated example of using event getsingle API
- * demonstrates use of return is_full  *
+ * Test Generated example of using event getsingle API.
+ *
+ * Demonstrates use of return is_full .
+ *
+ * @return array
+ *   API result array
  */
-function event_getsingle_example(){
-$params = array(
-  'id' => 1,
-  'return.is_full' => 1,
-);
+function event_getsingle_example() {
+  $params = array(
+    'id' => 1,
+    'return.is_full' => 1,
+  );
 
-try{
-  $result = civicrm_api3('event', 'getsingle', $params);
-}
-catch (CiviCRM_API3_Exception $e) {
-  // handle error here
-  $errorMessage = $e->getMessage();
-  $errorCode = $e->getErrorCode();
-  $errorData = $e->getExtraParams();
-  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
-}
+  try{
+    $result = civicrm_api3('event', 'getsingle', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'error' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
 
-return $result;
+  return $result;
 }
 
 /**
- * Function returns array of result expected from previous function
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
  */
-function event_getsingle_expectedresult(){
+function event_getsingle_expectedresult() {
 
   $expectedResult = array(
-  'id' => '1',
-  'title' => 'Annual CiviCRM meet',
-  'event_title' => 'Annual CiviCRM meet',
-  'event_type_id' => '1',
-  'participant_listing_id' => 0,
-  'is_public' => '1',
-  'start_date' => '2008-10-21 00:00:00',
-  'event_start_date' => '2008-10-21 00:00:00',
-  'is_online_registration' => 0,
-  'max_participants' => '1',
-  'is_monetary' => 0,
-  'is_map' => 0,
-  'is_active' => '1',
-  'is_show_location' => '1',
-  'default_role_id' => '1',
-  'is_email_confirm' => 0,
-  'is_pay_later' => 0,
-  'is_partial_payment' => 0,
-  'is_multiple_registrations' => 0,
-  'allow_same_participant_emails' => 0,
-  'is_template' => 0,
-  'created_date' => '2014-09-28 23:20:52',
-  'is_share' => '1',
-  'is_confirm_enabled' => '1',
-  'available_places' => 0,
-  'is_full' => '1',
-);
+    'id' => '1',
+    'title' => 'Annual CiviCRM meet',
+    'event_title' => 'Annual CiviCRM meet',
+    'event_type_id' => '1',
+    'participant_listing_id' => 0,
+    'is_public' => '1',
+    'start_date' => '2008-10-21 00:00:00',
+    'event_start_date' => '2008-10-21 00:00:00',
+    'is_online_registration' => 0,
+    'max_participants' => '1',
+    'is_monetary' => 0,
+    'is_map' => 0,
+    'is_active' => '1',
+    'is_show_location' => '1',
+    'default_role_id' => '1',
+    'is_email_confirm' => 0,
+    'is_pay_later' => 0,
+    'is_partial_payment' => 0,
+    'is_multiple_registrations' => 0,
+    'allow_same_participant_emails' => 0,
+    'is_template' => 0,
+    'created_date' => '2015-02-16 11:40:40',
+    'is_share' => '1',
+    'is_confirm_enabled' => '1',
+    'is_billing_required' => 0,
+    'available_places' => 0,
+    'is_full' => '1',
+  );
 
   return $expectedResult;
 }
 
-
-/*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testGetSingleReturnIsFull and can be found in
+/**
+* This example has been generated from the API test suite.
+* The test that created it is called
+* testGetSingleReturnIsFull
+* and can be found in
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php
 *
 * You can see the outcome of the API tests at
@@ -74,7 +86,7 @@ function event_getsingle_expectedresult(){
 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
 * Browse the api on your own site with the api explorer
-* http://MYSITE.ORG/path/to/civicrm/api/explorer
+* http://MYSITE.ORG/path/to/civicrm/api
 *
 * Read more about testing here
 * http://wiki.civicrm.org/confluence/display/CRM/Testing