3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
35 class CRM_Wci_BAO_WidgetCache
extends CRM_Wci_DAO_WidgetCache
{
40 function __construct() {
41 parent
::__construct();
45 * Function to create widget cache
46 * takes an associative array
48 * This function is invoked from within the web form layer and also from the api layer
50 * @param array $params (reference ) an assoc array of name/value pairs
52 * @return object CRM_Wci_BAO_WidgetCache object
56 static function create(array $params) {
58 // check required params
59 if (!self
::dataExists($params)) {
60 CRM_Core_Error
::fatal('Not enough data to create a progress bar formula entry.');
63 $widget_cache = new CRM_Wci_BAO_WidgetCache();
64 $widget_cache->copyValues($params);
66 $widget_cache->save();
72 * Get a list of Widgets matching the params, where params keys are column
73 * names of civicrm_wci_widget.
75 * @param array $params
76 * @return array of CRM_Wci_BAO_ProgressBarFormula objects
78 static function retrieve(array $params) {
81 $widget_cache = new CRM_Wci_BAO_WidgetCache();
82 $widget_cache->copyValues($params);
83 $widget_cache->find();
85 while ($widget_cache->fetch()) {
86 $result[(int) $widget_cache->id
] = clone $widget_cache;
89 $widget_cache->free();
95 * Wrapper method for retrieve
97 * @param mixed $id Int or int-like string representing widget ID
98 * @return CRM_Wci_BAO_ProgressBarFormula
100 static function retrieveByID($id) {
101 if (!is_int($id) && !ctype_digit($id)) {
102 CRM_Core_Error
::fatal(__CLASS__
. '::' . __FUNCTION__
. ' expects an integer.');
106 $widget_cache = self
::retrieve(array('id' => $id));
108 if (!array_key_exists($id, $widget_cache)) {
109 CRM_Core_Error
::fatal("No formula entry with ID $id exists.");
112 return $widget_cache[$id];
115 public static function setWidgetCache($widgetId, $code) {
116 $cacheTime = civicrm_api3('setting', 'getValue',
117 array('group' => 'Wci Preference', 'name' => 'widget_cache_timeout'));
118 $expire_on = time() +
($cacheTime * 60);
119 $query = "INSERT INTO civicrm_wci_widget_cache (widget_id, widget_code, expire)
121 ON DUPLICATE KEY UPDATE widget_id = %1, widget_code = %2, expire = %3";
123 1 => array($widgetId, 'Integer'),
124 2 => array($code, 'String'),
125 3 => array($expire_on, 'Integer')
127 CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Wci_DAO_WidgetCache');
130 public static function getWidgetCache($widgetId) {
132 $query = "SELECT widget_code FROM civicrm_wci_widget_cache where widget_id = %1
134 $cacheTime = civicrm_api3('setting', 'getValue',
135 array('group' => 'Wci Preference', 'name' => 'widget_cache_timeout'));
136 $expire_on = time() +
($cacheTime * 60);
137 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($widgetId, 'Integer'),
138 2 => array($expire_on, 'Integer')), TRUE, 'CRM_Wci_DAO_WidgetCache');
140 $code = $dao->widget_code
;
145 public static function deleteWidgetCache($widgetId) {
147 $query = "DELETE FROM civicrm_wci_widget_cache where widget_id = %1";
148 $dao = CRM_Core_DAO
::executeQuery($query,
149 array(1 => array($widgetId, 'Integer')), TRUE, 'CRM_Wci_DAO_WidgetCache');