Merge branch 'getting_started' of https://github.com/cividesk/civicrm-core into civid...

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

diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php
index 2608314c1965e9053903fa8fe124ab7cba0e5f8b..a9e814827536604719ac200e870e5977094b6be9 100644 (file)
--- a/CRM/Core/BAO/PaperSize.php
+++ b/CRM/Core/BAO/PaperSize.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
  | Copyright (C) 2011 Marty Wright                                    |
  | Licensed to CiviCRM under the Academic Free License version 3.0.   |
@@ -24,12 +24,12 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -40,7 +40,7 @@
 class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
 
   /**
-   * Static holder for the Paper Size Option Group ID
+   * Static holder for the Paper Size Option Group ID.
    */
   private static $_gid = NULL;
 
@@ -68,7 +68,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   );
 
   /**
-   * Get Option Group ID for Paper Sizes
+   * Get Option Group ID for Paper Sizes.
    *
    * @return int
    *   Group ID (null if Group ID doesn't exist)
@@ -84,7 +84,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Add ordering fields to Paper Size list
+   * Add ordering fields to Paper Size list.
    *
    * @param array (reference) $list List of Paper Sizes
    * @param string $returnURL
@@ -127,7 +127,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Retrieve the default Paper Size values
+   * Retrieve the default Paper Size values.
    *
    * @return array
    *   Name/value pairs containing the default Paper Size values.
@@ -146,7 +146,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Paper Size from the DB
+   * Get Paper Size from the DB.
    *
    * @param string $field
    *   Field name to search by.
@@ -168,7 +168,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Paper Size by Name
+   * Get Paper Size by Name.
    *
    * @param int $name
    *   Paper Size name. Empty = get default Paper Size.
@@ -181,7 +181,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Paper Size by ID
+   * Get Paper Size by ID.
    *
    * @param int $id
    *   Paper Size id. 0 = get default Paper Size.
@@ -194,7 +194,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Paper Size field from associative array
+   * Get Paper Size field from associative array.
    *
    * @param string $field
    *   Name of a Paper Size field.
@@ -225,9 +225,9 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Takes a bunch of params that are needed to match certain criteria and
-   * retrieves the relevant objects. Typically the valid params are only
-   * paper size id. It also stores all the retrieved values in the default array.
+   * Retrieve DB object based on input parameters.
+   *
+   * It also stores all the retrieved values in the default array.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
@@ -263,7 +263,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Save the Paper Size in the DB
+   * Save the Paper Size in the DB.
    *
    * @param array (reference) $values associative array of name/value pairs
    * @param int $id
@@ -323,7 +323,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Delete a Paper Size
+   * Delete a Paper Size.
    *
    * @param int $id
    *   ID of the Paper Size to be deleted.
@@ -344,4 +344,5 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
     }
     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
   }
+
 }