Add comma on multiline array, reformat some commas.
authorChris Burgess <chris@giantrobot.co.nz>
Sun, 18 Sep 2016 23:42:48 +0000 (11:42 +1200)
committerChris Burgess <chris@giantrobot.co.nz>
Sun, 18 Sep 2016 23:42:48 +0000 (11:42 +1200)
api/v3/LocBlock.php

index 868ddd0a1f8a23e2c14be0b1880bafd3b2abf507..2d2544aa18530813db485d7669c740109f49117f 100644 (file)
@@ -25,7 +25,6 @@
  +--------------------------------------------------------------------+
  */
 
-
 /**
  * This api exposes CiviCRM LocBlock records.
  *
@@ -36,7 +35,7 @@
  * Create or update a LocBlock.
  *
  * @param array $params
- *   name/value pairs to insert in new 'LocBlock'
+ *   Name/value pairs to insert in new 'LocBlock'.
  *
  * @return array
  *   API result array.
@@ -53,7 +52,7 @@ function civicrm_api3_loc_block_create($params) {
     'im',
     'im_id',
     'email',
-    'email_id'
+    'email_id',
   );
   civicrm_api3_verify_one_mandatory($params, NULL, $any_mandatory);
   // Call the appropriate api to create entities if any are passed in the params.
@@ -65,11 +64,11 @@ function civicrm_api3_loc_block_create($params) {
       $key = $item . $suf;
       if (!empty($params[$key]) && is_array($params[$key])) {
         $info = $params[$key];
-        // If all we get is an id don't bother calling the api
+        // If all we get is an id don't bother calling the api.
         if (count($info) == 1 && !empty($info['id'])) {
           $params[$key . '_id'] = $info['id'];
         }
-        // Bother calling the api
+        // Bother calling the api.
         else {
           $info['contact_id'] = CRM_Utils_Array::value('contact_id', $info, 'null');
           $result = civicrm_api3($item, 'create', $info);
@@ -95,7 +94,7 @@ function civicrm_api3_loc_block_create($params) {
  *
  * @param array $params
  *   Array of one or more valid property_name=>value pairs. If $params is set.
- *   as null, all loc_blocks will be returned (default limit is 25)
+ *   as null, all loc_blocks will be returned (default limit is 25).
  *
  * @return array
  *   API result array.
@@ -103,7 +102,7 @@ function civicrm_api3_loc_block_create($params) {
 function civicrm_api3_loc_block_get($params) {
   $options = _civicrm_api3_get_options_from_params($params);
   // If a return param has been set then fetch the appropriate fk objects
-  // This is a helper because api chaining does not work with a key like 'email_2'
+  // This is a helper because api chaining does not work with a key like 'email_2'.
   if (!empty($options['return'])) {
     unset($params['return']);
     $values = array();