Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
6b83d5bd | 5 | * @copyright CiviCRM LLC (c) 2004-2019 |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Core/Tag.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
74db51d3 | 9 | * (GenCodeChecksum:9f26fdcff51afe66519e1c06518dccca) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Tag entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_Tag extends CRM_Core_DAO { |
c3fc2621 | 16 | |
e501603b | 17 | /** |
f41f0342 | 18 | * Static instance to hold the table name. |
e501603b TO |
19 | * |
20 | * @var string | |
21 | */ | |
fa45b5b9 | 22 | public static $_tableName = 'civicrm_tag'; |
c3fc2621 | 23 | |
e501603b | 24 | /** |
f41f0342 | 25 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 26 | * |
c3fc2621 | 27 | * @var bool |
e501603b | 28 | */ |
fa45b5b9 | 29 | public static $_log = TRUE; |
c3fc2621 | 30 | |
e501603b TO |
31 | /** |
32 | * Tag ID | |
33 | * | |
e6ca0a57 | 34 | * @var int |
e501603b TO |
35 | */ |
36 | public $id; | |
c3fc2621 | 37 | |
e501603b TO |
38 | /** |
39 | * Name of Tag. | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | public $name; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * Optional verbose description of the tag. | |
47 | * | |
48 | * @var string | |
49 | */ | |
50 | public $description; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * Optional parent id for this tag. | |
54 | * | |
e6ca0a57 | 55 | * @var int |
e501603b TO |
56 | */ |
57 | public $parent_id; | |
c3fc2621 | 58 | |
e501603b TO |
59 | /** |
60 | * Is this tag selectable / displayed | |
61 | * | |
e6ca0a57 | 62 | * @var bool |
e501603b TO |
63 | */ |
64 | public $is_selectable; | |
c3fc2621 | 65 | |
e501603b | 66 | /** |
e6ca0a57 | 67 | * @var bool |
e501603b TO |
68 | */ |
69 | public $is_reserved; | |
c3fc2621 | 70 | |
e501603b | 71 | /** |
e6ca0a57 | 72 | * @var bool |
e501603b TO |
73 | */ |
74 | public $is_tagset; | |
c3fc2621 | 75 | |
e501603b | 76 | /** |
e501603b TO |
77 | * @var string |
78 | */ | |
79 | public $used_for; | |
c3fc2621 | 80 | |
e501603b TO |
81 | /** |
82 | * FK to civicrm_contact, who created this tag | |
83 | * | |
e6ca0a57 | 84 | * @var int |
e501603b TO |
85 | */ |
86 | public $created_id; | |
c3fc2621 | 87 | |
d73974ac CW |
88 | /** |
89 | * Hex color value e.g. #ffffff | |
90 | * | |
91 | * @var string | |
92 | */ | |
93 | public $color; | |
c3fc2621 | 94 | |
e501603b TO |
95 | /** |
96 | * Date and time that tag was created. | |
97 | * | |
98 | * @var datetime | |
99 | */ | |
100 | public $created_date; | |
c3fc2621 | 101 | |
e501603b | 102 | /** |
f41f0342 | 103 | * Class constructor. |
e501603b | 104 | */ |
c3fc2621 | 105 | public function __construct() { |
e501603b TO |
106 | $this->__table = 'civicrm_tag'; |
107 | parent::__construct(); | |
108 | } | |
c3fc2621 | 109 | |
e501603b | 110 | /** |
f41f0342 | 111 | * Returns foreign keys and entity references. |
e501603b TO |
112 | * |
113 | * @return array | |
114 | * [CRM_Core_Reference_Interface] | |
115 | */ | |
c3fc2621 | 116 | public static function getReferenceColumns() { |
346aaaba | 117 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 118 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
119 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'parent_id', 'civicrm_tag', 'id'); |
120 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_id', 'civicrm_contact', 'id'); | |
346aaaba | 121 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 122 | } |
346aaaba | 123 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 124 | } |
c3fc2621 | 125 | |
e501603b TO |
126 | /** |
127 | * Returns all the column names of this table | |
128 | * | |
129 | * @return array | |
130 | */ | |
c3fc2621 | 131 | public static function &fields() { |
346aaaba | 132 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
133 | Civi::$statics[__CLASS__]['fields'] = [ |
134 | 'id' => [ | |
e501603b TO |
135 | 'name' => 'id', |
136 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 137 | 'title' => ts('Tag ID'), |
215b423e | 138 | 'description' => ts('Tag ID'), |
c3fc2621 | 139 | 'required' => TRUE, |
a36434b9 | 140 | 'where' => 'civicrm_tag.id', |
522a26c9 | 141 | 'table_name' => 'civicrm_tag', |
142 | 'entity' => 'Tag', | |
143 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 144 | 'localizable' => 0, |
c3fc2621 CW |
145 | ], |
146 | 'name' => [ | |
e501603b TO |
147 | 'name' => 'name', |
148 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 149 | 'title' => ts('Tag Name'), |
215b423e | 150 | 'description' => ts('Name of Tag.'), |
c3fc2621 | 151 | 'required' => TRUE, |
e501603b TO |
152 | 'maxlength' => 64, |
153 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 154 | 'where' => 'civicrm_tag.name', |
522a26c9 | 155 | 'table_name' => 'civicrm_tag', |
156 | 'entity' => 'Tag', | |
157 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 158 | 'localizable' => 0, |
c3fc2621 CW |
159 | ], |
160 | 'description' => [ | |
e501603b TO |
161 | 'name' => 'description', |
162 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 163 | 'title' => ts('Description'), |
215b423e | 164 | 'description' => ts('Optional verbose description of the tag.'), |
e501603b TO |
165 | 'maxlength' => 255, |
166 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 167 | 'where' => 'civicrm_tag.description', |
522a26c9 | 168 | 'table_name' => 'civicrm_tag', |
169 | 'entity' => 'Tag', | |
170 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 171 | 'localizable' => 0, |
c3fc2621 CW |
172 | ], |
173 | 'parent_id' => [ | |
e501603b TO |
174 | 'name' => 'parent_id', |
175 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 176 | 'title' => ts('Parent Tag'), |
215b423e | 177 | 'description' => ts('Optional parent id for this tag.'), |
a36434b9 | 178 | 'where' => 'civicrm_tag.parent_id', |
e501603b | 179 | 'default' => 'NULL', |
522a26c9 | 180 | 'table_name' => 'civicrm_tag', |
181 | 'entity' => 'Tag', | |
182 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 183 | 'localizable' => 0, |
e501603b | 184 | 'FKClassName' => 'CRM_Core_DAO_Tag', |
c3fc2621 CW |
185 | ], |
186 | 'is_selectable' => [ | |
e501603b TO |
187 | 'name' => 'is_selectable', |
188 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 189 | 'title' => ts('Display Tag?'), |
215b423e | 190 | 'description' => ts('Is this tag selectable / displayed'), |
a36434b9 | 191 | 'where' => 'civicrm_tag.is_selectable', |
e501603b | 192 | 'default' => '1', |
522a26c9 | 193 | 'table_name' => 'civicrm_tag', |
194 | 'entity' => 'Tag', | |
195 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 196 | 'localizable' => 0, |
c3fc2621 CW |
197 | ], |
198 | 'is_reserved' => [ | |
e501603b TO |
199 | 'name' => 'is_reserved', |
200 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 201 | 'title' => ts('Reserved'), |
a36434b9 | 202 | 'where' => 'civicrm_tag.is_reserved', |
45a83e42 | 203 | 'default' => '0', |
522a26c9 | 204 | 'table_name' => 'civicrm_tag', |
205 | 'entity' => 'Tag', | |
206 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 207 | 'localizable' => 0, |
c3fc2621 CW |
208 | ], |
209 | 'is_tagset' => [ | |
e501603b TO |
210 | 'name' => 'is_tagset', |
211 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 212 | 'title' => ts('Tagset'), |
a36434b9 | 213 | 'where' => 'civicrm_tag.is_tagset', |
45a83e42 | 214 | 'default' => '0', |
522a26c9 | 215 | 'table_name' => 'civicrm_tag', |
216 | 'entity' => 'Tag', | |
217 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 218 | 'localizable' => 0, |
c3fc2621 CW |
219 | ], |
220 | 'used_for' => [ | |
e501603b TO |
221 | 'name' => 'used_for', |
222 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 223 | 'title' => ts('Used For'), |
e501603b TO |
224 | 'maxlength' => 64, |
225 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 226 | 'where' => 'civicrm_tag.used_for', |
e501603b | 227 | 'default' => 'NULL', |
522a26c9 | 228 | 'table_name' => 'civicrm_tag', |
229 | 'entity' => 'Tag', | |
230 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 231 | 'localizable' => 0, |
bc7b7b4a | 232 | 'serialize' => self::SERIALIZE_COMMA, |
c3fc2621 | 233 | 'html' => [ |
e501603b | 234 | 'type' => 'Select', |
c3fc2621 CW |
235 | ], |
236 | 'pseudoconstant' => [ | |
e501603b TO |
237 | 'optionGroupName' => 'tag_used_for', |
238 | 'optionEditPath' => 'civicrm/admin/options/tag_used_for', | |
e6ca0a57 | 239 | ], |
c3fc2621 CW |
240 | ], |
241 | 'created_id' => [ | |
e501603b TO |
242 | 'name' => 'created_id', |
243 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 244 | 'title' => ts('Tag Created By'), |
215b423e | 245 | 'description' => ts('FK to civicrm_contact, who created this tag'), |
a36434b9 | 246 | 'where' => 'civicrm_tag.created_id', |
522a26c9 | 247 | 'table_name' => 'civicrm_tag', |
248 | 'entity' => 'Tag', | |
249 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 250 | 'localizable' => 0, |
e501603b | 251 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
c3fc2621 CW |
252 | ], |
253 | 'color' => [ | |
d73974ac CW |
254 | 'name' => 'color', |
255 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 256 | 'title' => ts('Color'), |
215b423e | 257 | 'description' => ts('Hex color value e.g. #ffffff'), |
d73974ac CW |
258 | 'maxlength' => 255, |
259 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 260 | 'where' => 'civicrm_tag.color', |
d73974ac | 261 | 'default' => 'NULL', |
522a26c9 | 262 | 'table_name' => 'civicrm_tag', |
263 | 'entity' => 'Tag', | |
264 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 265 | 'localizable' => 0, |
c3fc2621 CW |
266 | ], |
267 | 'created_date' => [ | |
e501603b TO |
268 | 'name' => 'created_date', |
269 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, | |
c3fc2621 | 270 | 'title' => ts('Tag Created Date'), |
215b423e | 271 | 'description' => ts('Date and time that tag was created.'), |
a36434b9 | 272 | 'where' => 'civicrm_tag.created_date', |
522a26c9 | 273 | 'table_name' => 'civicrm_tag', |
274 | 'entity' => 'Tag', | |
275 | 'bao' => 'CRM_Core_BAO_Tag', | |
6a7e5e5d | 276 | 'localizable' => 0, |
c3fc2621 CW |
277 | ], |
278 | ]; | |
346aaaba | 279 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 280 | } |
346aaaba | 281 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 282 | } |
c3fc2621 | 283 | |
e501603b | 284 | /** |
bd8e0b14 | 285 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
286 | * |
287 | * @return array | |
bd8e0b14 | 288 | * Array(string $name => string $uniqueName). |
e501603b | 289 | */ |
c3fc2621 | 290 | public static function &fieldKeys() { |
bd8e0b14 TO |
291 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
292 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 293 | } |
bd8e0b14 | 294 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 295 | } |
c3fc2621 | 296 | |
e501603b TO |
297 | /** |
298 | * Returns the names of this table | |
299 | * | |
300 | * @return string | |
301 | */ | |
c3fc2621 | 302 | public static function getTableName() { |
e501603b TO |
303 | return self::$_tableName; |
304 | } | |
c3fc2621 | 305 | |
e501603b TO |
306 | /** |
307 | * Returns if this table needs to be logged | |
308 | * | |
c3fc2621 | 309 | * @return bool |
e501603b | 310 | */ |
c3fc2621 | 311 | public function getLog() { |
e501603b TO |
312 | return self::$_log; |
313 | } | |
c3fc2621 | 314 | |
e501603b TO |
315 | /** |
316 | * Returns the list of fields that can be imported | |
317 | * | |
318 | * @param bool $prefix | |
319 | * | |
320 | * @return array | |
321 | */ | |
c3fc2621 CW |
322 | public static function &import($prefix = FALSE) { |
323 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'tag', $prefix, []); | |
60808919 | 324 | return $r; |
e501603b | 325 | } |
c3fc2621 | 326 | |
e501603b TO |
327 | /** |
328 | * Returns the list of fields that can be exported | |
329 | * | |
330 | * @param bool $prefix | |
331 | * | |
332 | * @return array | |
333 | */ | |
c3fc2621 CW |
334 | public static function &export($prefix = FALSE) { |
335 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'tag', $prefix, []); | |
60808919 | 336 | return $r; |
e501603b | 337 | } |
c3fc2621 | 338 | |
e7a6b91a AS |
339 | /** |
340 | * Returns the list of indices | |
c3fc2621 CW |
341 | * |
342 | * @param bool $localize | |
343 | * | |
344 | * @return array | |
e7a6b91a AS |
345 | */ |
346 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
347 | $indices = [ |
348 | 'UI_name' => [ | |
e7a6b91a | 349 | 'name' => 'UI_name', |
c3fc2621 | 350 | 'field' => [ |
e7a6b91a | 351 | 0 => 'name', |
c3fc2621 CW |
352 | ], |
353 | 'localizable' => FALSE, | |
354 | 'unique' => TRUE, | |
e7a6b91a | 355 | 'sig' => 'civicrm_tag::1::name', |
c3fc2621 CW |
356 | ], |
357 | ]; | |
e7a6b91a AS |
358 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
359 | } | |
c3fc2621 | 360 | |
e501603b | 361 | } |