INFRA-132 - Fix misc oddball syntax
authorTim Otten <totten@civicrm.org>
Fri, 9 Jan 2015 02:54:52 +0000 (18:54 -0800)
committerTim Otten <totten@civicrm.org>
Fri, 9 Jan 2015 03:57:25 +0000 (19:57 -0800)
21 files changed:
CRM/Activity/BAO/ActivityContact.php
CRM/Admin/Form/Preferences/Display.php
CRM/Bridge/OG/Drupal.php
CRM/Core/Payment.php
CRM/Core/Payment/AuthorizeNet.php
CRM/Core/Payment/Dummy.php
CRM/Core/Payment/FirstData.php
CRM/Core/Smarty/plugins/function.isValueChange.php
CRM/Core/Smarty/plugins/function.sectionTotal.php
CRM/Event/Form/Registration/Register.php
CRM/Financial/BAO/ExportFormat/CSV.php
CRM/Financial/BAO/ExportFormat/IIF.php
CRM/Member/BAO/Membership.php
CRM/Utils/String.php
api/v3/Generic.php
api/v3/Generic/Setvalue.php
api/v3/Group.php
api/v3/utils.php
tests/karma/unit/crmCaseTypeSpec.js
tests/karma/unit/crmJsonComparator.js
tests/karma/unit/crmMailingSpec.js

index f6bfceaad187905cf3c9f737e12cde5d9213e26b..78f24532012fbf9f9b735b5fa2902e22b016fc9f 100644 (file)
@@ -143,7 +143,6 @@ AND        civicrm_contact.is_deleted = 0
   /**
    * Get the links associate array  as defined by the links.ini file.
    *
-   *
    * Experimental... -
    * Should look a bit like
    *       [local_col_name] => "related_tablename:related_col_name"
index 9fcb4ed6385ec1a92fa7136ce33cbfb9889c2ccb..2e828005d2c4e6cfe662a06daf4034e4a3f6b315 100644 (file)
@@ -33,9 +33,8 @@
  *
  */
 
-/**r
- * This class generates form components for the display preferences
- *
+/**
+ * This class generates form components for the display preferences.
  */
 class CRM_Admin_Form_Preferences_Display extends CRM_Admin_Form_Preferences {
   public function preProcess() {
index 0f6b3b7e9b9451d24fe8b906da5adbcd09c7cceb..f6f4cd3cf13df98170188e406c4b76f5365c81e2 100644 (file)
@@ -33,7 +33,9 @@
  *
  */
 
-// d6 compatible
+/**
+ * d6 compatible?
+ */
 class CRM_Bridge_OG_Drupal {
 
   /**
index c52693c8e8539a996224609d09aaaeba096ba1b3..8192ae62befd07d511c886ebe76fed531298ef6e 100644 (file)
@@ -96,7 +96,6 @@ abstract class CRM_Core_Payment {
    *   Should we force a reload of this payment object.
    *
    * @return CRM_Core_Payment
-   * @return \CRM_Core_Payment
    * @throws \CRM_Core_Exception
    * @static
    */
index 5fe0710c569e7336e7ba1273a4c4adeb681b82d3..da76005dd2544cb308f09f432cf85071f29ff288 100644 (file)
@@ -13,7 +13,8 @@
  * @author Marshal Newrock <marshal@idealso.com>
  */
 
-/* NOTE:
+/**
+ * NOTE:
  * When looking up response codes in the Authorize.Net API, they
  * begin at one, so always delete one from the "Position in Response"
  */
index 93f07389c0675e662cd28183630426ca1477c47f..447a414eba32b7d2ca74781101a259ec5e548ed7 100644 (file)
@@ -14,9 +14,8 @@
  * $Id: Dummy.php 45429 2013-02-06 22:11:18Z lobo $
  */
 
-/* NOTE:
- * When looking up response codes in the Authorize.Net API, they
- * begin at one, so always delete one from the "Position in Response"
+/**
+ * Dummy payment processor
  */
 class CRM_Core_Payment_Dummy extends CRM_Core_Payment {
   const CHARSET = 'iso-8859-1';
index ff83bbe9f4234390677eb6ed32bc8ab26bf74f90..a0d106d585073761e45644a5e313d671a2befb5b 100644 (file)
  -----------------------------------------------------------------------------------------------
  **/
 
-/*From Payment processor documentation
-For testing purposes, you can use any of the card numbers listed below. The test card numbers
-will not result in any charges to the card. Use these card numbers with any expiration date in the
-future.
-     Visa Level 2 - 4275330012345675 (replies with a referral message)
-     JCB - 3566007770003510
-     Discover - 6011000993010978
-     MasterCard - 5424180279791765
-     Visa - 4005550000000019 or 4111111111111111
-     MasterCard Level 2 - 5404980000008386
-     Diners - 36555565010005
-     Amex - 372700997251009
-*
-***************************
-*Lines starting with CRM_Core_Error::debug_log_message output messages to files/upload/civicrm.log - you may with to comment them out once it is working satisfactorily
-
-*For live testing uncomment the result field below and set the value to the response you wish to get from the payment processor
-***************************/
+/**
+ * From Payment processor documentation
+ * For testing purposes, you can use any of the card numbers listed below. The test card numbers
+ * will not result in any charges to the card. Use these card numbers with any expiration date in the
+ * future.
+ *      Visa Level 2 - 4275330012345675 (replies with a referral message)
+ *      JCB - 3566007770003510
+ *      Discover - 6011000993010978
+ *      MasterCard - 5424180279791765
+ *      Visa - 4005550000000019 or 4111111111111111
+ *      MasterCard Level 2 - 5404980000008386
+ *      Diners - 36555565010005
+ *      Amex - 372700997251009
+ *
+ * **************************
+ * Lines starting with CRM_Core_Error::debug_log_message output messages to files/upload/civicrm.log - you may with to comment them out once it is working satisfactorily
+ *
+ * For live testing uncomment the result field below and set the value to the response you wish to get from the payment processor
+ * **************************
+ */
 class CRM_Core_Payment_FirstData extends CRM_Core_Payment {
   # (not used, implicit in the API, might need to convert?)
   const CHARSET = 'UFT-8';
index 96c67cd3535fad1fa5f5282ddda5a5f01e46dd3b..2e484bc2eafd420e42e498bf77cbc4c91599a2f8 100644 (file)
@@ -40,7 +40,6 @@
  * Smarty function for checking change in a property's value, for example
  * when looping through an array.
  *
- *
  * Smarty param:  string $key     unique identifier for this property (REQUIRED)
  * Smarty param:  mixed  $value   the current value of the property
  * Smarty param:  string $assign  name of template variable to which to assign result
index 89065a3427d65f722778979a57271979e0b8678b..66caa4a389c844395f84de25a316188b5a456988 100644 (file)
@@ -39,7 +39,6 @@
 /**
  * Smarty block function for printintg the correct report section total
  *
- *
  * Smarty param:  string $key     value of the current section column
  * Smarty param:  int    $depth   the depth of the current section
  *                                (sections declared first have lesser depth, starting at 0)
index 7a49e25293aacf90c2fe36ef7ce4a0a769900329..66681f472199b44f526c3d998cfdb33b27fa4d6e 100644 (file)
@@ -136,10 +136,9 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration {
    * The 'Register' page gets loaded through ajax and following happens :
    * the setDefaults function is called with the variable _ppType set with selected payment processor type,
    * so in the 'if' condition checked whether the selected payment processor's billing mode is of 'billing form mode'. If its not, don't setDefaults for billing form and return instead.
-   *- For payment processors of billing mode 'Notify' - return from setDefaults before the code for billing profile population execution .
+   * - For payment processors of billing mode 'Notify' - return from setDefaults before the code for billing profile population execution .
    * (done this is because for payment processors with 'Notify' mode billing profile form doesn't get rendered on UI)
    *
-   *
    * @return void
    */
   public function setDefaultValues() {
index 3959f3fcb189e6de93537ea51abd586a96acd22a..d9327ecd75e822efb854c82fd510b523e6783a5a 100644 (file)
  *
  */
 
-/*
- * @see http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+Specifications+-++Batches#CiviAccountsSpecifications-Batches-%C2%A0Overviewofimplementation
+/**
+ * @link http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+Specifications+-++Batches#CiviAccountsSpecifications-Batches-%C2%A0Overviewofimplementation
  */
-
 class CRM_Financial_BAO_ExportFormat_CSV extends CRM_Financial_BAO_ExportFormat {
 
   // For this phase, we always output these records too so that there isn't data referenced in the journal entries that isn't defined anywhere.
index 76891bcad5179eaaf83ee65ce0f7a5cbf00ca4ae..179fda8ab298181f6248f0cfb9334d56861fe8d3 100644 (file)
@@ -34,8 +34,8 @@
  *
  */
 
-/*
- * @see http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+Specifications+-++Batches#CiviAccountsSpecifications-Batches-%C2%A0Overviewofimplementation
+/**
+ * @link http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+Specifications+-++Batches#CiviAccountsSpecifications-Batches-%C2%A0Overviewofimplementation
  */
 class CRM_Financial_BAO_ExportFormat_IIF extends CRM_Financial_BAO_ExportFormat {
 
index 1b698a710577b14ed042b20e2ec36b75fad3f83b..0965af07bbe288a72caf772e6c4aa2c9bb1fa21f 100644 (file)
@@ -1477,15 +1477,13 @@ AND civicrm_membership.is_test = %2";
   /**
    * Function for updating a membership record's contribution_recur_id
    *
-   * @param object CRM_Member_DAO_Membership $membership
+   * @param CRM_Member_DAO_Membership $membership
    * @param \CRM_Contribute_BAO_Contribution|\CRM_Contribute_DAO_Contribution $contribution
    *
    * @return void
    * @static
    */
-  static public function updateRecurMembership(
-    CRM_Member_DAO_Membership $membership,
-                                               CRM_Contribute_BAO_Contribution $contribution) {
+  static public function updateRecurMembership(CRM_Member_DAO_Membership $membership, CRM_Contribute_BAO_Contribution $contribution) {
 
     if (empty($contribution->contribution_recur_id)) {
       return;
index 0379bf0eac3c2abbd86cb2eb50d5fc41b914e3ed..b5aef70a953cab5009c96d597e3b9958658921f3 100644 (file)
@@ -55,10 +55,8 @@ class CRM_Utils_String {
    *
    * @param int $maxLength
    *
-   * @return string  An equivalent variable name
-   *
-   *
-   * @return string (or null)
+   * @return string
+   *   An equivalent variable name.
    * @static
    */
   public static function titleToVar($title, $maxLength = 31) {
index 22936c54e4913dd2e95d6c6292dff4644eb655bb..00ce07b107b65431c2d9c96ccb0e65d66d6904e7 100644 (file)
@@ -104,7 +104,8 @@ function civicrm_api3_generic_getfields($apiRequest) {
           'title' => 'Context',
         ),
       );
-        break;
+      break;
+
     default:
       // oddballs are on their own
       $metadata = array();
index 7e6c705a666725a6018b5409a8ac533f57af1247..249abba7581dafe627703ad6a25eb90529049c8b 100644 (file)
@@ -48,23 +48,23 @@ function civicrm_api3_generic_setValue($apiRequest) {
       if (!is_numeric($value) && !empty($value) && $value !== 'null') {
         return civicrm_api3_create_error(ts('%1 must be a number.', array(1 => $title)), array('error_code' => 'NaN'));
       }
-    break;
+      break;
 
     case CRM_Utils_Type::T_INT:
       if (!CRM_Utils_Rule::integer($value) && !empty($value) && $value !== 'null') {
         return civicrm_api3_create_error(ts('%1 must be a number.', array(1 => $title)), array('error_code' => 'NaN'));
       }
-    break;
+      break;
 
     case CRM_Utils_Type::T_STRING:
     case CRM_Utils_Type::T_TEXT:
       if (!CRM_Utils_Rule::xssString($value)) {
         return civicrm_api3_create_error(ts('Illegal characters in input (potential scripting attack)'), array('error_code' => 'XSS'));
       }
-    if (array_key_exists('maxlength', $def)) {
-      $value = substr($value, 0, $def['maxlength']);
-    }
-    break;
+      if (array_key_exists('maxlength', $def)) {
+        $value = substr($value, 0, $def['maxlength']);
+      }
+      break;
 
     case CRM_Utils_Type::T_DATE:
       $value = CRM_Utils_Type::escape($value,"Date",false);
index 22f7e38eb07fd2b6cab675a0d414b8f72cace98b..510d1ab1f8a3ab5150e8b4386c2965053d9758c5 100644 (file)
@@ -48,8 +48,8 @@
  *                       name/value pairs to insert in new 'group'
  *
  * @return array  API result array
- *@example GroupCreate.php
- *{@getfields group_create}
+ * @example GroupCreate.php
+ * {@getfields group_create}
  * @access public
  */
 function civicrm_api3_group_create($params) {
@@ -105,8 +105,8 @@ function civicrm_api3_group_get($params) {
  *                       to be deleted
  *
  * @return array API result array
- *@example GroupDelete.php
- *{@getfields group_delete}
+ * @example GroupDelete.php
+ * {@getfields group_delete}
  *
  * @access public
  */
index 811194ddfe10a36eef940f24b128dd830a48812a..70858805b227dc1af0494f38d778a54815859bbd 100644 (file)
@@ -1125,9 +1125,9 @@ function formatCheckBoxField(&$checkboxFieldValue, $customFieldLabel, $entity) {
  *
  * @daoName string DAO to check params agains
  *
- * @return bool should the missing fields be returned as an array (core error created as default)
- *
- * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
+ * @return bool 
+ *   Sshould the missing fields be returned as an array (core error created as default)
+ *   true if all fields present, depending on $result a core error is created of an array of missing fields is returned
  * @access public
  */
 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
index 260a6e0dbb3e0ea6b8515afe582b768f3ba2a374..c4917626abaae5d377a5a4c493c6c6b5462a5e1b 100644 (file)
@@ -65,7 +65,7 @@ describe('crmCaseType', function() {
               "id": "784",
               "option_group_id": "2",
               "label": "ADC referral",
-              "value": "62", 
+              "value": "62",
               "name": "ADC referral",
               "filter": "0",
               "is_default": "0",
@@ -89,7 +89,7 @@ describe('crmCaseType', function() {
               "is_reserved": "1",
               "is_active": "1",
               "component_id": "7"
-            } 
+            }
           }
         },
         'relTypes': {
@@ -136,7 +136,7 @@ describe('crmCaseType', function() {
             ],
             "activitySets": [
               {
-                "name": "standard_timeline", 
+                "name": "standard_timeline",
                 "label": "Standard Timeline",
                 "timeline": "1",
                 "activityTypes": [
index 8380ba7951a663d0e65f75efa6cb6cc00f8d3003..d4b668cf4fea854acc1ddc5af051acd12dba29f8 100644 (file)
@@ -10,7 +10,7 @@ describe('crmJsonComparator', function() {
   beforeEach(function() {
     inject(function(crmJsonComparator) {
       comparator = crmJsonComparator;
-    }); 
+    });
   });
 
   it('should return false when comparing different objects', function() {
@@ -23,7 +23,7 @@ describe('crmJsonComparator', function() {
     expect(result.pass).toBe(true);
   });
 
-  it('should explain what part of the comparison failed when comparing objects', function() { 
+  it('should explain what part of the comparison failed when comparing objects', function() {
     var result = comparator.compare({'foo': 'bar'}, {'bar': 'foo'});
     expect(result.message).toBe('Could not find key \'bar\' in actual data at root.');
   });
index 8d35904988b0d3343a3c0f1a7d7f28630846ccb1..db795bfaeb6122a915b0241d413b28f801fb53c8 100644 (file)
@@ -14,7 +14,7 @@ describe('crmMailing', function() {
     beforeEach(function() {
       navigator = jasmine.createSpyObj('crmNavigator', ['redirect']);
       module(function ($provide) {
-        $provide.value('crmNavigator', navigator) 
+        $provide.value('crmNavigator', navigator)
       });
       inject(['crmLegacy', function(crmLegacy) {
         crmLegacy.url({back: '/*path*?*query*', front: '/*path*?*query*'});