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/Contact/ACLContactCache.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
7b66c3b5 | 9 | * (GenCodeChecksum:ff86d1eed99d09ea6768d93b3cc39973) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the ACLContactCache entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Contact_DAO_ACLContactCache extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '3.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_acl_contact_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 | * primary key | |
35 | * | |
e6ca0a57 | 36 | * @var int |
e501603b TO |
37 | */ |
38 | public $id; | |
c3fc2621 | 39 | |
e501603b TO |
40 | /** |
41 | * FK to civicrm_contact (could be null for anon user) | |
42 | * | |
e6ca0a57 | 43 | * @var int |
e501603b TO |
44 | */ |
45 | public $user_id; | |
c3fc2621 | 46 | |
e501603b TO |
47 | /** |
48 | * FK to civicrm_contact | |
49 | * | |
e6ca0a57 | 50 | * @var int |
e501603b TO |
51 | */ |
52 | public $contact_id; | |
c3fc2621 | 53 | |
e501603b TO |
54 | /** |
55 | * What operation does this user have permission on? | |
56 | * | |
57 | * @var string | |
58 | */ | |
59 | public $operation; | |
c3fc2621 | 60 | |
e501603b | 61 | /** |
f41f0342 | 62 | * Class constructor. |
e501603b | 63 | */ |
c3fc2621 | 64 | public function __construct() { |
e501603b TO |
65 | $this->__table = 'civicrm_acl_contact_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('ACLContact Caches') : ts('ACLContact Cache'); | |
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'])) { |
fa45b5b9 | 87 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 | 88 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id'); |
346aaaba | 89 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 90 | } |
346aaaba | 91 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 92 | } |
c3fc2621 | 93 | |
e501603b TO |
94 | /** |
95 | * Returns all the column names of this table | |
96 | * | |
97 | * @return array | |
98 | */ | |
c3fc2621 | 99 | public static function &fields() { |
346aaaba | 100 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
101 | Civi::$statics[__CLASS__]['fields'] = [ |
102 | 'id' => [ | |
e501603b TO |
103 | 'name' => 'id', |
104 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 105 | 'title' => ts('ACL Contact Cache ID'), |
215b423e | 106 | 'description' => ts('primary key'), |
c3fc2621 | 107 | 'required' => TRUE, |
a36434b9 | 108 | 'where' => 'civicrm_acl_contact_cache.id', |
522a26c9 | 109 | 'table_name' => 'civicrm_acl_contact_cache', |
110 | 'entity' => 'ACLContactCache', | |
111 | 'bao' => 'CRM_Contact_DAO_ACLContactCache', | |
6a7e5e5d | 112 | 'localizable' => 0, |
a9d0587b | 113 | 'add' => '3.1', |
c3fc2621 CW |
114 | ], |
115 | 'user_id' => [ | |
e501603b TO |
116 | 'name' => 'user_id', |
117 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 118 | 'title' => ts('Contact ID'), |
215b423e | 119 | 'description' => ts('FK to civicrm_contact (could be null for anon user)'), |
a36434b9 | 120 | 'where' => 'civicrm_acl_contact_cache.user_id', |
522a26c9 | 121 | 'table_name' => 'civicrm_acl_contact_cache', |
122 | 'entity' => 'ACLContactCache', | |
123 | 'bao' => 'CRM_Contact_DAO_ACLContactCache', | |
6a7e5e5d | 124 | 'localizable' => 0, |
a9d0587b | 125 | 'add' => '3.1', |
c3fc2621 CW |
126 | ], |
127 | 'contact_id' => [ | |
e501603b TO |
128 | 'name' => 'contact_id', |
129 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 130 | 'title' => ts('Contact ID'), |
215b423e | 131 | 'description' => ts('FK to civicrm_contact'), |
c3fc2621 | 132 | 'required' => TRUE, |
a36434b9 | 133 | 'where' => 'civicrm_acl_contact_cache.contact_id', |
522a26c9 | 134 | 'table_name' => 'civicrm_acl_contact_cache', |
135 | 'entity' => 'ACLContactCache', | |
136 | 'bao' => 'CRM_Contact_DAO_ACLContactCache', | |
6a7e5e5d | 137 | 'localizable' => 0, |
e501603b | 138 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
a9d0587b | 139 | 'add' => '3.1', |
c3fc2621 CW |
140 | ], |
141 | 'operation' => [ | |
e501603b TO |
142 | 'name' => 'operation', |
143 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 144 | 'title' => ts('Operation'), |
215b423e | 145 | 'description' => ts('What operation does this user have permission on?'), |
c3fc2621 | 146 | 'required' => TRUE, |
e501603b TO |
147 | 'maxlength' => 8, |
148 | 'size' => CRM_Utils_Type::EIGHT, | |
a36434b9 | 149 | 'where' => 'civicrm_acl_contact_cache.operation', |
522a26c9 | 150 | 'table_name' => 'civicrm_acl_contact_cache', |
151 | 'entity' => 'ACLContactCache', | |
152 | 'bao' => 'CRM_Contact_DAO_ACLContactCache', | |
6a7e5e5d | 153 | 'localizable' => 0, |
c3fc2621 | 154 | 'html' => [ |
e501603b | 155 | 'type' => 'Select', |
c3fc2621 CW |
156 | ], |
157 | 'pseudoconstant' => [ | |
e501603b | 158 | 'callback' => 'CRM_ACL_BAO_ACL::operation', |
e6ca0a57 | 159 | ], |
a9d0587b | 160 | 'add' => '1.6', |
c3fc2621 CW |
161 | ], |
162 | ]; | |
346aaaba | 163 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 164 | } |
346aaaba | 165 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 166 | } |
c3fc2621 | 167 | |
e501603b | 168 | /** |
bd8e0b14 | 169 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
170 | * |
171 | * @return array | |
bd8e0b14 | 172 | * Array(string $name => string $uniqueName). |
e501603b | 173 | */ |
c3fc2621 | 174 | public static function &fieldKeys() { |
bd8e0b14 TO |
175 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
176 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 177 | } |
bd8e0b14 | 178 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 179 | } |
c3fc2621 | 180 | |
e501603b TO |
181 | /** |
182 | * Returns the names of this table | |
183 | * | |
184 | * @return string | |
185 | */ | |
c3fc2621 | 186 | public static function getTableName() { |
e501603b TO |
187 | return self::$_tableName; |
188 | } | |
c3fc2621 | 189 | |
e501603b TO |
190 | /** |
191 | * Returns if this table needs to be logged | |
192 | * | |
c3fc2621 | 193 | * @return bool |
e501603b | 194 | */ |
c3fc2621 | 195 | public function getLog() { |
e501603b TO |
196 | return self::$_log; |
197 | } | |
c3fc2621 | 198 | |
e501603b TO |
199 | /** |
200 | * Returns the list of fields that can be imported | |
201 | * | |
202 | * @param bool $prefix | |
203 | * | |
204 | * @return array | |
205 | */ | |
c3fc2621 CW |
206 | public static function &import($prefix = FALSE) { |
207 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_contact_cache', $prefix, []); | |
60808919 | 208 | return $r; |
e501603b | 209 | } |
c3fc2621 | 210 | |
e501603b TO |
211 | /** |
212 | * Returns the list of fields that can be exported | |
213 | * | |
214 | * @param bool $prefix | |
215 | * | |
216 | * @return array | |
217 | */ | |
c3fc2621 CW |
218 | public static function &export($prefix = FALSE) { |
219 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_contact_cache', $prefix, []); | |
60808919 | 220 | return $r; |
e501603b | 221 | } |
c3fc2621 | 222 | |
e7a6b91a AS |
223 | /** |
224 | * Returns the list of indices | |
c3fc2621 CW |
225 | * |
226 | * @param bool $localize | |
227 | * | |
228 | * @return array | |
e7a6b91a AS |
229 | */ |
230 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
231 | $indices = [ |
232 | 'UI_user_contact_operation' => [ | |
e7a6b91a | 233 | 'name' => 'UI_user_contact_operation', |
c3fc2621 | 234 | 'field' => [ |
e7a6b91a AS |
235 | 0 => 'user_id', |
236 | 1 => 'contact_id', | |
237 | 2 => 'operation', | |
c3fc2621 CW |
238 | ], |
239 | 'localizable' => FALSE, | |
240 | 'unique' => TRUE, | |
e7a6b91a | 241 | 'sig' => 'civicrm_acl_contact_cache::1::user_id::contact_id::operation', |
c3fc2621 CW |
242 | ], |
243 | ]; | |
e7a6b91a AS |
244 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
245 | } | |
c3fc2621 | 246 | |
e501603b | 247 | } |