Commit | Line | Data |
---|---|---|
e501603b TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2016 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | /** | |
28 | * @package CRM | |
29 | * @copyright CiviCRM LLC (c) 2004-2016 | |
30 | * | |
31 | * Generated from xml/schema/CRM/Core/Navigation.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
437fafcf | 33 | * (GenCodeChecksum:28492fb431c3874453b53d0af4e3834a) |
e501603b TO |
34 | */ |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
37 | class CRM_Core_DAO_Navigation extends CRM_Core_DAO { | |
38 | /** | |
39 | * static instance to hold the table name | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | static $_tableName = 'civicrm_navigation'; | |
e501603b TO |
44 | /** |
45 | * static value to see if we should log any modifications to | |
46 | * this table in the civicrm_log table | |
47 | * | |
48 | * @var boolean | |
49 | */ | |
50 | static $_log = false; | |
51 | /** | |
52 | * | |
53 | * @var int unsigned | |
54 | */ | |
55 | public $id; | |
56 | /** | |
57 | * Which Domain is this navigation item for | |
58 | * | |
59 | * @var int unsigned | |
60 | */ | |
61 | public $domain_id; | |
62 | /** | |
63 | * Navigation Title | |
64 | * | |
65 | * @var string | |
66 | */ | |
67 | public $label; | |
68 | /** | |
69 | * Internal Name | |
70 | * | |
71 | * @var string | |
72 | */ | |
73 | public $name; | |
74 | /** | |
75 | * url in case of custom navigation link | |
76 | * | |
77 | * @var string | |
78 | */ | |
79 | public $url; | |
80 | /** | |
81 | * Permission for menu item | |
82 | * | |
83 | * @var string | |
84 | */ | |
85 | public $permission; | |
86 | /** | |
87 | * Permission Operator | |
88 | * | |
89 | * @var string | |
90 | */ | |
91 | public $permission_operator; | |
92 | /** | |
93 | * Parent navigation item, used for grouping | |
94 | * | |
95 | * @var int unsigned | |
96 | */ | |
97 | public $parent_id; | |
98 | /** | |
99 | * Is this navigation item active? | |
100 | * | |
101 | * @var boolean | |
102 | */ | |
103 | public $is_active; | |
104 | /** | |
105 | * If separator needs to be added after this menu item | |
106 | * | |
107 | * @var boolean | |
108 | */ | |
109 | public $has_separator; | |
110 | /** | |
111 | * Ordering of the navigation items in various blocks. | |
112 | * | |
113 | * @var int | |
114 | */ | |
115 | public $weight; | |
116 | /** | |
117 | * class constructor | |
118 | * | |
119 | * @return civicrm_navigation | |
120 | */ | |
121 | function __construct() { | |
122 | $this->__table = 'civicrm_navigation'; | |
123 | parent::__construct(); | |
124 | } | |
125 | /** | |
126 | * Returns foreign keys and entity references | |
127 | * | |
128 | * @return array | |
129 | * [CRM_Core_Reference_Interface] | |
130 | */ | |
131 | static function getReferenceColumns() { | |
346aaaba TO |
132 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
133 | Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__); | |
134 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'domain_id', 'civicrm_domain', 'id'); | |
135 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'parent_id', 'civicrm_navigation', 'id'); | |
136 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); | |
e501603b | 137 | } |
346aaaba | 138 | return Civi::$statics[__CLASS__]['links']; |
e501603b TO |
139 | } |
140 | /** | |
141 | * Returns all the column names of this table | |
142 | * | |
143 | * @return array | |
144 | */ | |
145 | static function &fields() { | |
346aaaba TO |
146 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
147 | Civi::$statics[__CLASS__]['fields'] = array( | |
e501603b TO |
148 | 'id' => array( |
149 | 'name' => 'id', | |
150 | 'type' => CRM_Utils_Type::T_INT, | |
151 | 'title' => ts('Navigation ID') , | |
152 | 'required' => true, | |
153 | ) , | |
154 | 'domain_id' => array( | |
155 | 'name' => 'domain_id', | |
156 | 'type' => CRM_Utils_Type::T_INT, | |
157 | 'title' => ts('Navigation Domain') , | |
158 | 'description' => 'Which Domain is this navigation item for', | |
159 | 'required' => true, | |
160 | 'FKClassName' => 'CRM_Core_DAO_Domain', | |
161 | 'pseudoconstant' => array( | |
162 | 'table' => 'civicrm_domain', | |
163 | 'keyColumn' => 'id', | |
164 | 'labelColumn' => 'name', | |
165 | ) | |
166 | ) , | |
167 | 'label' => array( | |
168 | 'name' => 'label', | |
169 | 'type' => CRM_Utils_Type::T_STRING, | |
170 | 'title' => ts('Navigation Item Label') , | |
171 | 'description' => 'Navigation Title', | |
172 | 'maxlength' => 255, | |
173 | 'size' => CRM_Utils_Type::HUGE, | |
174 | ) , | |
175 | 'name' => array( | |
176 | 'name' => 'name', | |
177 | 'type' => CRM_Utils_Type::T_STRING, | |
178 | 'title' => ts('Navigation Item Machine Name') , | |
179 | 'description' => 'Internal Name', | |
180 | 'maxlength' => 255, | |
181 | 'size' => CRM_Utils_Type::HUGE, | |
182 | ) , | |
183 | 'url' => array( | |
184 | 'name' => 'url', | |
185 | 'type' => CRM_Utils_Type::T_STRING, | |
186 | 'title' => ts('Url') , | |
187 | 'description' => 'url in case of custom navigation link', | |
188 | 'maxlength' => 255, | |
189 | 'size' => CRM_Utils_Type::HUGE, | |
190 | ) , | |
191 | 'permission' => array( | |
192 | 'name' => 'permission', | |
193 | 'type' => CRM_Utils_Type::T_STRING, | |
194 | 'title' => ts('Required Permission') , | |
195 | 'description' => 'Permission for menu item', | |
196 | 'maxlength' => 255, | |
197 | 'size' => CRM_Utils_Type::HUGE, | |
198 | ) , | |
199 | 'permission_operator' => array( | |
200 | 'name' => 'permission_operator', | |
201 | 'type' => CRM_Utils_Type::T_STRING, | |
202 | 'title' => ts('Permission Operator') , | |
203 | 'description' => 'Permission Operator', | |
204 | 'maxlength' => 3, | |
205 | 'size' => CRM_Utils_Type::FOUR, | |
206 | ) , | |
207 | 'parent_id' => array( | |
208 | 'name' => 'parent_id', | |
209 | 'type' => CRM_Utils_Type::T_INT, | |
210 | 'title' => ts('Navigation parent ID') , | |
211 | 'description' => 'Parent navigation item, used for grouping', | |
212 | 'FKClassName' => 'CRM_Core_DAO_Navigation', | |
213 | 'pseudoconstant' => array( | |
214 | 'table' => 'civicrm_navigation', | |
215 | 'keyColumn' => 'name', | |
216 | 'labelColumn' => 'label', | |
217 | ) | |
218 | ) , | |
219 | 'is_active' => array( | |
220 | 'name' => 'is_active', | |
221 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
222 | 'title' => ts('Is Active') , | |
223 | 'description' => 'Is this navigation item active?', | |
224 | ) , | |
225 | 'has_separator' => array( | |
226 | 'name' => 'has_separator', | |
227 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
228 | 'title' => ts('Use separator') , | |
229 | 'description' => 'If separator needs to be added after this menu item', | |
230 | ) , | |
231 | 'weight' => array( | |
232 | 'name' => 'weight', | |
233 | 'type' => CRM_Utils_Type::T_INT, | |
234 | 'title' => ts('Order') , | |
235 | 'description' => 'Ordering of the navigation items in various blocks.', | |
236 | ) , | |
237 | ); | |
346aaaba | 238 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 239 | } |
346aaaba | 240 | return Civi::$statics[__CLASS__]['fields']; |
e501603b TO |
241 | } |
242 | /** | |
bd8e0b14 | 243 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
244 | * |
245 | * @return array | |
bd8e0b14 | 246 | * Array(string $name => string $uniqueName). |
e501603b TO |
247 | */ |
248 | static function &fieldKeys() { | |
bd8e0b14 TO |
249 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
250 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 251 | } |
bd8e0b14 | 252 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b TO |
253 | } |
254 | /** | |
255 | * Returns the names of this table | |
256 | * | |
257 | * @return string | |
258 | */ | |
259 | static function getTableName() { | |
260 | return self::$_tableName; | |
261 | } | |
262 | /** | |
263 | * Returns if this table needs to be logged | |
264 | * | |
265 | * @return boolean | |
266 | */ | |
267 | function getLog() { | |
268 | return self::$_log; | |
269 | } | |
270 | /** | |
271 | * Returns the list of fields that can be imported | |
272 | * | |
273 | * @param bool $prefix | |
274 | * | |
275 | * @return array | |
276 | */ | |
277 | static function &import($prefix = false) { | |
60808919 TO |
278 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'navigation', $prefix, array()); |
279 | return $r; | |
e501603b TO |
280 | } |
281 | /** | |
282 | * Returns the list of fields that can be exported | |
283 | * | |
284 | * @param bool $prefix | |
285 | * | |
286 | * @return array | |
287 | */ | |
288 | static function &export($prefix = false) { | |
60808919 TO |
289 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'navigation', $prefix, array()); |
290 | return $r; | |
e501603b TO |
291 | } |
292 | } |