Merge pull request #9658 from eileenmcnaughton/comments

Comments

CRM/ACL/Form/WordPress/Permissions.php

@@ -134,7 +134,7 @@ public function postProcess() {
         // Get the permissions into a format that matches what we get from WP
         $allWarningPermissions = CRM_Core_Permission::getAnonymousPermissionsWarnings();
         foreach ($allWarningPermissions as $key => $permission) {
-          $allWarningPermissions[$key] = CRM_utils_String::munge(strtolower($permission));
+          $allWarningPermissions[$key] = CRM_Utils_String::munge(strtolower($permission));
         }
         $warningPermissions = array_intersect($allWarningPermissions, array_keys($rolePermissions));
         $warningPermissionNames = array();

CRM/Activity/Page/AJAX.php

@@ -389,6 +389,11 @@ public static function _convertToCaseActivity($params) {
     return (array('error_msg' => $error_msg, 'newId' => $mainActivity->id));
   }
 
+  /**
+   * Get activities for the contact.
+   *
+   * @return array
+   */
   public static function getContactActivity() {
     $requiredParameters = array(
       'cid' => 'Integer',

CRM/Activity/Tokens.php

@@ -45,6 +45,9 @@
  */
 class CRM_Activity_Tokens extends \Civi\Token\AbstractTokenSubscriber {
 
+  /**
+   * CRM_Activity_Tokens constructor.
+   */
   public function __construct() {
     parent::__construct('activity', array(
       'activity_id' => ts('Activity ID'),

CRM/Admin/Form/Setting/Component.php

@@ -115,7 +115,8 @@ public function postProcess() {
   }
 
   /**
-   * @param $dsn
+   * Load case sample data.
+   *
    * @param string $fileName
    * @param bool $lineMode
    */

CRM/Admin/Form/Setting/Localization.php

@@ -158,6 +158,11 @@ public static function formRule($fields) {
     return empty($errors) ? TRUE : $errors;
   }
 
+  /**
+   * Set the default values for the form.
+   *
+   * @return array
+   */
   public function setDefaultValues() {
     parent::setDefaultValues();
 
@@ -277,6 +282,8 @@ public static function getAvailableCountries() {
   }
 
   /**
+   * Get the default locale options.
+   *
    * @return array
    */
   public static function getDefaultLocaleOptions() {
@@ -319,6 +326,14 @@ public static function getCurrencySymbols() {
     return $_currencySymbols;
   }
 
+  /**
+   * Update session and uf_match table when the locale is updated.
+   *
+   * @param string $oldLocale
+   * @param string $newLocale
+   * @param array $metadata
+   * @param int $domainID
+   */
   public static function onChangeLcMessages($oldLocale, $newLocale, $metadata, $domainID) {
     if ($oldLocale == $newLocale) {
       return;

CRM/Batch/Form/Entry.php

@@ -109,7 +109,9 @@ public function preProcess() {
   }
 
   /**
-   * Used in test to set Batch ID
+   * Set Batch ID.
+   *
+   * @param int $id
    */
   public function setBatchID($id) {
     $this->_batchId = $id;

CRM/Campaign/Form/Search.php

@@ -175,8 +175,12 @@ public function preProcess() {
     CRM_Utils_System::setTitle(ts('Find Respondents To %1', array(1 => ucfirst($this->_operation))));
   }
 
+  /**
+   * Load the default survey for all actions.
+   *
+   * @return array
+   */
   public function setDefaultValues() {
-    //load the default survey for all actions.
     if (empty($this->_defaults)) {
       $defaultSurveyId = key(CRM_Campaign_BAO_Survey::getSurveys(TRUE, TRUE));
       if ($defaultSurveyId) {

CRM/Case/Form/Activity.php

@@ -341,7 +341,7 @@ public static function formRule($fields, $files, $self) {
       return TRUE;
     }
 
-    return parent::formrule($fields, $files, $self);
+    return parent::formRule($fields, $files, $self);
   }
 
   /**

CRM/Case/Form/Task/PDF.php

@@ -56,6 +56,11 @@ public function preProcess() {
     CRM_Contact_Form_Task_PDFLetterCommon::preProcess($this);
   }
 
+  /**
+   * Set defaults for the pdf.
+   *
+   * @return array
+   */
   public function setDefaultValues() {
     return CRM_Contact_Form_Task_PDFLetterCommon::setDefaultValues();
   }

CRM/Case/Form/Task/Print.php

@@ -41,7 +41,7 @@ class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task {
    * Build all the data structures needed to build the form.
    */
   public function preProcess() {
-    parent::preprocess();
+    parent::preProcess();
 
     // set print view, so that print templates are called
     $this->controller->setPrint(1);

CRM/Contact/Form/DedupeFind.php

@@ -71,6 +71,11 @@ public function buildQuickForm() {
     );
   }
 
+  /**
+   * Set the default values for the form.
+   *
+   * @return array
+   */
   public function setDefaultValues() {
     $this->_defaults['limit'] = Civi::settings()->get('dedupe_default_limit');
     return $this->_defaults;

CRM/Contact/Form/Task/Label.php

@@ -53,6 +53,8 @@ public function buildQuickForm() {
 
   /**
    * Common Function to build Mailing Label Form.
+   *
+   * @param CRM_Core_Form $form
    */
   public static function buildLabelForm($form) {
     CRM_Utils_System::setTitle(ts('Make Mailing Labels'));

CRM/Core/BAO/Country.php

@@ -152,6 +152,13 @@ public static function defaultCurrencySymbol($defaultCurrency = NULL) {
     return $cachedSymbol;
   }
 
+  /**
+   * Get the default currency symbol.
+   *
+   * @param string $k Unused variable
+   *
+   * @return string
+   */
   public static function getDefaultCurrencySymbol($k = NULL) {
     $config = CRM_Core_Config::singleton();
     return $config->defaultCurrencySymbol(Civi::settings()->get('defaultCurrency'));

CRM/Core/BAO/PrevNextCache.php

@@ -159,6 +159,16 @@ public static function deletePair($id1, $id2, $cacheKey = NULL, $isViceVersa = F
     CRM_Core_DAO::executeQuery($sql, $params);
   }
 
+  /**
+   * Mark contacts as being in conflict.
+   *
+   * @param int $id1
+   * @param int $id2
+   * @param string $cacheKey
+   * @param array $conflicts
+   *
+   * @return bool
+   */
   public static function markConflict($id1, $id2, $cacheKey, $conflicts) {
     if (empty($cacheKey) || empty($conflicts)) {
       return FALSE;

CRM/Core/BAO/UFGroup.php

@@ -943,8 +943,7 @@ public static function findContact(&$params, $id = NULL, $contactType = 'Individ
   }
 
   /**
-   * Given a contact id and a field set, return the values from the db
-   * for this contact
+   * Given a contact id and a field set, return the values from the db.
    *
    * @param int $cid
    * @param array $fields
@@ -958,6 +957,8 @@ public static function findContact(&$params, $id = NULL, $contactType = 'Individ
    * @param bool $absolute
    *   Return urls in absolute form (useful when sending an email).
    * @param null $additionalWhereClause
+   *
+   * @return null|array
    */
   public static function getValues(
     $cid, &$fields, &$values,

CRM/Core/CodeGen/DAO.php

@@ -49,6 +49,9 @@ public function needsUpdate() {
       $this->getRaw());
   }
 
+  /**
+   * Run generator.
+   */
   public function run() {
     echo "Generating {$this->name} as " . $this->getRelFileName() . "\n";
 
@@ -78,11 +81,18 @@ public function getRaw() {
     return $this->raw;
   }
 
+  /**
+   * Get relative file name.
+   *
+   * @return string
+   */
   public function getRelFileName() {
     return $this->tables[$this->name]['fileName'];
   }
 
   /**
+   * Get the absolute file name.
+   *
    * @return string
    */
   public function getAbsFileName() {

CRM/Core/CodeGen/Reflection.php

@@ -31,6 +31,9 @@ public function needsUpdate() {
   }
 
 
+  /**
+   * Run generator.
+   */
   public function run() {
     echo "Generating table list\n";
     $template = new CRM_Core_CodeGen_Util_Template('php');
@@ -55,12 +58,19 @@ public function getRaw() {
   }
 
   /**
+   * Get absolute file name.
+   *
    * @return string
    */
   protected function getAbsFileName() {
     return $this->config->CoreDAOCodePath . "AllCoreTables.data.php";
   }
 
+  /**
+   * Get the checksum for the schema.
+   *
+   * @return string
+   */
   protected function getSchemaChecksum() {
     if (!$this->checksum) {
       CRM_Utils_Array::flatten($this->tables, $flat);

CRM/Core/CodeGen/Schema.php

@@ -4,7 +4,11 @@
  * Create SQL files to create and populate a new schema.
  */
 class CRM_Core_CodeGen_Schema extends CRM_Core_CodeGen_BaseTask {
+
   /**
+   * CRM_Core_CodeGen_Schema constructor.
+   *
+   * @param \CRM_Core_CodeGen_Main $config
    */
   public function __construct($config) {
     parent::__construct($config);

CRM/Core/CodeGen/Util/Template.php

@@ -49,6 +49,8 @@ public function runConcat($inputs, $outpath) {
   }
 
   /**
+   * Run template generator.
+   *
    * @param string $infile
    *   Filename of the template, without a path.
    * @param string $outpath
@@ -68,6 +70,13 @@ public function run($infile, $outpath) {
     }
   }
 
+  /**
+   * Fetch via Smarty.
+   *
+   * @param string $infile
+   *
+   * @return string
+   */
   public function fetch($infile) {
     return $this->smarty->fetch($infile);
   }

CRM/Core/Config/MagicMerge.php

@@ -58,10 +58,16 @@ class CRM_Core_Config_MagicMerge {
 
   private $cache = array();
 
+  /**
+   * CRM_Core_Config_MagicMerge constructor.
+   */
   public function __construct() {
     $this->map = self::getPropertyMap();
   }
 
+  /**
+   * Set the map to the property map.
+   */
   public function __wakeup() {
     $this->map = self::getPropertyMap();
   }
@@ -204,6 +210,14 @@ public static function getPropertyMap() {
     );
   }
 
+  /**
+   * Get value.
+   *
+   * @param string $k
+   *
+   * @return mixed
+   * @throws \CRM_Core_Exception
+   */
   public function __get($k) {
     if (!isset($this->map[$k])) {
       throw new \CRM_Core_Exception("Cannot read unrecognized property CRM_Core_Config::\${$k}.");
@@ -281,6 +295,14 @@ public function __get($k) {
     }
   }
 
+  /**
+   * Set value.
+   *
+   * @param string $k
+   * @param mixed $v
+   *
+   * @throws \CRM_Core_Exception
+   */
   public function __set($k, $v) {
     if (!isset($this->map[$k])) {
       throw new \CRM_Core_Exception("Cannot set unrecognized property CRM_Core_Config::\${$k}");
@@ -311,10 +333,24 @@ public function __set($k, $v) {
     }
   }
 
+  /**
+   * Is value set.
+   *
+   * @param string $k
+   *
+   * @return bool
+   */
   public function __isset($k) {
     return isset($this->map[$k]);
   }
 
+  /**
+   * Unset value.
+   *
+   * @param string $k
+   *
+   * @throws \CRM_Core_Exception
+   */
   public function __unset($k) {
     if (!isset($this->map[$k])) {
       throw new \CRM_Core_Exception("Cannot unset unrecognized property CRM_Core_Config::\${$k}");
@@ -358,6 +394,9 @@ protected function getSettings() {
     return $this->settings;
   }
 
+  /**
+   * Initialise local settings.
+   */
   private function initLocals() {
     if ($this->locals === NULL) {
       $this->locals = array(

CRM/Core/Config/Runtime.php

@@ -138,6 +138,11 @@ public function initialize($loadFromDB = TRUE) {
     $this->initialized = 1;
   }
 
+  /**
+   * Exit processing after a fatal event, outputting the message.
+   *
+   * @param string $message
+   */
   private function fatal($message) {
     echo $message;
     exit();