Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
ca5cec67 | 5 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
e501603b | 6 | * |
28fec8aa | 7 | * Generated from xml/schema/CRM/ACL/ACLCache.xml |
e501603b | 8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen |
7b66c3b5 | 9 | * (GenCodeChecksum:cec3d7c7aced95902840b72829550156) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
28fec8aa | 13 | * Database access object for the ACLCache entity. |
f41f0342 | 14 | */ |
28fec8aa | 15 | class CRM_ACL_DAO_ACLCache 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_cache'; |
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 Contact | |
42 | * | |
e6ca0a57 | 43 | * @var int |
e501603b TO |
44 | */ |
45 | public $contact_id; | |
c3fc2621 | 46 | |
e501603b TO |
47 | /** |
48 | * Foreign Key to ACL | |
49 | * | |
e6ca0a57 | 50 | * @var int |
e501603b TO |
51 | */ |
52 | public $acl_id; | |
c3fc2621 | 53 | |
e501603b TO |
54 | /** |
55 | * When was this cache entry last modified | |
56 | * | |
57 | * @var timestamp | |
58 | */ | |
59 | public $modified_date; | |
c3fc2621 | 60 | |
e501603b | 61 | /** |
f41f0342 | 62 | * Class constructor. |
e501603b | 63 | */ |
c3fc2621 | 64 | public function __construct() { |
e501603b TO |
65 | $this->__table = 'civicrm_acl_cache'; |
66 | parent::__construct(); | |
67 | } | |
c3fc2621 | 68 | |
449c4e6b CW |
69 | /** |
70 | * Returns localized title of this entity. | |
7b66c3b5 AH |
71 | * |
72 | * @param bool $plural | |
73 | * Whether to return the plural version of the title. | |
449c4e6b | 74 | */ |
7b66c3b5 AH |
75 | public static function getEntityTitle($plural = FALSE) { |
76 | return $plural ? ts('ACLCaches') : ts('ACLCache'); | |
449c4e6b CW |
77 | } |
78 | ||
e501603b | 79 | /** |
f41f0342 | 80 | * Returns foreign keys and entity references. |
e501603b TO |
81 | * |
82 | * @return array | |
83 | * [CRM_Core_Reference_Interface] | |
84 | */ | |
c3fc2621 | 85 | public static function getReferenceColumns() { |
346aaaba | 86 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
cf0d1c08 | 87 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
88 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id'); |
89 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'acl_id', 'civicrm_acl', 'id'); | |
346aaaba | 90 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 91 | } |
346aaaba | 92 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 93 | } |
c3fc2621 | 94 | |
e501603b TO |
95 | /** |
96 | * Returns all the column names of this table | |
97 | * | |
98 | * @return array | |
99 | */ | |
c3fc2621 | 100 | public static function &fields() { |
346aaaba | 101 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
102 | Civi::$statics[__CLASS__]['fields'] = [ |
103 | 'id' => [ | |
e501603b TO |
104 | 'name' => 'id', |
105 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 106 | 'title' => ts('Cache ID'), |
215b423e | 107 | 'description' => ts('Unique table ID'), |
c3fc2621 | 108 | 'required' => TRUE, |
a36434b9 | 109 | 'where' => 'civicrm_acl_cache.id', |
522a26c9 | 110 | 'table_name' => 'civicrm_acl_cache', |
28fec8aa PN |
111 | 'entity' => 'ACLCache', |
112 | 'bao' => 'CRM_ACL_DAO_ACLCache', | |
6a7e5e5d | 113 | 'localizable' => 0, |
a9d0587b | 114 | 'add' => '1.6', |
c3fc2621 CW |
115 | ], |
116 | 'contact_id' => [ | |
e501603b TO |
117 | 'name' => 'contact_id', |
118 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 119 | 'title' => ts('Cache Contact'), |
215b423e | 120 | 'description' => ts('Foreign Key to Contact'), |
a36434b9 | 121 | 'where' => 'civicrm_acl_cache.contact_id', |
522a26c9 | 122 | 'table_name' => 'civicrm_acl_cache', |
28fec8aa PN |
123 | 'entity' => 'ACLCache', |
124 | 'bao' => 'CRM_ACL_DAO_ACLCache', | |
6a7e5e5d | 125 | 'localizable' => 0, |
e501603b | 126 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
1906ff52 PN |
127 | 'html' => [ |
128 | 'type' => 'EntityRef', | |
129 | ], | |
a9d0587b | 130 | 'add' => '1.6', |
c3fc2621 CW |
131 | ], |
132 | 'acl_id' => [ | |
e501603b TO |
133 | 'name' => 'acl_id', |
134 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 135 | 'title' => ts('Cache ACL'), |
215b423e | 136 | 'description' => ts('Foreign Key to ACL'), |
c3fc2621 | 137 | 'required' => TRUE, |
a36434b9 | 138 | 'where' => 'civicrm_acl_cache.acl_id', |
522a26c9 | 139 | 'table_name' => 'civicrm_acl_cache', |
28fec8aa PN |
140 | 'entity' => 'ACLCache', |
141 | 'bao' => 'CRM_ACL_DAO_ACLCache', | |
6a7e5e5d | 142 | 'localizable' => 0, |
e501603b | 143 | 'FKClassName' => 'CRM_ACL_DAO_ACL', |
1906ff52 PN |
144 | 'pseudoconstant' => [ |
145 | 'table' => 'civicrm_acl', | |
146 | 'keyColumn' => 'id', | |
147 | 'labelColumn' => 'name', | |
148 | ], | |
a9d0587b | 149 | 'add' => '1.6', |
c3fc2621 CW |
150 | ], |
151 | 'modified_date' => [ | |
e501603b TO |
152 | 'name' => 'modified_date', |
153 | 'type' => CRM_Utils_Type::T_TIMESTAMP, | |
c3fc2621 | 154 | 'title' => ts('Cache Modified Date'), |
215b423e | 155 | 'description' => ts('When was this cache entry last modified'), |
c3fc2621 | 156 | 'required' => FALSE, |
a36434b9 | 157 | 'where' => 'civicrm_acl_cache.modified_date', |
522a26c9 | 158 | 'table_name' => 'civicrm_acl_cache', |
28fec8aa PN |
159 | 'entity' => 'ACLCache', |
160 | 'bao' => 'CRM_ACL_DAO_ACLCache', | |
6a7e5e5d | 161 | 'localizable' => 0, |
a9d0587b | 162 | 'add' => '1.6', |
c3fc2621 CW |
163 | ], |
164 | ]; | |
346aaaba | 165 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 166 | } |
346aaaba | 167 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 168 | } |
c3fc2621 | 169 | |
e501603b | 170 | /** |
bd8e0b14 | 171 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
172 | * |
173 | * @return array | |
bd8e0b14 | 174 | * Array(string $name => string $uniqueName). |
e501603b | 175 | */ |
c3fc2621 | 176 | public static function &fieldKeys() { |
bd8e0b14 TO |
177 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
178 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 179 | } |
bd8e0b14 | 180 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 181 | } |
c3fc2621 | 182 | |
e501603b TO |
183 | /** |
184 | * Returns the names of this table | |
185 | * | |
186 | * @return string | |
187 | */ | |
c3fc2621 | 188 | public static function getTableName() { |
e501603b TO |
189 | return self::$_tableName; |
190 | } | |
c3fc2621 | 191 | |
e501603b TO |
192 | /** |
193 | * Returns if this table needs to be logged | |
194 | * | |
c3fc2621 | 195 | * @return bool |
e501603b | 196 | */ |
c3fc2621 | 197 | public function getLog() { |
e501603b TO |
198 | return self::$_log; |
199 | } | |
c3fc2621 | 200 | |
e501603b TO |
201 | /** |
202 | * Returns the list of fields that can be imported | |
203 | * | |
204 | * @param bool $prefix | |
205 | * | |
206 | * @return array | |
207 | */ | |
c3fc2621 CW |
208 | public static function &import($prefix = FALSE) { |
209 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_cache', $prefix, []); | |
60808919 | 210 | return $r; |
e501603b | 211 | } |
c3fc2621 | 212 | |
e501603b TO |
213 | /** |
214 | * Returns the list of fields that can be exported | |
215 | * | |
216 | * @param bool $prefix | |
217 | * | |
218 | * @return array | |
219 | */ | |
c3fc2621 CW |
220 | public static function &export($prefix = FALSE) { |
221 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_cache', $prefix, []); | |
60808919 | 222 | return $r; |
e501603b | 223 | } |
c3fc2621 | 224 | |
e7a6b91a AS |
225 | /** |
226 | * Returns the list of indices | |
c3fc2621 CW |
227 | * |
228 | * @param bool $localize | |
229 | * | |
230 | * @return array | |
e7a6b91a AS |
231 | */ |
232 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
233 | $indices = [ |
234 | 'index_acl_id' => [ | |
e7a6b91a | 235 | 'name' => 'index_acl_id', |
c3fc2621 | 236 | 'field' => [ |
e7a6b91a | 237 | 0 => 'acl_id', |
c3fc2621 CW |
238 | ], |
239 | 'localizable' => FALSE, | |
e7a6b91a | 240 | 'sig' => 'civicrm_acl_cache::0::acl_id', |
c3fc2621 | 241 | ], |
1ec2637a | 242 | 'index_modified_date' => [ |
243 | 'name' => 'index_modified_date', | |
244 | 'field' => [ | |
245 | 0 => 'modified_date', | |
246 | ], | |
247 | 'localizable' => FALSE, | |
248 | 'sig' => 'civicrm_acl_cache::0::modified_date', | |
249 | ], | |
c3fc2621 | 250 | ]; |
e7a6b91a AS |
251 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
252 | } | |
c3fc2621 | 253 | |
e501603b | 254 | } |