Merge pull request #5479 from eileenmcnaughton/4.6

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

diff --git a/CRM/Core/BAO/PdfFormat.php b/CRM/Core/BAO/PdfFormat.php
index 4162f3bd37fbc0cb6bc18485f0404072ea8cae58..6f1fbced8408a51ec8a4f161f3965a6ffb5f6e9b 100644 (file)
--- a/CRM/Core/BAO/PdfFormat.php
+++ b/CRM/Core/BAO/PdfFormat.php
@@ -24,7 +24,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -40,7 +40,7 @@
 class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
 
   /**
-   * Static holder for the PDF Page Formats Option Group ID
+   * Static holder for the PDF Page Formats Option Group ID.
    */
   private static $_gid = NULL;
 
@@ -97,8 +97,6 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get page orientations recognized by the DOMPDF package used to create PDF letters.
    *
-   * @param void
-   *
    * @return array
    *   array of page orientations
    */
@@ -112,8 +110,6 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get measurement units recognized by the DOMPDF package used to create PDF letters.
    *
-   * @param void
-   *
    * @return array
    *   array of measurement units
    */
@@ -127,9 +123,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Option Group ID for PDF Page Formats
-   *
-   * @param void
+   * Get Option Group ID for PDF Page Formats.
    *
    * @return int
    *   Group ID (null if Group ID doesn't exist)
@@ -145,14 +139,13 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Add ordering fields to Page Format list
+   * Add ordering fields to Page Format list.
    *
    * @param array (reference) $list List of PDF Page Formats
    * @param string $returnURL
    *   URL of page calling this function.
    *
    * @return void
-   * @static
    */
   public static function addOrder(&$list, $returnURL) {
     $filter = "option_group_id = " . self::_getGid();
@@ -167,7 +160,6 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
    *
    * @return array
    *   (reference)   PDF Page Format list
-   * @static
    */
   public static function &getList($namesOnly = FALSE) {
     static $list = array();
@@ -191,13 +183,10 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get the default PDF Page Format values
-   *
-   * @param NULL
+   * Get the default PDF Page Format values.
    *
    * @return array
    *   Name/value pairs containing the default PDF Page Format values.
-   * @static
    */
   public static function &getDefaultValues() {
     $params = array('is_active' => 1, 'is_default' => 1);
@@ -216,7 +205,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get PDF Page Format from the DB
+   * Get PDF Page Format from the DB.
    *
    * @param string $field
    *   Field name to search by.
@@ -238,7 +227,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get PDF Page Format by Name
+   * Get PDF Page Format by Name.
    *
    * @param int $name
    *   PDF Page Format name. Empty = get default PDF Page Format.
@@ -251,7 +240,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get PDF Page Format by ID
+   * Get PDF Page Format by ID.
    *
    * @param int $id
    *   PDF Page Format id. 0 = get default PDF Page Format.
@@ -264,7 +253,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get PDF Page Format field from associative array
+   * Get PDF Page Format field from associative array.
    *
    * @param string $field
    *   Name of a PDF Page Format field.
@@ -274,7 +263,6 @@ class CRM_Core_BAO_PdfFormat 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)) {
@@ -296,17 +284,16 @@ class CRM_Core_BAO_PdfFormat 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
-   * format 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.
    * @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();
@@ -335,7 +322,7 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Save the PDF Page Format in the DB
+   * Save the PDF Page Format in the DB.
    *
    * @param array (reference) $values associative array of name/value pairs
    * @param int $id
@@ -391,12 +378,11 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Delete a PDF Page Format
+   * Delete a PDF Page Format.
    *
    * @param int $id
    *   ID of the PDF Page Format to be deleted.
    *
-   * @static
    */
   public static function del($id) {
     if ($id) {
@@ -413,4 +399,5 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
     }
     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
   }
+
 }