Code cleanup - Batch civicrm#9

CRM/Admin/Form/Preferences/Address.php

@@ -43,8 +43,8 @@ public function preProcess() {
 
     // Address Standardization
     $addrProviders = array(
-        '' => '- select -'
-      ) + CRM_Core_SelectValues::addressProvider();
+      '' => '- select -',
+    ) + CRM_Core_SelectValues::addressProvider();
 
     $this->_varNames = array(
       CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME => array(

CRM/Admin/Form/Setting/Mapping.php

@@ -88,8 +88,6 @@ public static function formRule($fields) {
    * add the rules (mainly global rules) for form.
    * All local rules are added near the element
    *
-   * @param null
-   *
    * @return void
    */
   public function addRules() {

CRM/Admin/Page/AJAX.php

@@ -115,7 +115,7 @@ public static function getStatusMsg() {
             $ret['illegal'] = TRUE;
             $table = $template->fetch('CRM/Price/Page/table.tpl');
             $ret['content'] = ts('Unable to disable the \'%1\' price set - it is currently in use by one or more active events, contribution pages or contributions.', array(
-                1 => $priceSet
+                1 => $priceSet,
               )) . "<br/> $table";
           }
           else {

CRM/Contact/Form/Edit/Address.php

@@ -74,7 +74,7 @@ public static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharin
     //make location type required for inline edit
     $form->addSelect("address[$blockId][location_type_id]", array(
         'entity' => 'address',
-        'class' => 'eight'
+        'class' => 'eight',
       ) + $js, $inlineEdit);
 
     if (!$inlineEdit) {
@@ -118,12 +118,12 @@ public static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharin
       'postal_code' => array(
         ts('Zip / Postal Code'),
         array_merge($attributes['postal_code'], array('class' => 'crm_postal_code')),
-        NULL
+        NULL,
       ),
       'postal_code_suffix' => array(
         ts('Postal Code Suffix'),
         array('size' => 4, 'maxlength' => 12, 'class' => 'crm_postal_code_suffix'),
-        NULL
+        NULL,
       ),
       'country_id' => array(ts('Country'), $attributes['country_id'], 'country'),
       'state_province_id' => array(ts('State/Province'), $attributes['state_province_id'], NULL),
@@ -144,7 +144,7 @@ public static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharin
         if (in_array($nameWithoutID, array(
             'street_number',
             'street_name',
-            'street_unit'
+            'street_unit',
           )) && !empty($addressOptions['street_address_parsing'])
         ) {
           $continue = FALSE;
@@ -265,7 +265,7 @@ public static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharin
       $profileLinks = CRM_Core_BAO_UFGroup::getCreateLinks(array(
           'new_individual',
           'new_organization',
-          'new_household'
+          'new_household',
         ), 'shared_address');
       $form->addEntityRef("address[$blockId][master_contact_id]", ts('Share With'), array('create' => $profileLinks));
     }
@@ -359,7 +359,7 @@ public static function setDefaultValues(&$defaults, &$form) {
             'name' => $shareAddressContactNames[$addressValue['master_id']]['name'],
             'options' => CRM_Core_BAO_Address::getValues(array(
                 'entity_id' => $master_cid,
-                'contact_id' => $master_cid
+                'contact_id' => $master_cid,
               )),
             'master_id' => $addressValue['master_id'],
           );
@@ -387,11 +387,11 @@ public static function setDefaultValues(&$defaults, &$form) {
                      'street_number',
                      'street_number_suffix',
                      'street_name',
-                     'street_unit'
+                     'street_unit',
                    ) as $fld) {
             if (in_array($fld, array(
               'street_name',
-              'street_unit'
+              'street_unit',
             ))) {
               $streetAddress .= ' ';
             }

CRM/Contact/Form/Search/Custom.php

@@ -70,7 +70,7 @@ public function preProcess() {
         'url' => CRM_Utils_System::url('civicrm/contact/search/custom/list',
           'reset=1'
         ),
-      )
+      ),
     );
     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 

CRM/Contact/Form/Task/Result.php

@@ -54,7 +54,7 @@ public function preProcess() {
     $context = $this->get('context');
     if (in_array($context, array(
       'smog',
-      'amtg'
+      'amtg',
     ))) {
       $urlParams = 'reset=1&force=1&context=smog&gid=';
       $urlParams .= ($context == 'smog') ? $this->get('gid') : $this->get('amtgID');
@@ -94,7 +94,6 @@ public function preProcess() {
 
     $url = CRM_Utils_System::url('civicrm/contact/' . $fragment, $path);
     $session->replaceUserContext($url);
-    return;
   }
 
   /**

CRM/Contact/Import/Parser/Contact.php

@@ -102,7 +102,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser {
   /**
    * Class constructor
    */
-  function __construct(
+  public function __construct(
     &$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL, $mapperImProvider = NULL, $mapperRelated = NULL, $mapperRelatedContactType = NULL, $mapperRelatedContactDetails = NULL, $mapperRelatedContactLocType = NULL, $mapperRelatedContactPhoneType = NULL, $mapperRelatedContactImProvider = NULL,
     $mapperWebsiteType = NULL, $mapperRelatedContactWebsiteType = NULL
   ) {
@@ -148,8 +148,8 @@ public function init() {
     }
 
     //Relationship importables
-    $this->_relationships = $relations =
-      CRM_Contact_BAO_Relationship::getContactRelationshipType(
+    $this->_relationships = $relations
+      = CRM_Contact_BAO_Relationship::getContactRelationshipType(
         NULL, NULL, NULL, $this->_contactType,
         FALSE, 'label', TRUE, $this->_contactSubType
       );
@@ -250,7 +250,7 @@ public function init() {
    * @param array $values
    *   The array of values belonging to this line.
    *
-   * @return boolean
+   * @return bool
    */
   public function mapField(&$values) {
     return CRM_Import_Parser::VALID;
@@ -262,7 +262,7 @@ public function mapField(&$values) {
    * @param array $values
    *   The array of values belonging to this line.
    *
-   * @return boolean
+   * @return bool
    *   the result of this processing
    */
   public function preview(&$values) {
@@ -275,7 +275,7 @@ public function preview(&$values) {
    * @param array $values
    *   The array of values belonging to this line.
    *
-   * @return boolean
+   * @return boo
    *   the result of this processing
    */
   public function summary(&$values) {
@@ -449,7 +449,7 @@ public function summary(&$values) {
    *
    * @param bool $doGeocodeAddress
    *
-   * @return boolean
+   * @return bool
    *   the result of this processing
    */
   public function import($onDuplicate, &$values, $doGeocodeAddress = FALSE) {
@@ -1013,8 +1013,6 @@ public function import($onDuplicate, &$values, $doGeocodeAddress = FALSE) {
           $newContact = $this->createContact($formatted, $contactFields, $onDuplicate, $contactId);
         }
         // else skip does nothing and just returns an error code.
-
-
         if ($cid) {
           $contact = array(
             'contact_id' => $cid,

CRM/Contribute/BAO/Query.php

@@ -138,7 +138,7 @@ public static function select(&$query) {
 
     // get payment instrument id
     if (!empty($query->_returnProperties['payment_instrument_id'])) {
-      $query->_select['instrument_id'] =  "contribution_payment_instrument.value as instrument_id";
+      $query->_select['instrument_id'] = "contribution_payment_instrument.value as instrument_id";
       $query->_select['payment_instrument_id'] = "contribution_payment_instrument.value as payment_instrument_id";
       $query->_element['instrument_id'] = $query->_element['payment_instrument_id'] = 1;
       $query->_tables['civicrm_contribution'] = 1;
@@ -362,7 +362,7 @@ public static function whereClauseSingle(&$values, &$query) {
 
       case 'financial_type':
         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fields[$name]['where'], $op, $value, 'String');
-        CRM_Core_Error::debug( '$query', $query->_where[$grouping] );
+        CRM_Core_Error::debug('$query', $query->_where[$grouping]);
         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
@@ -876,7 +876,7 @@ public static function buildSearchForm(&$form) {
     $form->add('select', 'contribution_currency_type',
       ts('Currency Type'),
       array(
-        '' => ts('- any -')
+        '' => ts('- any -'),
       ) +
       CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name')),
       FALSE, array('class' => 'crm-select2')
@@ -890,7 +890,7 @@ public static function buildSearchForm(&$form) {
     $form->add('select', 'contribution_page_id',
       ts('Contribution Page'),
       array(
-        '' => ts('- any -')
+        '' => ts('- any -'),
       ) +
       CRM_Contribute_PseudoConstant::contributionPage(),
       FALSE, array('class' => 'crm-select2')
@@ -903,7 +903,7 @@ public static function buildSearchForm(&$form) {
     $form->add('select', 'contribution_pcp_made_through_id',
       ts('Personal Campaign Page'),
       array(
-        '' => ts('- any -')
+        '' => ts('- any -'),
       ) +
       CRM_Contribute_PseudoConstant::pcPage(),
       FALSE, array('class' => 'crm-select2')
@@ -1038,7 +1038,7 @@ public static function tableNames(&$tables) {
   public static function buildDateWhere(&$values, $query, $name, $field, $title) {
     $fieldPart = strpos($name, $field);
     if ($fieldPart === FALSE) {
-      return;
+      return NULL;
     }
     // we only have recurring dates using this ATM so lets' short cut to find the table name
     $table = 'contribution_recur';

CRM/Contribute/Form/CancelSubscription.php

@@ -125,8 +125,8 @@ public function preProcess() {
     $this->assign('mode', $this->_mode);
 
     if ($this->_subscriptionDetails->contact_id) {
-      list($this->_donorDisplayName, $this->_donorEmail) =
-        CRM_Contact_BAO_Contact::getContactDetails($this->_subscriptionDetails->contact_id);
+      list($this->_donorDisplayName, $this->_donorEmail)
+        = CRM_Contact_BAO_Contact::getContactDetails($this->_subscriptionDetails->contact_id);
     }
   }
 
@@ -186,8 +186,6 @@ public function buildQuickForm() {
    * Set default values for the form. Note that in edit/view mode
    * the default values are retrieved from the database
    *
-   * @param null
-   *
    * @return array
    *   array of default values
    */
@@ -227,8 +225,8 @@ public function postProcess() {
       CRM_Core_Error::displaySessionError($cancelSubscription);
     }
     elseif ($cancelSubscription) {
-      $activityParams =
-        array(
+      $activityParams
+        = array(
           'subject' => $this->_mid ? ts('Auto-renewal membership cancelled') : ts('Recurring contribution cancelled'),
           'details' => $message,
         );
@@ -244,10 +242,10 @@ public function postProcess() {
           $inputParams = array('id' => $this->_mid);
           CRM_Member_BAO_Membership::getValues($inputParams, $tplParams);
           $tplParams = $tplParams[$this->_mid];
-          $tplParams['membership_status'] =
-            CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
-          $tplParams['membershipType'] =
-            CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
+          $tplParams['membership_status']
+            = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
+          $tplParams['membershipType']
+            = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
           $status = ts('The automatic renewal of your %1 membership has been cancelled as requested. This does not affect the status of your membership - you will receive a separate notification when your membership is up for renewal.', array(1 => $tplParams['membershipType']));
           $msgTitle = 'Membership Renewal Cancelled';
           $msgType = 'info';
@@ -277,9 +275,8 @@ public function postProcess() {
               $value,
               array('title', 'receipt_from_name', 'receipt_from_email')
             );
-            $receiptFrom =
-              '"' .
-              CRM_Utils_Array::value('receipt_from_name', $value[$this->_subscriptionDetails->contribution_page_id]) .
+            $receiptFrom
+              = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$this->_subscriptionDetails->contribution_page_id]) .
               '" <' .
               $value[$this->_subscriptionDetails->contribution_page_id]['receipt_from_email'] .
               '>';
@@ -290,8 +287,8 @@ public function postProcess() {
           }
 
           // send notification
-          $sendTemplateParams =
-            array(
+          $sendTemplateParams
+            = array(
               'groupName' => $this->_mode == 'auto_renew' ? 'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
               'valueName' => $this->_mode == 'auto_renew' ? 'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
               'contactId' => $this->_subscriptionDetails->contact_id,
@@ -328,11 +325,12 @@ public function postProcess() {
       $session->setStatus($status, $msgTitle, $msgType);
     }
     elseif (!$userID) {
-      if ($status)
+      if ($status) {
         CRM_Utils_System::setUFMessage($status);
-      // keep result as 1, since we not displaying anything on the redirected page anyway
-      return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
+        // keep result as 1, since we not displaying anything on the redirected page anyway
+        return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
         "reset=1&task=cancel&result=1"));
+      }
     }
   }
 }

CRM/Core/BAO/Email.php

@@ -117,7 +117,7 @@ public static function add(&$params) {
    * @param array $entityBlock
    *   Input parameters to find object.
    *
-   * @return boolean
+   * @return bool
    */
   public static function &getValues($entityBlock) {
     return CRM_Core_BAO_Block::getValues('email', $entityBlock);

CRM/Core/BAO/LabelFormat.php

@@ -157,8 +157,6 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get page orientations recognized by the DOMPDF package used to create PDF letters.
    *
-   * @param void
-   *
    * @return array
    *   array of page orientations
    */
@@ -186,8 +184,6 @@ public static function getFontNames($name = 'label_format') {
   /**
    * Get font sizes supported by the TCPDF package used to create PDF labels.
    *
-   * @param void
-   *
    * @return array
    *   array of font sizes
    */
@@ -203,8 +199,6 @@ public static function getFontSizes() {
   /**
    * Get measurement units recognized by the TCPDF package used to create PDF labels.
    *
-   * @param void
-   *
    * @return array
    *   array of measurement units
    */
@@ -220,8 +214,6 @@ public static function getUnits() {
   /**
    * Get text alignment recognized by the TCPDF package used to create PDF labels.
    *
-   * @param void
-   *
    * @return array
    *   array of alignments
    */
@@ -236,8 +228,6 @@ public static function getTextAlignments() {
   /**
    * Get text alignment recognized by the TCPDF package used to create PDF labels.
    *
-   * @param void
-   *
    * @return array
    *   array of alignments
    */
@@ -280,6 +270,7 @@ private static function _getGid($name = 'label_format') {
   public static function addOrder(&$list, $returnURL) {
     $filter = "option_group_id = " . self::_getGid();
     CRM_Utils_Weight::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
+    return $list;
   }
 
   /**
@@ -462,8 +453,6 @@ public static function retrieve(&$params, &$values, $groupName = 'label_format')
   /**
    * Return the name of the group for customized labels
    *
-   * @param void
-   *
    * @return void
    */
   public static function customGroupName() {