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 | |
2562d09a | 9 | * (GenCodeChecksum:43fa7e0ff85619af0065d2802de6f8f4) |
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, |
2cbbebe8 A |
235 | 'html' => [ |
236 | 'type' => 'Number', | |
237 | ], | |
1fe423d6 | 238 | 'readonly' => TRUE, |
a9d0587b | 239 | 'add' => '2.1', |
c3fc2621 CW |
240 | ], |
241 | 'domain_id' => [ | |
e501603b TO |
242 | 'name' => 'domain_id', |
243 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 244 | 'title' => ts('Domain ID'), |
215b423e | 245 | 'description' => ts('Which Domain is this menu item for'), |
c3fc2621 | 246 | 'required' => TRUE, |
a36434b9 | 247 | 'where' => 'civicrm_menu.domain_id', |
522a26c9 | 248 | 'table_name' => 'civicrm_menu', |
249 | 'entity' => 'Menu', | |
250 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 251 | 'localizable' => 0, |
e501603b | 252 | 'FKClassName' => 'CRM_Core_DAO_Domain', |
2cbbebe8 A |
253 | 'html' => [ |
254 | 'label' => ts("Domain"), | |
255 | ], | |
c3fc2621 | 256 | 'pseudoconstant' => [ |
e501603b TO |
257 | 'table' => 'civicrm_domain', |
258 | 'keyColumn' => 'id', | |
259 | 'labelColumn' => 'name', | |
e6ca0a57 | 260 | ], |
a9d0587b | 261 | 'add' => '3.0', |
c3fc2621 CW |
262 | ], |
263 | 'path' => [ | |
e501603b TO |
264 | 'name' => 'path', |
265 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 266 | 'title' => ts('Path'), |
215b423e | 267 | 'description' => ts('Path Name'), |
e501603b TO |
268 | 'maxlength' => 255, |
269 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 270 | 'where' => 'civicrm_menu.path', |
522a26c9 | 271 | 'table_name' => 'civicrm_menu', |
272 | 'entity' => 'Menu', | |
273 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 274 | 'localizable' => 0, |
a9d0587b | 275 | 'add' => '2.1', |
c3fc2621 CW |
276 | ], |
277 | 'path_arguments' => [ | |
e501603b TO |
278 | 'name' => 'path_arguments', |
279 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 280 | 'title' => ts('Arguments'), |
215b423e | 281 | 'description' => ts('Arguments to pass to the url'), |
a36434b9 | 282 | 'where' => 'civicrm_menu.path_arguments', |
522a26c9 | 283 | 'table_name' => 'civicrm_menu', |
284 | 'entity' => 'Menu', | |
285 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 286 | 'localizable' => 0, |
a9d0587b | 287 | 'add' => '2.1', |
c3fc2621 CW |
288 | ], |
289 | 'title' => [ | |
e501603b TO |
290 | 'name' => 'title', |
291 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 292 | 'title' => ts('Menu Title'), |
e501603b TO |
293 | 'maxlength' => 255, |
294 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 295 | 'where' => 'civicrm_menu.title', |
522a26c9 | 296 | 'table_name' => 'civicrm_menu', |
297 | 'entity' => 'Menu', | |
298 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 299 | 'localizable' => 0, |
a9d0587b | 300 | 'add' => '2.1', |
c3fc2621 CW |
301 | ], |
302 | 'access_callback' => [ | |
e501603b TO |
303 | 'name' => 'access_callback', |
304 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 305 | 'title' => ts('Access Callback'), |
215b423e | 306 | 'description' => ts('Function to call to check access permissions'), |
e501603b TO |
307 | 'maxlength' => 255, |
308 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 309 | 'where' => 'civicrm_menu.access_callback', |
522a26c9 | 310 | 'table_name' => 'civicrm_menu', |
311 | 'entity' => 'Menu', | |
312 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 313 | 'localizable' => 0, |
a9d0587b | 314 | 'add' => '2.1', |
c3fc2621 CW |
315 | ], |
316 | 'access_arguments' => [ | |
e501603b TO |
317 | 'name' => 'access_arguments', |
318 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 319 | 'title' => ts('Access Arguments'), |
215b423e | 320 | 'description' => ts('Arguments to pass to access callback'), |
a36434b9 | 321 | 'where' => 'civicrm_menu.access_arguments', |
522a26c9 | 322 | 'table_name' => 'civicrm_menu', |
323 | 'entity' => 'Menu', | |
324 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 325 | 'localizable' => 0, |
a9d0587b | 326 | 'add' => '2.1', |
c3fc2621 CW |
327 | ], |
328 | 'page_callback' => [ | |
e501603b TO |
329 | 'name' => 'page_callback', |
330 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 331 | 'title' => ts('Page Callback'), |
215b423e | 332 | 'description' => ts('function to call for this url'), |
e501603b TO |
333 | 'maxlength' => 255, |
334 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 335 | 'where' => 'civicrm_menu.page_callback', |
522a26c9 | 336 | 'table_name' => 'civicrm_menu', |
337 | 'entity' => 'Menu', | |
338 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 339 | 'localizable' => 0, |
a9d0587b | 340 | 'add' => '2.1', |
c3fc2621 CW |
341 | ], |
342 | 'page_arguments' => [ | |
e501603b TO |
343 | 'name' => 'page_arguments', |
344 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 345 | 'title' => ts('Page Arguments'), |
215b423e | 346 | 'description' => ts('Arguments to pass to page callback'), |
a36434b9 | 347 | 'where' => 'civicrm_menu.page_arguments', |
522a26c9 | 348 | 'table_name' => 'civicrm_menu', |
349 | 'entity' => 'Menu', | |
350 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 351 | 'localizable' => 0, |
a9d0587b | 352 | 'add' => '2.1', |
c3fc2621 CW |
353 | ], |
354 | 'breadcrumb' => [ | |
e501603b TO |
355 | 'name' => 'breadcrumb', |
356 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 357 | 'title' => ts('Breadcrumb'), |
215b423e | 358 | 'description' => ts('Breadcrumb for the path.'), |
a36434b9 | 359 | 'where' => 'civicrm_menu.breadcrumb', |
522a26c9 | 360 | 'table_name' => 'civicrm_menu', |
361 | 'entity' => 'Menu', | |
362 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 363 | 'localizable' => 0, |
a9d0587b | 364 | 'add' => '2.1', |
c3fc2621 CW |
365 | ], |
366 | 'return_url' => [ | |
e501603b TO |
367 | 'name' => 'return_url', |
368 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 369 | 'title' => ts('Return Url'), |
215b423e | 370 | 'description' => ts('Url where a page should redirected to, if next url not known.'), |
e501603b TO |
371 | 'maxlength' => 255, |
372 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 373 | 'where' => 'civicrm_menu.return_url', |
522a26c9 | 374 | 'table_name' => 'civicrm_menu', |
375 | 'entity' => 'Menu', | |
376 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 377 | 'localizable' => 0, |
c23563e3 SL |
378 | 'html' => [ |
379 | 'label' => ts("Return URL"), | |
380 | ], | |
a9d0587b | 381 | 'add' => '2.1', |
c3fc2621 CW |
382 | ], |
383 | 'return_url_args' => [ | |
e501603b TO |
384 | 'name' => 'return_url_args', |
385 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 386 | 'title' => ts('Return Url Args'), |
215b423e | 387 | 'description' => ts('Arguments to pass to return_url'), |
e501603b TO |
388 | 'maxlength' => 255, |
389 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 390 | 'where' => 'civicrm_menu.return_url_args', |
522a26c9 | 391 | 'table_name' => 'civicrm_menu', |
392 | 'entity' => 'Menu', | |
393 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 394 | 'localizable' => 0, |
c23563e3 SL |
395 | 'html' => [ |
396 | 'label' => ts("Return URL Arguments"), | |
397 | ], | |
a9d0587b | 398 | 'add' => '2.1', |
c3fc2621 CW |
399 | ], |
400 | 'component_id' => [ | |
e501603b TO |
401 | 'name' => 'component_id', |
402 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 403 | 'title' => ts('Component ID'), |
215b423e | 404 | 'description' => ts('Component that this menu item belongs to'), |
a36434b9 | 405 | 'where' => 'civicrm_menu.component_id', |
522a26c9 | 406 | 'table_name' => 'civicrm_menu', |
407 | 'entity' => 'Menu', | |
408 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 409 | 'localizable' => 0, |
e501603b | 410 | 'FKClassName' => 'CRM_Core_DAO_Component', |
c3fc2621 | 411 | 'html' => [ |
e501603b | 412 | 'type' => 'Select', |
2cbbebe8 | 413 | 'label' => ts("Component"), |
c3fc2621 CW |
414 | ], |
415 | 'pseudoconstant' => [ | |
e501603b TO |
416 | 'table' => 'civicrm_component', |
417 | 'keyColumn' => 'id', | |
418 | 'labelColumn' => 'name', | |
e6ca0a57 | 419 | ], |
a9d0587b | 420 | 'add' => '2.1', |
c3fc2621 CW |
421 | ], |
422 | 'is_active' => [ | |
e501603b TO |
423 | 'name' => 'is_active', |
424 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 425 | 'title' => ts('Enabled?'), |
215b423e | 426 | 'description' => ts('Is this menu item active?'), |
a36434b9 | 427 | 'where' => 'civicrm_menu.is_active', |
522a26c9 | 428 | 'table_name' => 'civicrm_menu', |
429 | 'entity' => 'Menu', | |
430 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 431 | 'localizable' => 0, |
a9d0587b | 432 | 'add' => '2.1', |
c3fc2621 CW |
433 | ], |
434 | 'is_public' => [ | |
e501603b TO |
435 | 'name' => 'is_public', |
436 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 437 | 'title' => ts('Public?'), |
215b423e | 438 | 'description' => ts('Is this menu accessible to the public?'), |
a36434b9 | 439 | 'where' => 'civicrm_menu.is_public', |
522a26c9 | 440 | 'table_name' => 'civicrm_menu', |
441 | 'entity' => 'Menu', | |
442 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 443 | 'localizable' => 0, |
a9d0587b | 444 | 'add' => '2.1', |
c3fc2621 CW |
445 | ], |
446 | 'is_exposed' => [ | |
e501603b TO |
447 | 'name' => 'is_exposed', |
448 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 449 | 'title' => ts('Exposed?'), |
215b423e | 450 | 'description' => ts('Is this menu exposed to the navigation system?'), |
a36434b9 | 451 | 'where' => 'civicrm_menu.is_exposed', |
522a26c9 | 452 | 'table_name' => 'civicrm_menu', |
453 | 'entity' => 'Menu', | |
454 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 455 | 'localizable' => 0, |
a9d0587b | 456 | 'add' => '2.1', |
c3fc2621 CW |
457 | ], |
458 | 'is_ssl' => [ | |
e501603b TO |
459 | 'name' => 'is_ssl', |
460 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 461 | 'title' => ts('Use SSL?'), |
215b423e | 462 | 'description' => ts('Should this menu be exposed via SSL if enabled?'), |
a36434b9 | 463 | 'where' => 'civicrm_menu.is_ssl', |
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 | 'weight' => [ | |
e501603b TO |
471 | 'name' => 'weight', |
472 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 473 | 'title' => ts('Order'), |
215b423e | 474 | 'description' => ts('Ordering of the menu items in various blocks.'), |
c3fc2621 | 475 | 'required' => TRUE, |
a36434b9 | 476 | 'where' => 'civicrm_menu.weight', |
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 | 'type' => [ | |
e501603b TO |
485 | 'name' => 'type', |
486 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 487 | 'title' => ts('Type'), |
215b423e | 488 | 'description' => ts('Drupal menu type.'), |
c3fc2621 | 489 | 'required' => TRUE, |
a36434b9 | 490 | 'where' => 'civicrm_menu.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 | 'page_type' => [ | |
e501603b TO |
499 | 'name' => 'page_type', |
500 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 501 | 'title' => ts('Page Type'), |
215b423e | 502 | 'description' => ts('CiviCRM menu type.'), |
c3fc2621 | 503 | 'required' => TRUE, |
a36434b9 | 504 | 'where' => 'civicrm_menu.page_type', |
e501603b | 505 | 'default' => '1', |
522a26c9 | 506 | 'table_name' => 'civicrm_menu', |
507 | 'entity' => 'Menu', | |
508 | 'bao' => 'CRM_Core_DAO_Menu', | |
6a7e5e5d | 509 | 'localizable' => 0, |
a9d0587b | 510 | 'add' => '2.1', |
c3fc2621 CW |
511 | ], |
512 | 'skipBreadcrumb' => [ | |
e501603b TO |
513 | 'name' => 'skipBreadcrumb', |
514 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 515 | 'title' => ts('Hide Breadcrumb?'), |
215b423e | 516 | 'description' => ts('skip this url being exposed to breadcrumb'), |
a36434b9 | 517 | 'where' => 'civicrm_menu.skipBreadcrumb', |
522a26c9 | 518 | 'table_name' => 'civicrm_menu', |
519 | 'entity' => 'Menu', | |
b44dc91e TO |
520 | 'bao' => 'CRM_Core_DAO_Menu', |
521 | 'localizable' => 0, | |
a9d0587b | 522 | 'add' => '2.2', |
c3fc2621 CW |
523 | ], |
524 | 'module_data' => [ | |
b44dc91e TO |
525 | 'name' => 'module_data', |
526 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 527 | 'title' => ts('Other menu data'), |
215b423e | 528 | 'description' => ts('All other menu metadata not stored in other fields'), |
a36434b9 | 529 | 'where' => 'civicrm_menu.module_data', |
b44dc91e TO |
530 | 'table_name' => 'civicrm_menu', |
531 | 'entity' => 'Menu', | |
522a26c9 | 532 | 'bao' => 'CRM_Core_DAO_Menu', |
6a7e5e5d | 533 | 'localizable' => 0, |
a9d0587b | 534 | 'add' => '4.7', |
c3fc2621 CW |
535 | ], |
536 | ]; | |
346aaaba | 537 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 538 | } |
346aaaba | 539 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 540 | } |
c3fc2621 | 541 | |
e501603b | 542 | /** |
bd8e0b14 | 543 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
544 | * |
545 | * @return array | |
bd8e0b14 | 546 | * Array(string $name => string $uniqueName). |
e501603b | 547 | */ |
c3fc2621 | 548 | public static function &fieldKeys() { |
bd8e0b14 TO |
549 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
550 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 551 | } |
bd8e0b14 | 552 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 553 | } |
c3fc2621 | 554 | |
e501603b TO |
555 | /** |
556 | * Returns the names of this table | |
557 | * | |
558 | * @return string | |
559 | */ | |
c3fc2621 | 560 | public static function getTableName() { |
e501603b TO |
561 | return self::$_tableName; |
562 | } | |
c3fc2621 | 563 | |
e501603b TO |
564 | /** |
565 | * Returns if this table needs to be logged | |
566 | * | |
c3fc2621 | 567 | * @return bool |
e501603b | 568 | */ |
c3fc2621 | 569 | public function getLog() { |
e501603b TO |
570 | return self::$_log; |
571 | } | |
c3fc2621 | 572 | |
e501603b TO |
573 | /** |
574 | * Returns the list of fields that can be imported | |
575 | * | |
576 | * @param bool $prefix | |
577 | * | |
578 | * @return array | |
579 | */ | |
c3fc2621 CW |
580 | public static function &import($prefix = FALSE) { |
581 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'menu', $prefix, []); | |
60808919 | 582 | return $r; |
e501603b | 583 | } |
c3fc2621 | 584 | |
e501603b TO |
585 | /** |
586 | * Returns the list of fields that can be exported | |
587 | * | |
588 | * @param bool $prefix | |
589 | * | |
590 | * @return array | |
591 | */ | |
c3fc2621 CW |
592 | public static function &export($prefix = FALSE) { |
593 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'menu', $prefix, []); | |
60808919 | 594 | return $r; |
e501603b | 595 | } |
c3fc2621 | 596 | |
e7a6b91a AS |
597 | /** |
598 | * Returns the list of indices | |
c3fc2621 CW |
599 | * |
600 | * @param bool $localize | |
601 | * | |
602 | * @return array | |
e7a6b91a AS |
603 | */ |
604 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
605 | $indices = [ |
606 | 'UI_path_domain_id' => [ | |
e7a6b91a | 607 | 'name' => 'UI_path_domain_id', |
c3fc2621 | 608 | 'field' => [ |
e7a6b91a AS |
609 | 0 => 'path', |
610 | 1 => 'domain_id', | |
c3fc2621 CW |
611 | ], |
612 | 'localizable' => FALSE, | |
613 | 'unique' => TRUE, | |
e7a6b91a | 614 | 'sig' => 'civicrm_menu::1::path::domain_id', |
c3fc2621 CW |
615 | ], |
616 | ]; | |
e7a6b91a AS |
617 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
618 | } | |
c3fc2621 | 619 | |
e501603b | 620 | } |