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/EntityTag.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
28979d65 | 9 | * (GenCodeChecksum:cabc3d8a72fecadc4d531226b1db4c1d) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the EntityTag entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_EntityTag 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_entity_tag'; |
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 = TRUE; |
c3fc2621 | 32 | |
e501603b TO |
33 | /** |
34 | * primary key | |
35 | * | |
28979d65 CW |
36 | * @var int|string|null |
37 | * (SQL type: int unsigned) | |
38 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
39 | */ |
40 | public $id; | |
c3fc2621 | 41 | |
e501603b TO |
42 | /** |
43 | * physical tablename for entity being joined to file, e.g. civicrm_contact | |
44 | * | |
28979d65 CW |
45 | * @var string|null |
46 | * (SQL type: varchar(64)) | |
47 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
48 | */ |
49 | public $entity_table; | |
c3fc2621 | 50 | |
e501603b TO |
51 | /** |
52 | * FK to entity table specified in entity_table column. | |
53 | * | |
28979d65 CW |
54 | * @var int|string |
55 | * (SQL type: int unsigned) | |
56 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
57 | */ |
58 | public $entity_id; | |
c3fc2621 | 59 | |
e501603b TO |
60 | /** |
61 | * FK to civicrm_tag | |
62 | * | |
28979d65 CW |
63 | * @var int|string |
64 | * (SQL type: int unsigned) | |
65 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
66 | */ |
67 | public $tag_id; | |
c3fc2621 | 68 | |
e501603b | 69 | /** |
f41f0342 | 70 | * Class constructor. |
e501603b | 71 | */ |
c3fc2621 | 72 | public function __construct() { |
e501603b TO |
73 | $this->__table = 'civicrm_entity_tag'; |
74 | parent::__construct(); | |
75 | } | |
c3fc2621 | 76 | |
449c4e6b CW |
77 | /** |
78 | * Returns localized title of this entity. | |
7b66c3b5 AH |
79 | * |
80 | * @param bool $plural | |
81 | * Whether to return the plural version of the title. | |
449c4e6b | 82 | */ |
7b66c3b5 AH |
83 | public static function getEntityTitle($plural = FALSE) { |
84 | return $plural ? ts('Entity Tags') : ts('Entity Tag'); | |
449c4e6b CW |
85 | } |
86 | ||
e501603b | 87 | /** |
f41f0342 | 88 | * Returns foreign keys and entity references. |
e501603b TO |
89 | * |
90 | * @return array | |
91 | * [CRM_Core_Reference_Interface] | |
92 | */ | |
c3fc2621 | 93 | public static function getReferenceColumns() { |
346aaaba | 94 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 95 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
96 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'tag_id', 'civicrm_tag', 'id'); |
97 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table'); | |
346aaaba | 98 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 99 | } |
346aaaba | 100 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 101 | } |
c3fc2621 | 102 | |
e501603b TO |
103 | /** |
104 | * Returns all the column names of this table | |
105 | * | |
106 | * @return array | |
107 | */ | |
c3fc2621 | 108 | public static function &fields() { |
346aaaba | 109 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
110 | Civi::$statics[__CLASS__]['fields'] = [ |
111 | 'id' => [ | |
e501603b TO |
112 | 'name' => 'id', |
113 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 114 | 'title' => ts('Entity Tag ID'), |
215b423e | 115 | 'description' => ts('primary key'), |
c3fc2621 | 116 | 'required' => TRUE, |
a36434b9 | 117 | 'where' => 'civicrm_entity_tag.id', |
522a26c9 | 118 | 'table_name' => 'civicrm_entity_tag', |
119 | 'entity' => 'EntityTag', | |
120 | 'bao' => 'CRM_Core_BAO_EntityTag', | |
6a7e5e5d | 121 | 'localizable' => 0, |
2cbbebe8 A |
122 | 'html' => [ |
123 | 'type' => 'Number', | |
124 | ], | |
1fe423d6 | 125 | 'readonly' => TRUE, |
a9d0587b | 126 | 'add' => '1.1', |
c3fc2621 CW |
127 | ], |
128 | 'entity_table' => [ | |
e501603b TO |
129 | 'name' => 'entity_table', |
130 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 131 | 'title' => ts('Entity Table'), |
215b423e | 132 | 'description' => ts('physical tablename for entity being joined to file, e.g. civicrm_contact'), |
e501603b TO |
133 | 'maxlength' => 64, |
134 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 135 | 'where' => 'civicrm_entity_tag.entity_table', |
522a26c9 | 136 | 'table_name' => 'civicrm_entity_tag', |
137 | 'entity' => 'EntityTag', | |
138 | 'bao' => 'CRM_Core_BAO_EntityTag', | |
6a7e5e5d | 139 | 'localizable' => 0, |
c3fc2621 | 140 | 'pseudoconstant' => [ |
e501603b TO |
141 | 'optionGroupName' => 'tag_used_for', |
142 | 'optionEditPath' => 'civicrm/admin/options/tag_used_for', | |
e6ca0a57 | 143 | ], |
a9d0587b | 144 | 'add' => '3.2', |
c3fc2621 CW |
145 | ], |
146 | 'entity_id' => [ | |
e501603b TO |
147 | 'name' => 'entity_id', |
148 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 149 | 'title' => ts('Entity ID'), |
215b423e | 150 | 'description' => ts('FK to entity table specified in entity_table column.'), |
c3fc2621 | 151 | 'required' => TRUE, |
a36434b9 | 152 | 'where' => 'civicrm_entity_tag.entity_id', |
522a26c9 | 153 | 'table_name' => 'civicrm_entity_tag', |
154 | 'entity' => 'EntityTag', | |
155 | 'bao' => 'CRM_Core_BAO_EntityTag', | |
6a7e5e5d | 156 | 'localizable' => 0, |
a9d0587b | 157 | 'add' => '3.2', |
c3fc2621 CW |
158 | ], |
159 | 'tag_id' => [ | |
e501603b TO |
160 | 'name' => 'tag_id', |
161 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 162 | 'title' => ts('Tag ID'), |
215b423e | 163 | 'description' => ts('FK to civicrm_tag'), |
c3fc2621 | 164 | 'required' => TRUE, |
a36434b9 | 165 | 'where' => 'civicrm_entity_tag.tag_id', |
522a26c9 | 166 | 'table_name' => 'civicrm_entity_tag', |
167 | 'entity' => 'EntityTag', | |
168 | 'bao' => 'CRM_Core_BAO_EntityTag', | |
6a7e5e5d | 169 | 'localizable' => 0, |
e501603b | 170 | 'FKClassName' => 'CRM_Core_DAO_Tag', |
c3fc2621 | 171 | 'html' => [ |
e501603b | 172 | 'type' => 'Select', |
2cbbebe8 | 173 | 'label' => ts("Tag"), |
c3fc2621 CW |
174 | ], |
175 | 'pseudoconstant' => [ | |
e501603b TO |
176 | 'table' => 'civicrm_tag', |
177 | 'keyColumn' => 'id', | |
178 | 'labelColumn' => 'name', | |
a6d0f90f | 179 | 'condition' => 'is_tagset != 1', |
e6ca0a57 | 180 | ], |
a9d0587b | 181 | 'add' => '1.1', |
c3fc2621 CW |
182 | ], |
183 | ]; | |
346aaaba | 184 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 185 | } |
346aaaba | 186 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 187 | } |
c3fc2621 | 188 | |
e501603b | 189 | /** |
bd8e0b14 | 190 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
191 | * |
192 | * @return array | |
bd8e0b14 | 193 | * Array(string $name => string $uniqueName). |
e501603b | 194 | */ |
c3fc2621 | 195 | public static function &fieldKeys() { |
bd8e0b14 TO |
196 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
197 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 198 | } |
bd8e0b14 | 199 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 200 | } |
c3fc2621 | 201 | |
e501603b TO |
202 | /** |
203 | * Returns the names of this table | |
204 | * | |
205 | * @return string | |
206 | */ | |
c3fc2621 | 207 | public static function getTableName() { |
e501603b TO |
208 | return self::$_tableName; |
209 | } | |
c3fc2621 | 210 | |
e501603b TO |
211 | /** |
212 | * Returns if this table needs to be logged | |
213 | * | |
c3fc2621 | 214 | * @return bool |
e501603b | 215 | */ |
c3fc2621 | 216 | public function getLog() { |
e501603b TO |
217 | return self::$_log; |
218 | } | |
c3fc2621 | 219 | |
e501603b TO |
220 | /** |
221 | * Returns the list of fields that can be imported | |
222 | * | |
223 | * @param bool $prefix | |
224 | * | |
225 | * @return array | |
226 | */ | |
c3fc2621 CW |
227 | public static function &import($prefix = FALSE) { |
228 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_tag', $prefix, []); | |
60808919 | 229 | return $r; |
e501603b | 230 | } |
c3fc2621 | 231 | |
e501603b TO |
232 | /** |
233 | * Returns the list of fields that can be exported | |
234 | * | |
235 | * @param bool $prefix | |
236 | * | |
237 | * @return array | |
238 | */ | |
c3fc2621 CW |
239 | public static function &export($prefix = FALSE) { |
240 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_tag', $prefix, []); | |
60808919 | 241 | return $r; |
e501603b | 242 | } |
c3fc2621 | 243 | |
e7a6b91a AS |
244 | /** |
245 | * Returns the list of indices | |
c3fc2621 CW |
246 | * |
247 | * @param bool $localize | |
248 | * | |
249 | * @return array | |
e7a6b91a AS |
250 | */ |
251 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
252 | $indices = [ |
253 | 'UI_entity_id_entity_table_tag_id' => [ | |
e7a6b91a | 254 | 'name' => 'UI_entity_id_entity_table_tag_id', |
c3fc2621 | 255 | 'field' => [ |
e7a6b91a AS |
256 | 0 => 'entity_id', |
257 | 1 => 'entity_table', | |
258 | 2 => 'tag_id', | |
c3fc2621 CW |
259 | ], |
260 | 'localizable' => FALSE, | |
261 | 'unique' => TRUE, | |
e7a6b91a | 262 | 'sig' => 'civicrm_entity_tag::1::entity_id::entity_table::tag_id', |
c3fc2621 CW |
263 | ], |
264 | ]; | |
e7a6b91a AS |
265 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
266 | } | |
c3fc2621 | 267 | |
e501603b | 268 | } |