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/Menu.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
8ab43c93 | 9 | * (GenCodeChecksum:6391b63b227b5de3c68bbf951b2e3add) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Menu entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_Menu extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '1.1'; | |
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_menu'; |
c3fc2621 | 25 | |
e501603b | 26 | /** |
f41f0342 | 27 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 28 | * |
c3fc2621 | 29 | * @var bool |
e501603b | 30 | */ |
fa45b5b9 | 31 | public static $_log = FALSE; |
c3fc2621 | 32 | |
e501603b | 33 | /** |
e6ca0a57 | 34 | * @var int |
e501603b TO |
35 | */ |
36 | public $id; | |
c3fc2621 | 37 | |
e501603b TO |
38 | /** |
39 | * Which Domain is this menu item for | |
40 | * | |
e6ca0a57 | 41 | * @var int |
e501603b TO |
42 | */ |
43 | public $domain_id; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * Path Name | |
47 | * | |
48 | * @var string | |
49 | */ | |
50 | public $path; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * Arguments to pass to the url | |
54 | * | |
55 | * @var text | |
56 | */ | |
57 | public $path_arguments; | |
c3fc2621 | 58 | |
e501603b | 59 | /** |
e501603b TO |
60 | * @var string |
61 | */ | |
62 | public $title; | |
c3fc2621 | 63 | |
e501603b TO |
64 | /** |
65 | * Function to call to check access permissions | |
66 | * | |
67 | * @var string | |
68 | */ | |
69 | public $access_callback; | |
c3fc2621 | 70 | |
e501603b TO |
71 | /** |
72 | * Arguments to pass to access callback | |
73 | * | |
74 | * @var text | |
75 | */ | |
76 | public $access_arguments; | |
c3fc2621 | 77 | |
e501603b TO |
78 | /** |
79 | * function to call for this url | |
80 | * | |
81 | * @var string | |
82 | */ | |
83 | public $page_callback; | |
c3fc2621 | 84 | |
e501603b TO |
85 | /** |
86 | * Arguments to pass to page callback | |
87 | * | |
88 | * @var text | |
89 | */ | |
90 | public $page_arguments; | |
c3fc2621 | 91 | |
e501603b TO |
92 | /** |
93 | * Breadcrumb for the path. | |
94 | * | |
95 | * @var text | |
96 | */ | |
97 | public $breadcrumb; | |
c3fc2621 | 98 | |
e501603b TO |
99 | /** |
100 | * Url where a page should redirected to, if next url not known. | |
101 | * | |
102 | * @var string | |
103 | */ | |
104 | public $return_url; | |
c3fc2621 | 105 | |
e501603b TO |
106 | /** |
107 | * Arguments to pass to return_url | |
108 | * | |
109 | * @var string | |
110 | */ | |
111 | public $return_url_args; | |
c3fc2621 | 112 | |
e501603b TO |
113 | /** |
114 | * Component that this menu item belongs to | |
115 | * | |
e6ca0a57 | 116 | * @var int |
e501603b TO |
117 | */ |
118 | public $component_id; | |
c3fc2621 | 119 | |
e501603b TO |
120 | /** |
121 | * Is this menu item active? | |
122 | * | |
e6ca0a57 | 123 | * @var bool |
e501603b TO |
124 | */ |
125 | public $is_active; | |
c3fc2621 | 126 | |
e501603b TO |
127 | /** |
128 | * Is this menu accessible to the public? | |
129 | * | |
e6ca0a57 | 130 | * @var bool |
e501603b TO |
131 | */ |
132 | public $is_public; | |
c3fc2621 | 133 | |
e501603b TO |
134 | /** |
135 | * Is this menu exposed to the navigation system? | |
136 | * | |
e6ca0a57 | 137 | * @var bool |
e501603b TO |
138 | */ |
139 | public $is_exposed; | |
c3fc2621 | 140 | |
e501603b TO |
141 | /** |
142 | * Should this menu be exposed via SSL if enabled? | |
143 | * | |
e6ca0a57 | 144 | * @var bool |
e501603b TO |
145 | */ |
146 | public $is_ssl; | |
c3fc2621 | 147 | |
e501603b TO |
148 | /** |
149 | * Ordering of the menu items in various blocks. | |
150 | * | |
151 | * @var int | |
152 | */ | |
153 | public $weight; | |
c3fc2621 | 154 | |
e501603b TO |
155 | /** |
156 | * Drupal menu type. | |
157 | * | |
158 | * @var int | |
159 | */ | |
160 | public $type; | |
c3fc2621 | 161 | |
e501603b TO |
162 | /** |
163 | * CiviCRM menu type. | |
164 | * | |
165 | * @var int | |
166 | */ | |
167 | public $page_type; | |
c3fc2621 | 168 | |
e501603b TO |
169 | /** |
170 | * skip this url being exposed to breadcrumb | |
171 | * | |
e6ca0a57 | 172 | * @var bool |
e501603b TO |
173 | */ |
174 | public $skipBreadcrumb; | |
c3fc2621 | 175 | |
b44dc91e TO |
176 | /** |
177 | * All other menu metadata not stored in other fields | |
178 | * | |
179 | * @var text | |
180 | */ | |
181 | public $module_data; | |
c3fc2621 | 182 | |
e501603b | 183 | /** |
f41f0342 | 184 | * Class constructor. |
e501603b | 185 | */ |
c3fc2621 | 186 | public function __construct() { |
e501603b TO |
187 | $this->__table = 'civicrm_menu'; |
188 | parent::__construct(); | |
189 | } | |
c3fc2621 | 190 | |
449c4e6b CW |
191 | /** |
192 | * Returns localized title of this entity. | |
7b66c3b5 AH |
193 | * |
194 | * @param bool $plural | |
195 | * Whether to return the plural version of the title. | |
449c4e6b | 196 | */ |
7b66c3b5 AH |
197 | public static function getEntityTitle($plural = FALSE) { |
198 | return $plural ? ts('Menus') : ts('Menu'); | |
449c4e6b CW |
199 | } |
200 | ||
e501603b | 201 | /** |
f41f0342 | 202 | * Returns foreign keys and entity references. |
e501603b TO |
203 | * |
204 | * @return array | |
205 | * [CRM_Core_Reference_Interface] | |
206 | */ | |
c3fc2621 | 207 | public static function getReferenceColumns() { |
346aaaba | 208 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 209 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
210 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'domain_id', 'civicrm_domain', 'id'); |
211 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'component_id', 'civicrm_component', 'id'); | |
346aaaba | 212 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 213 | } |
346aaaba | 214 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 215 | } |
c3fc2621 | 216 | |
e501603b TO |
217 | /** |
218 | * Returns all the column names of this table | |
219 | * | |
220 | * @return array | |
221 | */ | |
c3fc2621 | 222 | public static function &fields() { |
346aaaba | 223 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
224 | Civi::$statics[__CLASS__]['fields'] = [ |
225 | 'id' => [ | |
e501603b TO |
226 | 'name' => 'id', |
227 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
228 | 'title' => ts('Menu ID'), |
229 | 'required' => TRUE, | |
a36434b9 | 230 | 'where' => 'civicrm_menu.id', |
522a26c9 | 231 | 'table_name' => 'civicrm_menu', |
232 | 'entity' => 'Menu', | |
233 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 234 | 'localizable' => 0, |
a9d0587b | 235 | 'add' => '2.1', |
c3fc2621 CW |
236 | ], |
237 | 'domain_id' => [ | |
e501603b TO |
238 | 'name' => 'domain_id', |
239 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 240 | 'title' => ts('Domain'), |
215b423e | 241 | 'description' => ts('Which Domain is this menu item for'), |
c3fc2621 | 242 | 'required' => TRUE, |
a36434b9 | 243 | 'where' => 'civicrm_menu.domain_id', |
522a26c9 | 244 | 'table_name' => 'civicrm_menu', |
245 | 'entity' => 'Menu', | |
246 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 247 | 'localizable' => 0, |
e501603b | 248 | 'FKClassName' => 'CRM_Core_DAO_Domain', |
c3fc2621 | 249 | 'pseudoconstant' => [ |
e501603b TO |
250 | 'table' => 'civicrm_domain', |
251 | 'keyColumn' => 'id', | |
252 | 'labelColumn' => 'name', | |
e6ca0a57 | 253 | ], |
a9d0587b | 254 | 'add' => '3.0', |
c3fc2621 CW |
255 | ], |
256 | 'path' => [ | |
e501603b TO |
257 | 'name' => 'path', |
258 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 259 | 'title' => ts('Path'), |
215b423e | 260 | 'description' => ts('Path Name'), |
e501603b TO |
261 | 'maxlength' => 255, |
262 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 263 | 'where' => 'civicrm_menu.path', |
522a26c9 | 264 | 'table_name' => 'civicrm_menu', |
265 | 'entity' => 'Menu', | |
266 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 267 | 'localizable' => 0, |
a9d0587b | 268 | 'add' => '2.1', |
c3fc2621 CW |
269 | ], |
270 | 'path_arguments' => [ | |
e501603b TO |
271 | 'name' => 'path_arguments', |
272 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 273 | 'title' => ts('Arguments'), |
215b423e | 274 | 'description' => ts('Arguments to pass to the url'), |
a36434b9 | 275 | 'where' => 'civicrm_menu.path_arguments', |
522a26c9 | 276 | 'table_name' => 'civicrm_menu', |
277 | 'entity' => 'Menu', | |
278 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 279 | 'localizable' => 0, |
a9d0587b | 280 | 'add' => '2.1', |
c3fc2621 CW |
281 | ], |
282 | 'title' => [ | |
e501603b TO |
283 | 'name' => 'title', |
284 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 285 | 'title' => ts('Menu Title'), |
e501603b TO |
286 | 'maxlength' => 255, |
287 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 288 | 'where' => 'civicrm_menu.title', |
522a26c9 | 289 | 'table_name' => 'civicrm_menu', |
290 | 'entity' => 'Menu', | |
291 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 292 | 'localizable' => 0, |
a9d0587b | 293 | 'add' => '2.1', |
c3fc2621 CW |
294 | ], |
295 | 'access_callback' => [ | |
e501603b TO |
296 | 'name' => 'access_callback', |
297 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 298 | 'title' => ts('Access Callback'), |
215b423e | 299 | 'description' => ts('Function to call to check access permissions'), |
e501603b TO |
300 | 'maxlength' => 255, |
301 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 302 | 'where' => 'civicrm_menu.access_callback', |
522a26c9 | 303 | 'table_name' => 'civicrm_menu', |
304 | 'entity' => 'Menu', | |
305 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 306 | 'localizable' => 0, |
a9d0587b | 307 | 'add' => '2.1', |
c3fc2621 CW |
308 | ], |
309 | 'access_arguments' => [ | |
e501603b TO |
310 | 'name' => 'access_arguments', |
311 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 312 | 'title' => ts('Access Arguments'), |
215b423e | 313 | 'description' => ts('Arguments to pass to access callback'), |
a36434b9 | 314 | 'where' => 'civicrm_menu.access_arguments', |
522a26c9 | 315 | 'table_name' => 'civicrm_menu', |
316 | 'entity' => 'Menu', | |
317 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 318 | 'localizable' => 0, |
a9d0587b | 319 | 'add' => '2.1', |
c3fc2621 CW |
320 | ], |
321 | 'page_callback' => [ | |
e501603b TO |
322 | 'name' => 'page_callback', |
323 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 324 | 'title' => ts('Page Callback'), |
215b423e | 325 | 'description' => ts('function to call for this url'), |
e501603b TO |
326 | 'maxlength' => 255, |
327 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 328 | 'where' => 'civicrm_menu.page_callback', |
522a26c9 | 329 | 'table_name' => 'civicrm_menu', |
330 | 'entity' => 'Menu', | |
331 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 332 | 'localizable' => 0, |
a9d0587b | 333 | 'add' => '2.1', |
c3fc2621 CW |
334 | ], |
335 | 'page_arguments' => [ | |
e501603b TO |
336 | 'name' => 'page_arguments', |
337 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 338 | 'title' => ts('Page Arguments'), |
215b423e | 339 | 'description' => ts('Arguments to pass to page callback'), |
a36434b9 | 340 | 'where' => 'civicrm_menu.page_arguments', |
522a26c9 | 341 | 'table_name' => 'civicrm_menu', |
342 | 'entity' => 'Menu', | |
343 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 344 | 'localizable' => 0, |
a9d0587b | 345 | 'add' => '2.1', |
c3fc2621 CW |
346 | ], |
347 | 'breadcrumb' => [ | |
e501603b TO |
348 | 'name' => 'breadcrumb', |
349 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 350 | 'title' => ts('Breadcrumb'), |
215b423e | 351 | 'description' => ts('Breadcrumb for the path.'), |
a36434b9 | 352 | 'where' => 'civicrm_menu.breadcrumb', |
522a26c9 | 353 | 'table_name' => 'civicrm_menu', |
354 | 'entity' => 'Menu', | |
355 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 356 | 'localizable' => 0, |
a9d0587b | 357 | 'add' => '2.1', |
c3fc2621 CW |
358 | ], |
359 | 'return_url' => [ | |
e501603b TO |
360 | 'name' => 'return_url', |
361 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 362 | 'title' => ts('Return Url'), |
215b423e | 363 | 'description' => ts('Url where a page should redirected to, if next url not known.'), |
e501603b TO |
364 | 'maxlength' => 255, |
365 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 366 | 'where' => 'civicrm_menu.return_url', |
522a26c9 | 367 | 'table_name' => 'civicrm_menu', |
368 | 'entity' => 'Menu', | |
369 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 370 | 'localizable' => 0, |
a9d0587b | 371 | 'add' => '2.1', |
c3fc2621 CW |
372 | ], |
373 | 'return_url_args' => [ | |
e501603b TO |
374 | 'name' => 'return_url_args', |
375 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 376 | 'title' => ts('Return Url Args'), |
215b423e | 377 | 'description' => ts('Arguments to pass to return_url'), |
e501603b TO |
378 | 'maxlength' => 255, |
379 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 380 | 'where' => 'civicrm_menu.return_url_args', |
522a26c9 | 381 | 'table_name' => 'civicrm_menu', |
382 | 'entity' => 'Menu', | |
383 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 384 | 'localizable' => 0, |
a9d0587b | 385 | 'add' => '2.1', |
c3fc2621 CW |
386 | ], |
387 | 'component_id' => [ | |
e501603b TO |
388 | 'name' => 'component_id', |
389 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 390 | 'title' => ts('Component'), |
215b423e | 391 | 'description' => ts('Component that this menu item belongs to'), |
a36434b9 | 392 | 'where' => 'civicrm_menu.component_id', |
522a26c9 | 393 | 'table_name' => 'civicrm_menu', |
394 | 'entity' => 'Menu', | |
395 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 396 | 'localizable' => 0, |
e501603b | 397 | 'FKClassName' => 'CRM_Core_DAO_Component', |
c3fc2621 | 398 | 'html' => [ |
e501603b | 399 | 'type' => 'Select', |
c3fc2621 CW |
400 | ], |
401 | 'pseudoconstant' => [ | |
e501603b TO |
402 | 'table' => 'civicrm_component', |
403 | 'keyColumn' => 'id', | |
404 | 'labelColumn' => 'name', | |
e6ca0a57 | 405 | ], |
a9d0587b | 406 | 'add' => '2.1', |
c3fc2621 CW |
407 | ], |
408 | 'is_active' => [ | |
e501603b TO |
409 | 'name' => 'is_active', |
410 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 411 | 'title' => ts('Enabled?'), |
215b423e | 412 | 'description' => ts('Is this menu item active?'), |
a36434b9 | 413 | 'where' => 'civicrm_menu.is_active', |
522a26c9 | 414 | 'table_name' => 'civicrm_menu', |
415 | 'entity' => 'Menu', | |
416 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 417 | 'localizable' => 0, |
a9d0587b | 418 | 'add' => '2.1', |
c3fc2621 CW |
419 | ], |
420 | 'is_public' => [ | |
e501603b TO |
421 | 'name' => 'is_public', |
422 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 423 | 'title' => ts('Public?'), |
215b423e | 424 | 'description' => ts('Is this menu accessible to the public?'), |
a36434b9 | 425 | 'where' => 'civicrm_menu.is_public', |
522a26c9 | 426 | 'table_name' => 'civicrm_menu', |
427 | 'entity' => 'Menu', | |
428 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 429 | 'localizable' => 0, |
a9d0587b | 430 | 'add' => '2.1', |
c3fc2621 CW |
431 | ], |
432 | 'is_exposed' => [ | |
e501603b TO |
433 | 'name' => 'is_exposed', |
434 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 435 | 'title' => ts('Exposed?'), |
215b423e | 436 | 'description' => ts('Is this menu exposed to the navigation system?'), |
a36434b9 | 437 | 'where' => 'civicrm_menu.is_exposed', |
522a26c9 | 438 | 'table_name' => 'civicrm_menu', |
439 | 'entity' => 'Menu', | |
440 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 441 | 'localizable' => 0, |
a9d0587b | 442 | 'add' => '2.1', |
c3fc2621 CW |
443 | ], |
444 | 'is_ssl' => [ | |
e501603b TO |
445 | 'name' => 'is_ssl', |
446 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 447 | 'title' => ts('Use SSL?'), |
215b423e | 448 | 'description' => ts('Should this menu be exposed via SSL if enabled?'), |
a36434b9 | 449 | 'where' => 'civicrm_menu.is_ssl', |
522a26c9 | 450 | 'table_name' => 'civicrm_menu', |
451 | 'entity' => 'Menu', | |
452 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 453 | 'localizable' => 0, |
a9d0587b | 454 | 'add' => '2.1', |
c3fc2621 CW |
455 | ], |
456 | 'weight' => [ | |
e501603b TO |
457 | 'name' => 'weight', |
458 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 459 | 'title' => ts('Order'), |
215b423e | 460 | 'description' => ts('Ordering of the menu items in various blocks.'), |
c3fc2621 | 461 | 'required' => TRUE, |
a36434b9 | 462 | 'where' => 'civicrm_menu.weight', |
e501603b | 463 | 'default' => '1', |
522a26c9 | 464 | 'table_name' => 'civicrm_menu', |
465 | 'entity' => 'Menu', | |
466 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 467 | 'localizable' => 0, |
a9d0587b | 468 | 'add' => '2.1', |
c3fc2621 CW |
469 | ], |
470 | 'type' => [ | |
e501603b TO |
471 | 'name' => 'type', |
472 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 473 | 'title' => ts('Type'), |
215b423e | 474 | 'description' => ts('Drupal menu type.'), |
c3fc2621 | 475 | 'required' => TRUE, |
a36434b9 | 476 | 'where' => 'civicrm_menu.type', |
e501603b | 477 | 'default' => '1', |
522a26c9 | 478 | 'table_name' => 'civicrm_menu', |
479 | 'entity' => 'Menu', | |
480 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 481 | 'localizable' => 0, |
a9d0587b | 482 | 'add' => '2.1', |
c3fc2621 CW |
483 | ], |
484 | 'page_type' => [ | |
e501603b TO |
485 | 'name' => 'page_type', |
486 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 487 | 'title' => ts('Page Type'), |
215b423e | 488 | 'description' => ts('CiviCRM menu type.'), |
c3fc2621 | 489 | 'required' => TRUE, |
a36434b9 | 490 | 'where' => 'civicrm_menu.page_type', |
e501603b | 491 | 'default' => '1', |
522a26c9 | 492 | 'table_name' => 'civicrm_menu', |
493 | 'entity' => 'Menu', | |
494 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 495 | 'localizable' => 0, |
a9d0587b | 496 | 'add' => '2.1', |
c3fc2621 CW |
497 | ], |
498 | 'skipBreadcrumb' => [ | |
e501603b TO |
499 | 'name' => 'skipBreadcrumb', |
500 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 501 | 'title' => ts('Hide Breadcrumb?'), |
215b423e | 502 | 'description' => ts('skip this url being exposed to breadcrumb'), |
a36434b9 | 503 | 'where' => 'civicrm_menu.skipBreadcrumb', |
522a26c9 | 504 | 'table_name' => 'civicrm_menu', |
505 | 'entity' => 'Menu', | |
b44dc91e TO |
506 | 'bao' => 'CRM_Core_DAO_Menu', |
507 | 'localizable' => 0, | |
a9d0587b | 508 | 'add' => '2.2', |
c3fc2621 CW |
509 | ], |
510 | 'module_data' => [ | |
b44dc91e TO |
511 | 'name' => 'module_data', |
512 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 513 | 'title' => ts('Other menu data'), |
215b423e | 514 | 'description' => ts('All other menu metadata not stored in other fields'), |
a36434b9 | 515 | 'where' => 'civicrm_menu.module_data', |
b44dc91e TO |
516 | 'table_name' => 'civicrm_menu', |
517 | 'entity' => 'Menu', | |
522a26c9 | 518 | 'bao' => 'CRM_Core_DAO_Menu', |
6a7e5e5d | 519 | 'localizable' => 0, |
a9d0587b | 520 | 'add' => '4.7', |
c3fc2621 CW |
521 | ], |
522 | ]; | |
346aaaba | 523 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 524 | } |
346aaaba | 525 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 526 | } |
c3fc2621 | 527 | |
e501603b | 528 | /** |
bd8e0b14 | 529 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
530 | * |
531 | * @return array | |
bd8e0b14 | 532 | * Array(string $name => string $uniqueName). |
e501603b | 533 | */ |
c3fc2621 | 534 | public static function &fieldKeys() { |
bd8e0b14 TO |
535 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
536 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 537 | } |
bd8e0b14 | 538 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 539 | } |
c3fc2621 | 540 | |
e501603b TO |
541 | /** |
542 | * Returns the names of this table | |
543 | * | |
544 | * @return string | |
545 | */ | |
c3fc2621 | 546 | public static function getTableName() { |
e501603b TO |
547 | return self::$_tableName; |
548 | } | |
c3fc2621 | 549 | |
e501603b TO |
550 | /** |
551 | * Returns if this table needs to be logged | |
552 | * | |
c3fc2621 | 553 | * @return bool |
e501603b | 554 | */ |
c3fc2621 | 555 | public function getLog() { |
e501603b TO |
556 | return self::$_log; |
557 | } | |
c3fc2621 | 558 | |
e501603b TO |
559 | /** |
560 | * Returns the list of fields that can be imported | |
561 | * | |
562 | * @param bool $prefix | |
563 | * | |
564 | * @return array | |
565 | */ | |
c3fc2621 CW |
566 | public static function &import($prefix = FALSE) { |
567 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'menu', $prefix, []); | |
60808919 | 568 | return $r; |
e501603b | 569 | } |
c3fc2621 | 570 | |
e501603b TO |
571 | /** |
572 | * Returns the list of fields that can be exported | |
573 | * | |
574 | * @param bool $prefix | |
575 | * | |
576 | * @return array | |
577 | */ | |
c3fc2621 CW |
578 | public static function &export($prefix = FALSE) { |
579 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'menu', $prefix, []); | |
60808919 | 580 | return $r; |
e501603b | 581 | } |
c3fc2621 | 582 | |
e7a6b91a AS |
583 | /** |
584 | * Returns the list of indices | |
c3fc2621 CW |
585 | * |
586 | * @param bool $localize | |
587 | * | |
588 | * @return array | |
e7a6b91a AS |
589 | */ |
590 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
591 | $indices = [ |
592 | 'UI_path_domain_id' => [ | |
e7a6b91a | 593 | 'name' => 'UI_path_domain_id', |
c3fc2621 | 594 | 'field' => [ |
e7a6b91a AS |
595 | 0 => 'path', |
596 | 1 => 'domain_id', | |
c3fc2621 CW |
597 | ], |
598 | 'localizable' => FALSE, | |
599 | 'unique' => TRUE, | |
e7a6b91a | 600 | 'sig' => 'civicrm_menu::1::path::domain_id', |
c3fc2621 CW |
601 | ], |
602 | ]; | |
e7a6b91a AS |
603 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
604 | } | |
c3fc2621 | 605 | |
e501603b | 606 | } |