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