Merge pull request #9717 from eileenmcnaughton/comments

[nfc] Comment fixes, remove one unused var, declare visibility

CRM/ACL/Form/EntityRole.php

@@ -42,8 +42,6 @@ public function buildQuickForm() {
       return;
     }
 
-    $attributes = CRM_Core_DAO::getAttribute('CRM_ACL_DAO_EntityRole');
-
     $aclRoles = array('' => ts('- select -')) + CRM_Core_OptionGroup::values('acl_role');
     $this->add('select', 'acl_role_id', ts('ACL Role'),
       $aclRoles, TRUE

CRM/Campaign/BAO/Survey.php

@@ -304,6 +304,8 @@ public static function getSurveys($onlyActive = TRUE, $onlyDefault = FALSE, $for
    *
    * @param string $returnColumn
    * @param bool $includePetitionActivityType
+   *
+   * @return string
    */
   public static function getSurveyActivityType($returnColumn = 'label', $includePetitionActivityType = FALSE) {
     static $activityTypes;

CRM/Contact/BAO/Contact.php

@@ -785,6 +785,7 @@ public static function displayName($id) {
    *   Whether to actually restore, not delete.
    * @param bool $skipUndelete
    *   Whether to force contact delete or not.
+   * @param bool $checkPermissions
    *
    * @return bool
    *   Was contact deleted?

CRM/Contact/Import/ImportJob.php

@@ -342,9 +342,12 @@ public function setFormVariables($form) {
   }
 
   /**
-   * @param $contactIds
+   * Add imported contacts.
+   *
+   * @param array $contactIds
    * @param string $newGroupName
-   * @param $newGroupDesc
+   * @param string $newGroupDesc
+   * @param string $newGroupType
    *
    * @return array|bool
    */

CRM/Core/DAO/permissions.php

@@ -201,7 +201,7 @@ function _civicrm_api3_permissions($entity, $action, &$params) {
     'get' => array('access CiviCRM'),
     'default' => array(
       // nested array = OR
-      array('administer CiviCampaign', 'manage campaign')
+      array('administer CiviCampaign', 'manage campaign'),
     ),
   );
   $permissions['survey'] = $permissions['campaign'];

CRM/Core/Payment/AuthorizeNetIPN.php

@@ -58,8 +58,7 @@ public function main($component = 'contribute') {
     $ids = $objects = $input = array();
 
     if ($x_subscription_id) {
-      //Approved
-
+      // Presence of the id means it is approved.
       $input['component'] = $component;
 
       // load post vars in $input
@@ -213,8 +212,10 @@ public function recur(&$input, &$ids, &$objects, $first) {
   }
 
   /**
-   * @param $input
-   * @param $ids
+   * Get the input from passed in fields.
+   *
+   * @param array $input
+   * @param array $ids
    *
    * @return bool
    */
@@ -258,8 +259,12 @@ public function getInput(&$input, &$ids) {
   }
 
   /**
-   * @param $ids
-   * @param $input
+   * Get ids from input.
+   *
+   * @param array $ids
+   * @param array $input
+   *
+   * @throws \CRM_Core_Exception
    */
   public function getIDs(&$ids, &$input) {
     $ids['contact'] = $this->retrieve('x_cust_id', 'Integer', FALSE, 0);
@@ -298,8 +303,6 @@ public function getIDs(&$ids, &$input) {
       // FIXME: figure out fields for event
     }
     else {
-      // get the optional ids
-
       // Get membershipId. Join with membership payment table for additional checks
       $sql = "
     SELECT m.id

CRM/Core/Payment/PayPalImpl.php

@@ -191,6 +191,7 @@ public function validatePaymentInstrument($values, &$errors) {
    *
    * @return array
    *   the result in an nice formatted array (or an error object)
+   * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
   protected function setExpressCheckOut(&$params) {
     $args = array();

CRM/Financial/BAO/FinancialType.php

@@ -370,6 +370,7 @@ public static function buildPermissionedClause(&$whereClauses, $component = NULL
    *   the mode of operation, can be add, view, edit, delete
    * @param bool $force
    *
+   * @return bool
    */
   public static function checkPermissionedLineItems($id, $op, $force = TRUE) {
     if (!self::isACLFinancialTypeStatus()) {

CRM/Mailing/BAO/MailingJob.php

@@ -55,9 +55,12 @@ public function __construct() {
   }
 
   /**
+   * Create mailing job.
+   *
    * @param array $params
    *
-   * @return CRM_Mailing_BAO_MailingJob
+   * @return \CRM_Mailing_BAO_MailingJob
+   * @throws \CRM_Core_Exception
    */
   static public function create($params) {
     $job = new CRM_Mailing_BAO_MailingJob();
@@ -78,10 +81,12 @@ static public function create($params) {
   }
 
   /**
-   * Initiate all pending/ready jobs
+   * Initiate all pending/ready jobs.
    *
    * @param array $testParams
-   * @param null $mode
+   * @param string $mode
+   *
+   * @return bool|null
    */
   public static function runJobs($testParams = NULL, $mode = NULL) {
     $job = new CRM_Mailing_BAO_MailingJob();

CRM/Mailing/Event/BAO/Reply.php

@@ -62,7 +62,6 @@ public function __construct() {
    */
   public static function &reply($job_id, $queue_id, $hash, $replyto = NULL) {
     // First make sure there's a matching queue event.
-
     $q = CRM_Mailing_Event_BAO_Queue::verify($job_id, $queue_id, $hash);
 
     $success = NULL;
@@ -255,7 +254,6 @@ private static function autoRespond(&$mailing, $queue_id, $replyto) {
     );
 
     // TODO: do we need reply tokens?
-
     $html = $component->body_html;
     if ($component->body_text) {
       $text = $component->body_text;

CRM/UF/Form/AdvanceSetting.php

@@ -29,18 +29,13 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2017
- * $Id$
- *
  */
 class CRM_UF_Form_AdvanceSetting extends CRM_UF_Form_Group {
 
   /**
-   * Build the form object for Advance Settings.
-   *
+   * Build the form object for Advanced Settings.
    *
    * @param CRM_Core_Form $form
-   *
-   * @return void
    */
   public static function buildAdvanceSetting(&$form) {
     // should mapping be enabled for this group

CRM/UF/Page/Field.php

@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2017
- * $Id$
- *
  */
 
 /**

CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php

@@ -208,7 +208,7 @@ public function links() {
    *
    * @return array
    */
-  static function &fields() {
+  public static function &fields() {
     if (!(self::$_fields)) {
       self::$_fields = array(
         'id' => array(

CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php

@@ -180,7 +180,7 @@ public function links() {
    *
    * @return array
    */
-  static function &fields() {
+  public static function &fields() {
     if (!(self::$_fields)) {
       self::$_fields = array(
         'id' => array(

CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php

@@ -168,7 +168,7 @@ public function links() {
    *
    * @return array
    */
-  static function &fields() {
+  public static function &fields() {
     if (!(self::$_fields)) {
       self::$_fields = array(
         'id' => array(

CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php

@@ -180,7 +180,7 @@ public function links() {
    *
    * @return array
    */
-  static function &fields() {
+  public static function &fields() {
     if (!(self::$_fields)) {
       self::$_fields = array(
         'id' => array(

CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php

@@ -131,7 +131,7 @@ public function links() {
    *
    * @return array
    */
-  static function &fields() {
+  pubic static function &fields() {
     if (!(self::$_fields)) {
       self::$_fields = array(
         'id' => array(