5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Core/Dashboard.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:0404bd5bf3e04c20da16ec1950db8ac0)
13 * Database access object for the Dashboard entity.
15 class CRM_Core_DAO_Dashboard
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '3.1';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_dashboard';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = FALSE;
39 * Domain for dashboard
46 * Internal name of dashlet.
60 * url in case of external dashlet
67 * Permission for the dashlet
78 public $permission_operator;
81 * fullscreen url for dashlet
85 public $fullscreen_url;
88 * Is this dashlet active?
95 * Is this dashlet reserved?
102 * Number of minutes to cache dashlet content in browser localStorage.
106 public $cache_minutes;
109 * Element name of angular directive to invoke (lowercase hyphenated format)
118 public function __construct() {
119 $this->__table
= 'civicrm_dashboard';
120 parent
::__construct();
124 * Returns localized title of this entity.
126 * @param bool $plural
127 * Whether to return the plural version of the title.
129 public static function getEntityTitle($plural = FALSE) {
130 return $plural ?
ts('Dashboards') : ts('Dashboard');
134 * Returns foreign keys and entity references.
137 * [CRM_Core_Reference_Interface]
139 public static function getReferenceColumns() {
140 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
141 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
142 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'domain_id', 'civicrm_domain', 'id');
143 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
145 return Civi
::$statics[__CLASS__
]['links'];
149 * Returns all the column names of this table
153 public static function &fields() {
154 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
155 Civi
::$statics[__CLASS__
]['fields'] = [
158 'type' => CRM_Utils_Type
::T_INT
,
159 'title' => ts('DashletID'),
161 'where' => 'civicrm_dashboard.id',
162 'table_name' => 'civicrm_dashboard',
163 'entity' => 'Dashboard',
164 'bao' => 'CRM_Core_BAO_Dashboard',
173 'name' => 'domain_id',
174 'type' => CRM_Utils_Type
::T_INT
,
175 'title' => ts('Domain ID'),
176 'description' => ts('Domain for dashboard'),
178 'where' => 'civicrm_dashboard.domain_id',
179 'table_name' => 'civicrm_dashboard',
180 'entity' => 'Dashboard',
181 'bao' => 'CRM_Core_BAO_Dashboard',
183 'FKClassName' => 'CRM_Core_DAO_Domain',
185 'label' => ts("Domain"),
187 'pseudoconstant' => [
188 'table' => 'civicrm_domain',
190 'labelColumn' => 'name',
196 'type' => CRM_Utils_Type
::T_STRING
,
197 'title' => ts('Dashlet Name'),
198 'description' => ts('Internal name of dashlet.'),
200 'size' => CRM_Utils_Type
::BIG
,
201 'where' => 'civicrm_dashboard.name',
202 'table_name' => 'civicrm_dashboard',
203 'entity' => 'Dashboard',
204 'bao' => 'CRM_Core_BAO_Dashboard',
210 'type' => CRM_Utils_Type
::T_STRING
,
211 'title' => ts('Dashlet Title'),
212 'description' => ts('dashlet title'),
214 'size' => CRM_Utils_Type
::HUGE
,
215 'where' => 'civicrm_dashboard.label',
216 'table_name' => 'civicrm_dashboard',
217 'entity' => 'Dashboard',
218 'bao' => 'CRM_Core_BAO_Dashboard',
224 'type' => CRM_Utils_Type
::T_STRING
,
225 'title' => ts('Dashlet URL'),
226 'description' => ts('url in case of external dashlet'),
228 'size' => CRM_Utils_Type
::HUGE
,
229 'where' => 'civicrm_dashboard.url',
230 'table_name' => 'civicrm_dashboard',
231 'entity' => 'Dashboard',
232 'bao' => 'CRM_Core_BAO_Dashboard',
237 'name' => 'permission',
238 'type' => CRM_Utils_Type
::T_STRING
,
239 'title' => ts('Dashlet Permission'),
240 'description' => ts('Permission for the dashlet'),
242 'size' => CRM_Utils_Type
::HUGE
,
243 'where' => 'civicrm_dashboard.permission',
244 'table_name' => 'civicrm_dashboard',
245 'entity' => 'Dashboard',
246 'bao' => 'CRM_Core_BAO_Dashboard',
248 'serialize' => self
::SERIALIZE_COMMA
,
251 'permission_operator' => [
252 'name' => 'permission_operator',
253 'type' => CRM_Utils_Type
::T_STRING
,
254 'title' => ts('Dashlet Permission Operator'),
255 'description' => ts('Permission Operator'),
257 'size' => CRM_Utils_Type
::FOUR
,
258 'where' => 'civicrm_dashboard.permission_operator',
259 'table_name' => 'civicrm_dashboard',
260 'entity' => 'Dashboard',
261 'bao' => 'CRM_Core_BAO_Dashboard',
265 'fullscreen_url' => [
266 'name' => 'fullscreen_url',
267 'type' => CRM_Utils_Type
::T_STRING
,
268 'title' => ts('Fullscreen URL'),
269 'description' => ts('fullscreen url for dashlet'),
271 'size' => CRM_Utils_Type
::HUGE
,
272 'where' => 'civicrm_dashboard.fullscreen_url',
273 'table_name' => 'civicrm_dashboard',
274 'entity' => 'Dashboard',
275 'bao' => 'CRM_Core_BAO_Dashboard',
280 'name' => 'is_active',
281 'type' => CRM_Utils_Type
::T_BOOLEAN
,
282 'title' => ts('Is Dashlet Active?'),
283 'description' => ts('Is this dashlet active?'),
284 'where' => 'civicrm_dashboard.is_active',
286 'table_name' => 'civicrm_dashboard',
287 'entity' => 'Dashboard',
288 'bao' => 'CRM_Core_BAO_Dashboard',
293 'name' => 'is_reserved',
294 'type' => CRM_Utils_Type
::T_BOOLEAN
,
295 'title' => ts('Is Dashlet Reserved?'),
296 'description' => ts('Is this dashlet reserved?'),
297 'where' => 'civicrm_dashboard.is_reserved',
299 'table_name' => 'civicrm_dashboard',
300 'entity' => 'Dashboard',
301 'bao' => 'CRM_Core_BAO_Dashboard',
306 'name' => 'cache_minutes',
307 'type' => CRM_Utils_Type
::T_INT
,
308 'title' => ts('Cache Minutes'),
309 'description' => ts('Number of minutes to cache dashlet content in browser localStorage.'),
311 'where' => 'civicrm_dashboard.cache_minutes',
313 'table_name' => 'civicrm_dashboard',
314 'entity' => 'Dashboard',
315 'bao' => 'CRM_Core_BAO_Dashboard',
320 'name' => 'directive',
321 'type' => CRM_Utils_Type
::T_STRING
,
322 'title' => ts('Angular directive'),
323 'description' => ts('Element name of angular directive to invoke (lowercase hyphenated format)'),
325 'size' => CRM_Utils_Type
::HUGE
,
326 'where' => 'civicrm_dashboard.directive',
327 'table_name' => 'civicrm_dashboard',
328 'entity' => 'Dashboard',
329 'bao' => 'CRM_Core_BAO_Dashboard',
334 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
336 return Civi
::$statics[__CLASS__
]['fields'];
340 * Return a mapping from field-name to the corresponding key (as used in fields()).
343 * Array(string $name => string $uniqueName).
345 public static function &fieldKeys() {
346 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
347 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
349 return Civi
::$statics[__CLASS__
]['fieldKeys'];
353 * Returns the names of this table
357 public static function getTableName() {
358 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
362 * Returns if this table needs to be logged
366 public function getLog() {
371 * Returns the list of fields that can be imported
373 * @param bool $prefix
377 public static function &import($prefix = FALSE) {
378 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'dashboard', $prefix, []);
383 * Returns the list of fields that can be exported
385 * @param bool $prefix
389 public static function &export($prefix = FALSE) {
390 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'dashboard', $prefix, []);
395 * Returns the list of indices
397 * @param bool $localize
401 public static function indices($localize = TRUE) {
403 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;