INFRA-132 - Comment grammar cleanup

[civicrm-core.git] / CRM / Core / BAO / PaperSize.php

diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php
index f19d1496dd7c8678167749b988c87001b1338fd8..bfce94cdb8ce4960fb13c70525c81c0f09bea08e 100644 (file)
--- a/CRM/Core/BAO/PaperSize.php
+++ b/CRM/Core/BAO/PaperSize.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright (C) 2011 Marty Wright                                    |
  | Licensed to CiviCRM under the Academic Free License version 3.0.   |
@@ -73,7 +73,6 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param void
    *
    * @return int  Group ID (null if Group ID doesn't exist)
-   * @access private
    */
   private static function _getGid() {
     if (!self::$_gid) {
@@ -88,14 +87,14 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Add ordering fields to Paper Size list
    *
-   * @param array (reference)   $list         List of Paper Sizes
-   * @param string              $returnURL    URL of page calling this function
+   * @param array (reference) $list List of Paper Sizes
+   * @param string $returnURL
+   *   URL of page calling this function.
    *
    * @return array  (reference)   List of Paper Sizes
    * @static
-   * @access public
    */
-  static function &addOrder(&$list, $returnURL) {
+  public static function &addOrder(&$list, $returnURL) {
     $filter = "option_group_id = " . self::_getGid();
     CRM_Utils_Weight::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
   }
@@ -103,13 +102,13 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Retrieve list of Paper Sizes.
    *
-   * @param bool    $namesOnly    return simple list of names
+   * @param bool $namesOnly
+   *   Return simple list of names.
    *
    * @return array  (reference)   Paper Size list
    * @static
-   * @access public
    */
-  static function &getList($namesOnly = FALSE) {
+  public static function &getList($namesOnly = FALSE) {
     static $list = array();
     if (self::_getGid()) {
       // get saved Paper Sizes from Option Value table
@@ -137,9 +136,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    *
    * @return array   Name/value pairs containing the default Paper Size values.
    * @static
-   * @access public
    */
-  static function &getDefaultValues() {
+  public static function &getDefaultValues() {
     $params = array('is_active' => 1, 'is_default' => 1);
     $defaults = array();
     if (!self::retrieve($params, $defaults)) {
@@ -155,13 +153,14 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Get Paper Size from the DB
    *
-   * @param string $field   Field name to search by
-   * @param int    $val     Field value to search for
+   * @param string $field
+   *   Field name to search by.
+   * @param int $val
+   *   Field value to search for.
    *
    * @return array  $values (reference) associative array of name/value pairs
-   * @access public
    */
-  static function &getPaperFormat($field, $val) {
+  public static function &getPaperFormat($field, $val) {
     $params = array('is_active' => 1, $field => $val);
     $paperFormat = array();
     if (self::retrieve($params, $paperFormat)) {
@@ -175,41 +174,41 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Get Paper Size by Name
    *
-   * @param int    $name   Paper Size name. Empty = get default Paper Size
+   * @param int $name
+   *   Paper Size name. Empty = get default Paper Size.
    *
    * @return array  $values (reference) associative array of name/value pairs
-   * @access public
    */
-  static function &getByName($name) {
+  public static function &getByName($name) {
     return self::getPaperFormat('name', $name);
   }
 
   /**
    * Get Paper Size by ID
    *
-   * @param int    $id   Paper Size id. 0 = get default Paper Size
+   * @param int $id
+   *   Paper Size id. 0 = get default Paper Size.
    *
    * @return array  $values (reference) associative array of name/value pairs
-   * @access public
    */
-  static function &getById($id) {
+  public static function &getById($id) {
     return self::getPaperFormat('id', $id);
   }
 
   /**
    * Get Paper Size field from associative array
    *
-   * @param string $field name of a Paper Size field
+   * @param string $field
+   *   Name of a Paper Size field.
    * @param array (reference) $values associative array of name/value pairs containing
    *                                           Paper Size field selections
    *
    * @param null $default
    *
    * @return value
-   * @access public
    * @static
    */
-  static function getValue($field, &$values, $default = NULL) {
+  public static function getValue($field, &$values, $default = NULL) {
     if (array_key_exists($field, self::$optionValueFields)) {
       switch (self::$optionValueFields[$field]['type']) {
         case CRM_Utils_Type::T_INT:
@@ -233,14 +232,15 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * retrieves the relevant objects. Typically the valid params are only
    * paper size id. It also stores all the retrieved values in the default array.
    *
-   * @param array $params   (reference ) an assoc array of name/value pairs
-   * @param array $values   (reference ) an assoc array to hold the flattened values
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $values
+   *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Core_DAO_OptionValue object
-   * @access public
    * @static
    */
-  static function retrieve(&$params, &$values) {
+  public static function retrieve(&$params, &$values) {
     $optionValue = new CRM_Core_DAO_OptionValue();
     $optionValue->copyValues($params);
     $optionValue->option_group_id = self::_getGid();
@@ -269,13 +269,13 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Save the Paper Size in the DB
    *
-   * @param array (reference)   $values    associative array of name/value pairs
-   * @param int                 $id        id of the database record (null = new record)
+   * @param array (reference) $values associative array of name/value pairs
+   * @param int $id
+   *   Id of the database record (null = new record).
    *
    * @return void
-   * @access public
    */
-  function savePaperSize(&$values, $id) {
+  public function savePaperSize(&$values, $id) {
     // get the Option Group ID for Paper Sizes (create one if it doesn't exist)
     $group_id = self::_getGid(TRUE);
 
@@ -329,12 +329,12 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Delete a Paper Size
    *
-   * @param  int  $id     ID of the Paper Size to be deleted.
+   * @param int $id
+   *   ID of the Paper Size to be deleted.
    *
-   * @access public
    * @static
    */
-  static function del($id) {
+  public static function del($id) {
     if ($id) {
       $dao = new CRM_Core_DAO_OptionValue();
       $dao->id = $id;
@@ -350,4 +350,3 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
   }
 }
-