CRM/Wci/BAO/ProgressBar.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  *
  33  */
  34 require_once 'CRM/Wci/DAO/ProgressBar.php';
  35
  36 class CRM_WCI_BAO_ProgressBar extends CRM_WCI_DAO_ProgressBar {
  37
  38   /**
  39    * class constructor
  40    */
  41   function __construct() {
  42     parent::__construct();
  43   }
  44
  45   /**
  46    * Function to create a ProgressBar
  47    * takes an associative array and creates a ProgressBar object
  48    *
  49    * This function is invoked from within the web form layer and also from the api layer
  50    *
  51    * @param array   $params      (reference ) an assoc array of name/value pairs
  52    *
  53    * @return object CRM_WCI_BAO_ProgressBar object
  54    * @access public
  55    * @static
  56    */
  57   static function create(array $params) {
  58
  59     // check required params
  60     if (!self::dataExists($params)) {
  61       CRM_Core_Error::fatal('Not enough data to create a progress bar.');
  62     }
  63
  64     $progress_bar = new CRM_WCI_BAO_ProgressBar();
  65     $progress_bar->copyValues($params);
  66
  67     $progress_bar->save();
  68
  69     return $progress_bar;
  70   }
  71
  72   /**
  73    * Get a list of Widgets matching the params, where params keys are column
  74    * names of civicrm_wci_widget.
  75    *
  76    * @param array $params
  77    * @return array of CRM_WCI_BAO_ProgressBar objects
  78    */
  79   static function retrieve(array $params) {
  80     $result = array();
  81
  82     $progress_bar = new CRM_WCI_BAO_ProgressBar();
  83     $progress_bar->copyValues($params);
  84     $progress_bar->find();
  85
  86     while ($progress_bar->fetch()) {
  87       $result[(int) $progress_bar->id] = clone $progress_bar;
  88     }
  89
  90     $progress_bar->free();
  91
  92     return $result;
  93   }
  94
  95   /**
  96    * Wrapper method for retrieve
  97    *
  98    * @param mixed $id Int or int-like string representing widget ID
  99    * @return CRM_WCI_BAO_ProgressBar
 100    */
 101   static function retrieveByID($id) {
 102     if (!is_int($id) && !ctype_digit($id)) {
 103       CRM_Core_Error::fatal(__CLASS__ . '::' . __FUNCTION__ . ' expects an integer.');
 104     }
 105     $id = (int) $id;
 106
 107     $progress_bars = self::retrieve(array('id' => $id));
 108
 109     if (!array_key_exists($id, $progress_bars)) {
 110       CRM_Core_Error::fatal("No Progress bar with ID $id exists.");
 111     }
 112
 113     return $progress_bars[$id];
 114   }
 115
 116   /**
 117    * Check if there is absolute minimum of data to add the object
 118    *
 119    * @param array  $params         (reference ) an assoc array of name/value pairs
 120    *
 121    * @return boolean
 122    * @access public
 123    */
 124   public static function dataExists($params) {
 125     if (CRM_Utils_Array::value('name', $params)) {
 126       return TRUE;
 127     }
 128     return FALSE;
 129   }
 130 }