Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
ca5cec67 | 5 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Core/Navigation.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
6e9fbc8b | 9 | * (GenCodeChecksum:6400fef9c925231f0d6245030ec46e68) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Navigation entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_Navigation extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '3.0'; | |
c3fc2621 | 18 | |
e501603b | 19 | /** |
f41f0342 | 20 | * Static instance to hold the table name. |
e501603b TO |
21 | * |
22 | * @var string | |
23 | */ | |
fa45b5b9 | 24 | public static $_tableName = 'civicrm_navigation'; |
c3fc2621 | 25 | |
8ab43c93 CW |
26 | /** |
27 | * Field to show when displaying a record. | |
28 | * | |
29 | * @var string | |
30 | */ | |
31 | public static $_labelField = 'label'; | |
32 | ||
e501603b | 33 | /** |
f41f0342 | 34 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 35 | * |
c3fc2621 | 36 | * @var bool |
e501603b | 37 | */ |
fa45b5b9 | 38 | public static $_log = FALSE; |
c3fc2621 | 39 | |
e501603b | 40 | /** |
e6ca0a57 | 41 | * @var int |
e501603b TO |
42 | */ |
43 | public $id; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * Which Domain is this navigation item for | |
47 | * | |
e6ca0a57 | 48 | * @var int |
e501603b TO |
49 | */ |
50 | public $domain_id; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * Navigation Title | |
54 | * | |
55 | * @var string | |
56 | */ | |
57 | public $label; | |
c3fc2621 | 58 | |
e501603b TO |
59 | /** |
60 | * Internal Name | |
61 | * | |
62 | * @var string | |
63 | */ | |
64 | public $name; | |
c3fc2621 | 65 | |
e501603b TO |
66 | /** |
67 | * url in case of custom navigation link | |
68 | * | |
69 | * @var string | |
70 | */ | |
71 | public $url; | |
c3fc2621 | 72 | |
4926ede8 O |
73 | /** |
74 | * CSS class name for an icon | |
75 | * | |
76 | * @var string | |
77 | */ | |
78 | public $icon; | |
c3fc2621 | 79 | |
e501603b | 80 | /** |
6e9fbc8b | 81 | * Permission(s) needed to access menu item |
e501603b TO |
82 | * |
83 | * @var string | |
84 | */ | |
85 | public $permission; | |
c3fc2621 | 86 | |
e501603b | 87 | /** |
6e9fbc8b | 88 | * Operator to use if item has more than one permission |
e501603b TO |
89 | * |
90 | * @var string | |
91 | */ | |
92 | public $permission_operator; | |
c3fc2621 | 93 | |
e501603b TO |
94 | /** |
95 | * Parent navigation item, used for grouping | |
96 | * | |
e6ca0a57 | 97 | * @var int |
e501603b TO |
98 | */ |
99 | public $parent_id; | |
c3fc2621 | 100 | |
e501603b TO |
101 | /** |
102 | * Is this navigation item active? | |
103 | * | |
e6ca0a57 | 104 | * @var bool |
e501603b TO |
105 | */ |
106 | public $is_active; | |
c3fc2621 | 107 | |
e501603b | 108 | /** |
e0674c37 | 109 | * Place a separator either before or after this menu item. |
e501603b | 110 | * |
e0674c37 | 111 | * @var int |
e501603b TO |
112 | */ |
113 | public $has_separator; | |
c3fc2621 | 114 | |
e501603b TO |
115 | /** |
116 | * Ordering of the navigation items in various blocks. | |
117 | * | |
118 | * @var int | |
119 | */ | |
120 | public $weight; | |
c3fc2621 | 121 | |
e501603b | 122 | /** |
f41f0342 | 123 | * Class constructor. |
e501603b | 124 | */ |
c3fc2621 | 125 | public function __construct() { |
e501603b TO |
126 | $this->__table = 'civicrm_navigation'; |
127 | parent::__construct(); | |
128 | } | |
c3fc2621 | 129 | |
449c4e6b CW |
130 | /** |
131 | * Returns localized title of this entity. | |
7b66c3b5 AH |
132 | * |
133 | * @param bool $plural | |
134 | * Whether to return the plural version of the title. | |
449c4e6b | 135 | */ |
7b66c3b5 AH |
136 | public static function getEntityTitle($plural = FALSE) { |
137 | return $plural ? ts('Navigations') : ts('Navigation'); | |
449c4e6b CW |
138 | } |
139 | ||
e501603b | 140 | /** |
f41f0342 | 141 | * Returns foreign keys and entity references. |
e501603b TO |
142 | * |
143 | * @return array | |
144 | * [CRM_Core_Reference_Interface] | |
145 | */ | |
c3fc2621 | 146 | public static function getReferenceColumns() { |
346aaaba | 147 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 148 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
149 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'domain_id', 'civicrm_domain', 'id'); |
150 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'parent_id', 'civicrm_navigation', 'id'); | |
346aaaba | 151 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 152 | } |
346aaaba | 153 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 154 | } |
c3fc2621 | 155 | |
e501603b TO |
156 | /** |
157 | * Returns all the column names of this table | |
158 | * | |
159 | * @return array | |
160 | */ | |
c3fc2621 | 161 | public static function &fields() { |
346aaaba | 162 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
163 | Civi::$statics[__CLASS__]['fields'] = [ |
164 | 'id' => [ | |
e501603b TO |
165 | 'name' => 'id', |
166 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
167 | 'title' => ts('Navigation ID'), |
168 | 'required' => TRUE, | |
a36434b9 | 169 | 'where' => 'civicrm_navigation.id', |
522a26c9 | 170 | 'table_name' => 'civicrm_navigation', |
171 | 'entity' => 'Navigation', | |
172 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 173 | 'localizable' => 0, |
2cbbebe8 A |
174 | 'html' => [ |
175 | 'type' => 'Number', | |
176 | ], | |
1fe423d6 | 177 | 'readonly' => TRUE, |
a9d0587b | 178 | 'add' => '3.0', |
c3fc2621 CW |
179 | ], |
180 | 'domain_id' => [ | |
e501603b TO |
181 | 'name' => 'domain_id', |
182 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 183 | 'title' => ts('Domain ID'), |
215b423e | 184 | 'description' => ts('Which Domain is this navigation item for'), |
c3fc2621 | 185 | 'required' => TRUE, |
a36434b9 | 186 | 'where' => 'civicrm_navigation.domain_id', |
522a26c9 | 187 | 'table_name' => 'civicrm_navigation', |
188 | 'entity' => 'Navigation', | |
189 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 190 | 'localizable' => 0, |
e501603b | 191 | 'FKClassName' => 'CRM_Core_DAO_Domain', |
2cbbebe8 A |
192 | 'html' => [ |
193 | 'label' => ts("Domain"), | |
194 | ], | |
c3fc2621 | 195 | 'pseudoconstant' => [ |
e501603b TO |
196 | 'table' => 'civicrm_domain', |
197 | 'keyColumn' => 'id', | |
198 | 'labelColumn' => 'name', | |
e6ca0a57 | 199 | ], |
a9d0587b | 200 | 'add' => '3.0', |
c3fc2621 CW |
201 | ], |
202 | 'label' => [ | |
e501603b TO |
203 | 'name' => 'label', |
204 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 205 | 'title' => ts('Navigation Item Label'), |
215b423e | 206 | 'description' => ts('Navigation Title'), |
e501603b TO |
207 | 'maxlength' => 255, |
208 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 209 | 'where' => 'civicrm_navigation.label', |
522a26c9 | 210 | 'table_name' => 'civicrm_navigation', |
211 | 'entity' => 'Navigation', | |
212 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 213 | 'localizable' => 0, |
a9d0587b | 214 | 'add' => '3.0', |
c3fc2621 CW |
215 | ], |
216 | 'name' => [ | |
e501603b TO |
217 | 'name' => 'name', |
218 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 219 | 'title' => ts('Navigation Item Machine Name'), |
215b423e | 220 | 'description' => ts('Internal Name'), |
e501603b TO |
221 | 'maxlength' => 255, |
222 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 223 | 'where' => 'civicrm_navigation.name', |
522a26c9 | 224 | 'table_name' => 'civicrm_navigation', |
225 | 'entity' => 'Navigation', | |
226 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 227 | 'localizable' => 0, |
a9d0587b | 228 | 'add' => '3.0', |
c3fc2621 CW |
229 | ], |
230 | 'url' => [ | |
e501603b TO |
231 | 'name' => 'url', |
232 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 233 | 'title' => ts('Url'), |
215b423e | 234 | 'description' => ts('url in case of custom navigation link'), |
e501603b TO |
235 | 'maxlength' => 255, |
236 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 237 | 'where' => 'civicrm_navigation.url', |
522a26c9 | 238 | 'table_name' => 'civicrm_navigation', |
239 | 'entity' => 'Navigation', | |
240 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 241 | 'localizable' => 0, |
a9d0587b | 242 | 'add' => '3.0', |
c3fc2621 CW |
243 | ], |
244 | 'icon' => [ | |
4926ede8 O |
245 | 'name' => 'icon', |
246 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 247 | 'title' => ts('Icon'), |
215b423e | 248 | 'description' => ts('CSS class name for an icon'), |
c3fc2621 | 249 | 'required' => FALSE, |
4926ede8 O |
250 | 'maxlength' => 255, |
251 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 252 | 'where' => 'civicrm_navigation.icon', |
5fb0de1f | 253 | 'default' => NULL, |
4926ede8 O |
254 | 'table_name' => 'civicrm_navigation', |
255 | 'entity' => 'Navigation', | |
256 | 'bao' => 'CRM_Core_BAO_Navigation', | |
257 | 'localizable' => 0, | |
a9d0587b | 258 | 'add' => '4.7', |
c3fc2621 CW |
259 | ], |
260 | 'permission' => [ | |
e501603b TO |
261 | 'name' => 'permission', |
262 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 263 | 'title' => ts('Required Permission'), |
6e9fbc8b | 264 | 'description' => ts('Permission(s) needed to access menu item'), |
e501603b TO |
265 | 'maxlength' => 255, |
266 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 267 | 'where' => 'civicrm_navigation.permission', |
522a26c9 | 268 | 'table_name' => 'civicrm_navigation', |
269 | 'entity' => 'Navigation', | |
270 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 271 | 'localizable' => 0, |
6e9fbc8b | 272 | 'serialize' => self::SERIALIZE_COMMA, |
a9d0587b | 273 | 'add' => '3.0', |
c3fc2621 CW |
274 | ], |
275 | 'permission_operator' => [ | |
e501603b TO |
276 | 'name' => 'permission_operator', |
277 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 278 | 'title' => ts('Permission Operator'), |
6e9fbc8b | 279 | 'description' => ts('Operator to use if item has more than one permission'), |
e501603b TO |
280 | 'maxlength' => 3, |
281 | 'size' => CRM_Utils_Type::FOUR, | |
a36434b9 | 282 | 'where' => 'civicrm_navigation.permission_operator', |
522a26c9 | 283 | 'table_name' => 'civicrm_navigation', |
284 | 'entity' => 'Navigation', | |
285 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 286 | 'localizable' => 0, |
6e9fbc8b CW |
287 | 'pseudoconstant' => [ |
288 | 'callback' => 'CRM_Core_SelectValues::andOr', | |
289 | ], | |
a9d0587b | 290 | 'add' => '3.0', |
c3fc2621 CW |
291 | ], |
292 | 'parent_id' => [ | |
e501603b TO |
293 | 'name' => 'parent_id', |
294 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 295 | 'title' => ts('parent ID'), |
215b423e | 296 | 'description' => ts('Parent navigation item, used for grouping'), |
a36434b9 | 297 | 'where' => 'civicrm_navigation.parent_id', |
522a26c9 | 298 | 'table_name' => 'civicrm_navigation', |
299 | 'entity' => 'Navigation', | |
300 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 301 | 'localizable' => 0, |
e501603b | 302 | 'FKClassName' => 'CRM_Core_DAO_Navigation', |
2cbbebe8 A |
303 | 'html' => [ |
304 | 'label' => ts("parent"), | |
305 | ], | |
c3fc2621 | 306 | 'pseudoconstant' => [ |
e501603b | 307 | 'table' => 'civicrm_navigation', |
e2c44ec0 | 308 | 'keyColumn' => 'id', |
e501603b | 309 | 'labelColumn' => 'label', |
e2c44ec0 | 310 | 'nameColumn' => 'name', |
e6ca0a57 | 311 | ], |
a9d0587b | 312 | 'add' => '3.0', |
c3fc2621 CW |
313 | ], |
314 | 'is_active' => [ | |
e501603b TO |
315 | 'name' => 'is_active', |
316 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 317 | 'title' => ts('Is Active'), |
215b423e | 318 | 'description' => ts('Is this navigation item active?'), |
a36434b9 | 319 | 'where' => 'civicrm_navigation.is_active', |
522a26c9 | 320 | 'table_name' => 'civicrm_navigation', |
321 | 'entity' => 'Navigation', | |
322 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 323 | 'localizable' => 0, |
a9d0587b | 324 | 'add' => '3.0', |
c3fc2621 CW |
325 | ], |
326 | 'has_separator' => [ | |
e501603b | 327 | 'name' => 'has_separator', |
e0674c37 CW |
328 | 'type' => CRM_Utils_Type::T_INT, |
329 | 'title' => ts('Separator'), | |
330 | 'description' => ts('Place a separator either before or after this menu item.'), | |
a36434b9 | 331 | 'where' => 'civicrm_navigation.has_separator', |
e0674c37 | 332 | 'default' => '0', |
522a26c9 | 333 | 'table_name' => 'civicrm_navigation', |
334 | 'entity' => 'Navigation', | |
335 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 336 | 'localizable' => 0, |
e0674c37 CW |
337 | 'pseudoconstant' => [ |
338 | 'callback' => 'CRM_Core_SelectValues::navigationMenuSeparator', | |
339 | ], | |
a9d0587b | 340 | 'add' => '3.0', |
c3fc2621 CW |
341 | ], |
342 | 'weight' => [ | |
e501603b TO |
343 | 'name' => 'weight', |
344 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 345 | 'title' => ts('Order'), |
215b423e | 346 | 'description' => ts('Ordering of the navigation items in various blocks.'), |
a36434b9 | 347 | 'where' => 'civicrm_navigation.weight', |
522a26c9 | 348 | 'table_name' => 'civicrm_navigation', |
349 | 'entity' => 'Navigation', | |
350 | 'bao' => 'CRM_Core_BAO_Navigation', | |
6a7e5e5d | 351 | 'localizable' => 0, |
a9d0587b | 352 | 'add' => '3.0', |
c3fc2621 CW |
353 | ], |
354 | ]; | |
346aaaba | 355 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 356 | } |
346aaaba | 357 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 358 | } |
c3fc2621 | 359 | |
e501603b | 360 | /** |
bd8e0b14 | 361 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
362 | * |
363 | * @return array | |
bd8e0b14 | 364 | * Array(string $name => string $uniqueName). |
e501603b | 365 | */ |
c3fc2621 | 366 | public static function &fieldKeys() { |
bd8e0b14 TO |
367 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
368 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 369 | } |
bd8e0b14 | 370 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 371 | } |
c3fc2621 | 372 | |
e501603b TO |
373 | /** |
374 | * Returns the names of this table | |
375 | * | |
376 | * @return string | |
377 | */ | |
c3fc2621 | 378 | public static function getTableName() { |
e501603b TO |
379 | return self::$_tableName; |
380 | } | |
c3fc2621 | 381 | |
e501603b TO |
382 | /** |
383 | * Returns if this table needs to be logged | |
384 | * | |
c3fc2621 | 385 | * @return bool |
e501603b | 386 | */ |
c3fc2621 | 387 | public function getLog() { |
e501603b TO |
388 | return self::$_log; |
389 | } | |
c3fc2621 | 390 | |
e501603b TO |
391 | /** |
392 | * Returns the list of fields that can be imported | |
393 | * | |
394 | * @param bool $prefix | |
395 | * | |
396 | * @return array | |
397 | */ | |
c3fc2621 CW |
398 | public static function &import($prefix = FALSE) { |
399 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'navigation', $prefix, []); | |
60808919 | 400 | return $r; |
e501603b | 401 | } |
c3fc2621 | 402 | |
e501603b TO |
403 | /** |
404 | * Returns the list of fields that can be exported | |
405 | * | |
406 | * @param bool $prefix | |
407 | * | |
408 | * @return array | |
409 | */ | |
c3fc2621 CW |
410 | public static function &export($prefix = FALSE) { |
411 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'navigation', $prefix, []); | |
60808919 | 412 | return $r; |
e501603b | 413 | } |
c3fc2621 | 414 | |
e7a6b91a AS |
415 | /** |
416 | * Returns the list of indices | |
c3fc2621 CW |
417 | * |
418 | * @param bool $localize | |
419 | * | |
420 | * @return array | |
e7a6b91a AS |
421 | */ |
422 | public static function indices($localize = TRUE) { | |
c3fc2621 | 423 | $indices = []; |
e7a6b91a AS |
424 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
425 | } | |
c3fc2621 | 426 | |
e501603b | 427 | } |