Merge pull request #4950 from atif-shaikh/CRM-15826

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

diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php
index bfce94cdb8ce4960fb13c70525c81c0f09bea08e..2608314c1965e9053903fa8fe124ab7cba0e5f8b 100644 (file)
--- a/CRM/Core/BAO/PaperSize.php
+++ b/CRM/Core/BAO/PaperSize.php
@@ -70,9 +70,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Get Option Group ID for Paper Sizes
    *
-   * @param void
-   *
-   * @return int  Group ID (null if Group ID doesn't exist)
+   * @return int
+   *   Group ID (null if Group ID doesn't exist)
    */
   private static function _getGid() {
     if (!self::$_gid) {
@@ -91,8 +90,6 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param string $returnURL
    *   URL of page calling this function.
    *
-   * @return array  (reference)   List of Paper Sizes
-   * @static
    */
   public static function &addOrder(&$list, $returnURL) {
     $filter = "option_group_id = " . self::_getGid();
@@ -105,8 +102,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param bool $namesOnly
    *   Return simple list of names.
    *
-   * @return array  (reference)   Paper Size list
-   * @static
+   * @return array
+   *   (reference)   Paper Size list
    */
   public static function &getList($namesOnly = FALSE) {
     static $list = array();
@@ -132,10 +129,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Retrieve the default Paper Size values
    *
-   * @param NULL
-   *
-   * @return array   Name/value pairs containing the default Paper Size values.
-   * @static
+   * @return array
+   *   Name/value pairs containing the default Paper Size values.
    */
   public static function &getDefaultValues() {
     $params = array('is_active' => 1, 'is_default' => 1);
@@ -158,7 +153,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param int $val
    *   Field value to search for.
    *
-   * @return array  $values (reference) associative array of name/value pairs
+   * @return array
+   *   (reference) associative array of name/value pairs
    */
   public static function &getPaperFormat($field, $val) {
     $params = array('is_active' => 1, $field => $val);
@@ -177,7 +173,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param int $name
    *   Paper Size name. Empty = get default Paper Size.
    *
-   * @return array  $values (reference) associative array of name/value pairs
+   * @return array
+   *   (reference) associative array of name/value pairs
    */
   public static function &getByName($name) {
     return self::getPaperFormat('name', $name);
@@ -189,7 +186,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param int $id
    *   Paper Size id. 0 = get default Paper Size.
    *
-   * @return array  $values (reference) associative array of name/value pairs
+   * @return array
+   *   (reference) associative array of name/value pairs
    */
   public static function &getById($id) {
     return self::getPaperFormat('id', $id);
@@ -206,13 +204,12 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param null $default
    *
    * @return value
-   * @static
    */
   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:
-          return (int)CRM_Utils_Array::value($field, $values, $default);
+          return (int) CRM_Utils_Array::value($field, $values, $default);
 
         case CRM_Utils_Type::T_FLOAT:
           // Round float values to three decimal places and trim trailing zeros.
@@ -220,7 +217,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
           $f = sprintf('%05.3f', $values[$field]);
           $f = rtrim($f, '0');
           $f = rtrim($f, '.');
-          return (float)(empty($f) ? '0' : $f);
+          return (float) (empty($f) ? '0' : $f);
       }
       return CRM_Utils_Array::value($field, $values, $default);
     }
@@ -237,8 +234,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param array $values
    *   (reference ) an assoc array to hold the flattened values.
    *
-   * @return CRM_Core_DAO_OptionValue object
-   * @static
+   * @return CRM_Core_DAO_OptionValue
    */
   public static function retrieve(&$params, &$values) {
     $optionValue = new CRM_Core_DAO_OptionValue();
@@ -332,7 +328,6 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * @param int $id
    *   ID of the Paper Size to be deleted.
    *
-   * @static
    */
   public static function del($id) {
     if ($id) {