Merge pull request #4822 from kurund/indentation-fixes
[civicrm-core.git] / CRM / Badge / BAO / Layout.php
index 8ceb633f68f3b34b08ec9ca88fffe48e607c042b..0bbe2ce1fc71c79ee12a5f7cdd808d770746a06f 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -35,9 +35,9 @@
 class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
 
   /**
-   * class constructor
+   * Class constructor
    */
-  function __construct() {
+  public function __construct() {
     parent::__construct();
   }
 
@@ -49,11 +49,10 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
    * @param array $params   (reference ) an assoc array of name/value pairs
    * @param array $defaults (reference ) an assoc array to hold the flattened values
    *
-   * @return object CRM_Core_DAO_PrintLabel object on success, null otherwise
-   * @access public
+   * @return CRM_Core_DAO_PrintLabel object on success, null otherwise
    * @static
    */
-  static function retrieve(&$params, &$defaults) {
+  public static function retrieve(&$params, &$defaults) {
     $printLabel = new CRM_Core_DAO_PrintLabel();
     $printLabel->copyValues($params);
     if ($printLabel->find(TRUE)) {
@@ -64,32 +63,29 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
   }
 
   /**
-   * update the is_active flag in the db
+   * Update the is_active flag in the db
    *
    * @param int $id        id of the database record
    * @param boolean $is_active value we want to set the is_active field
    *
    * @return Object             DAO object on success, null otherwise
    *
-   * @access public
    * @static
    */
-  static function setIsActive($id, $is_active) {
+  public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_PrintLabel', $id, 'is_active', $is_active);
   }
 
   /**
-   * Function to add a name label
+   * Add a name label
    *
    * @param array $params reference array contains the values submitted by the form
-   * @param array $ids    reference array contains the id
    *
-   * @access public
    * @static
    *
    * @return object
    */
-  static function create(&$params) {
+  public static function create(&$params) {
     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
     $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
     $params['is_reserved'] = CRM_Utils_Array::value('is_reserved', $params, FALSE);
@@ -122,14 +118,13 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
   }
 
   /**
-   * Function to delete name labels
+   * Delete name labels
    *
    * @param  int $printLabelId ID of the name label to be deleted.
    *
-   * @access public
    * @static
    */
-  static function del($printLabelId) {
+  public static function del($printLabelId) {
     $printLabel = new CRM_Core_DAO_PrintLabel();
     $printLabel->id = $printLabelId;
     $printLabel->delete();
@@ -139,10 +134,9 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
    *  get the list of print labels
    *
    * @return array list of labels
-   * @access public
    * @static
    */
-  static function getList() {
+  public static function getList() {
     $printLabel = new CRM_Core_DAO_PrintLabel();
     $printLabel->find();
 
@@ -154,14 +148,13 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
   }
 
   /**
-   * build layout structure
+   * Build layout structure
    *
    * @param array $params associated array of submitted values
    *
    * @return array $formattedLayout array formatted array
-   * @access public
    */
-  static function buildLayout(&$params) {
+  public static function buildLayout(&$params) {
     $layoutParams = array('id' => $params['badge_id']);
     CRM_Badge_BAO_Layout::retrieve($layoutParams, $layoutInfo);
 
@@ -172,7 +165,7 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
   }
 
   /**
-   * Function to decode encoded data and return as an array
+   * Decode encoded data and return as an array
    *
    * @param json $jsonData json object
    *
@@ -183,4 +176,3 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
     return json_decode($jsonData, true);
   }
 }
-