X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FBAO%2FLabelFormat.php;h=50057a3e401da53f8d330097c1137cb203c3ae99;hb=c15fb38374462a40d704d83fac983412df8a16a1;hp=d828eab3c29ddf6950a45a2b37e67e58e0ea3489;hpb=a922142c067998cb0ffb4cbc95a71aa370ffdc88;p=civicrm-core.git

diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php
index d828eab3c2..50057a3e40 100644
--- a/CRM/Core/BAO/LabelFormat.php
+++ b/CRM/Core/BAO/LabelFormat.php
@@ -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_LabelFormat extends CRM_Core_DAO_OptionValue {
 
   /**
-   * Static holder for the Label Formats Option Group ID
+   * Static holder for the Label Formats Option Group ID.
    */
   private static $_gid = NULL;
 
@@ -157,11 +157,8 @@ class CRM_Core_BAO_LabelFormat 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
-   * @static
    */
   public static function getPageOrientations() {
     return array(
@@ -178,7 +175,6 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
    *
    * @return array
    *   array of font names
-   * @static
    */
   public static function getFontNames($name = 'label_format') {
     $label = new CRM_Utils_PDF_Label(self::getDefaultValues($name));
@@ -188,11 +184,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get font sizes supported by the TCPDF package used to create PDF labels.
    *
-   * @param void
-   *
    * @return array
    *   array of font sizes
-   * @static
    */
   public static function getFontSizes() {
     $fontSizes = array();
@@ -206,11 +199,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get measurement units recognized by the TCPDF package used to create PDF labels.
    *
-   * @param void
-   *
    * @return array
    *   array of measurement units
-   * @static
    */
   public static function getUnits() {
     return array(
@@ -224,11 +214,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get text alignment recognized by the TCPDF package used to create PDF labels.
    *
-   * @param void
-   *
    * @return array
    *   array of alignments
-   * @static
    */
   public static function getTextAlignments() {
     return array(
@@ -241,11 +228,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get text alignment recognized by the TCPDF package used to create PDF labels.
    *
-   * @param void
-   *
    * @return array
    *   array of alignments
-   * @static
    */
   public static function getFontStyles() {
     return array(
@@ -256,7 +240,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Option Group ID for Label Formats
+   * Get Option Group ID for Label Formats.
    *
    * @param string $name
    *
@@ -274,7 +258,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Add ordering fields to Label Format list
+   * Add ordering fields to Label Format list.
    *
    * @param array (reference) $list List of Label Formats
    * @param string $returnURL
@@ -282,11 +266,11 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
    *
    * @return array
    *   (reference)   List of Label Formats
-   * @static
    */
   public static function addOrder(&$list, $returnURL) {
     $filter = "option_group_id = " . self::_getGid();
     CRM_Utils_Weight::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
+    return $list;
   }
 
   /**
@@ -299,7 +283,6 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
    *
    * @return array
    *   (reference)   label format list
-   * @static
    */
   public static function &getList($namesOnly = FALSE, $groupName = 'label_format') {
     static $list = array();
@@ -323,14 +306,13 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Retrieve the default Label Format values
+   * Retrieve the default Label Format values.
    *
    * @param string $groupName
    *   Label format group name.
    *
    * @return array
    *   Name/value pairs containing the default Label Format values.
-   * @static
    */
   public static function &getDefaultValues($groupName = 'label_format') {
     $params = array('is_active' => 1, 'is_default' => 1);
@@ -346,7 +328,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Label Format from the DB
+   * Get Label Format from the DB.
    *
    * @param string $field
    *   Field name to search by.
@@ -370,7 +352,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Label Format by Name
+   * Get Label Format by Name.
    *
    * @param int $name
    *   Label format name. Empty = get default label format.
@@ -383,7 +365,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Label Format by ID
+   * Get Label Format by ID.
    *
    * @param int $id
    *   Label format id. 0 = get default label format.
@@ -398,7 +380,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Label Format field from associative array
+   * Get Label Format field from associative array.
    *
    * @param string $field
    *   Name of a label format field.
@@ -408,7 +390,6 @@ class CRM_Core_BAO_LabelFormat 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)) {
@@ -430,9 +411,9 @@ class CRM_Core_BAO_LabelFormat 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
-   * label 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.
@@ -442,7 +423,6 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
    * @param string $groupName
    *
    * @return CRM_Core_DAO_OptionValue
-   * @static
    */
   public static function retrieve(&$params, &$values, $groupName = 'label_format') {
     $optionValue = new CRM_Core_DAO_OptionValue();
@@ -471,9 +451,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Return the name of the group for customized labels
-   *
-   * @param void
+   * Return the name of the group for customized labels.
    *
    * @return void
    */
@@ -482,7 +460,7 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Save the Label Format in the DB
+   * Save the Label Format in the DB.
    *
    * @param array (reference) $values associative array of name/value pairs
    * @param int $id
@@ -552,13 +530,12 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Delete a Label Format
+   * Delete a Label Format.
    *
    * @param int $id
    *   ID of the label format to be deleted.
    * @param string $groupName
    *   Group name.
-   * @static
    */
   public static function del($id, $groupName) {
     if ($id) {
@@ -575,4 +552,5 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
     }
     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
   }
+
 }