Merge pull request #3519 from davecivicrm/CRM-14879

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

diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php
index b2fdccf6d7373cc3cc92651baf3c5e4724eb3719..162c48d60c9510790863fe18bb2913a36eef15ce 100644 (file)
--- a/CRM/Core/BAO/LabelFormat.php
+++ b/CRM/Core/BAO/LabelFormat.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
  | Copyright (C) 2011 Marty Wright                                    |
  | Licensed to CiviCRM under the Academic Free License version 3.0.   |
@@ -29,7 +29,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -257,7 +257,9 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get Option Group ID for Label Formats
    *
-   * @param void
+   * @param string $name
+   *
+   * @internal param $void
    *
    * @return int  Group ID (null if Group ID doesn't exist)
    * @access private
@@ -343,8 +345,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get Label Format 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
+   *
+   * @param string $groupName
    *
    * @return array  $values (reference) associative array of name/value pairs
    * @access public
@@ -388,10 +392,12 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
   /**
    * Get Label Format field from associative array
    *
-   * @param string              $field         name of a label format field
-   * @param array (reference)   $values        associative array of name/value pairs containing
+   * @param string $field name of a label format field
+   * @param array (reference) $values associative array of name/value pairs containing
    *                                           label format field selections
    *
+   * @param null $default
+   *
    * @return value
    * @access public
    * @static
@@ -420,8 +426,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
    * retrieves the relevant objects. Typically the valid params are only
    * label 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
+   *
+   * @param string $groupName
    *
    * @return object CRM_Core_DAO_OptionValue object
    * @access public