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/Batch/EntityBatch.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
8ab43c93 | 9 | * (GenCodeChecksum:9d04febc575fa821cc186aecfbce8965) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the EntityBatch entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Batch_DAO_EntityBatch extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '3.3'; | |
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_batch'; |
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 | * physical tablename for entity being joined to file, e.g. civicrm_contact | |
42 | * | |
43 | * @var string | |
44 | */ | |
45 | public $entity_table; | |
c3fc2621 | 46 | |
e501603b TO |
47 | /** |
48 | * FK to entity table specified in entity_table column. | |
49 | * | |
e6ca0a57 | 50 | * @var int |
e501603b TO |
51 | */ |
52 | public $entity_id; | |
c3fc2621 | 53 | |
e501603b TO |
54 | /** |
55 | * FK to civicrm_batch | |
56 | * | |
e6ca0a57 | 57 | * @var int |
e501603b TO |
58 | */ |
59 | public $batch_id; | |
c3fc2621 | 60 | |
e501603b | 61 | /** |
f41f0342 | 62 | * Class constructor. |
e501603b | 63 | */ |
c3fc2621 | 64 | public function __construct() { |
e501603b TO |
65 | $this->__table = 'civicrm_entity_batch'; |
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('Entity Batches') : ts('Entity Batch'); | |
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 CW |
88 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'batch_id', 'civicrm_batch', 'id'); |
89 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table'); | |
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('EntityBatch ID'), |
215b423e | 107 | 'description' => ts('primary key'), |
c3fc2621 | 108 | 'required' => TRUE, |
a36434b9 | 109 | 'where' => 'civicrm_entity_batch.id', |
522a26c9 | 110 | 'table_name' => 'civicrm_entity_batch', |
111 | 'entity' => 'EntityBatch', | |
112 | 'bao' => 'CRM_Batch_BAO_EntityBatch', | |
6a7e5e5d | 113 | 'localizable' => 0, |
a9d0587b | 114 | 'add' => '3.3', |
c3fc2621 CW |
115 | ], |
116 | 'entity_table' => [ | |
e501603b TO |
117 | 'name' => 'entity_table', |
118 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 119 | 'title' => ts('EntityBatch Table'), |
215b423e | 120 | 'description' => ts('physical tablename for entity being joined to file, e.g. civicrm_contact'), |
e501603b TO |
121 | 'maxlength' => 64, |
122 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 123 | 'where' => 'civicrm_entity_batch.entity_table', |
522a26c9 | 124 | 'table_name' => 'civicrm_entity_batch', |
125 | 'entity' => 'EntityBatch', | |
126 | 'bao' => 'CRM_Batch_BAO_EntityBatch', | |
6a7e5e5d | 127 | 'localizable' => 0, |
a9d0587b | 128 | 'add' => '3.3', |
c3fc2621 CW |
129 | ], |
130 | 'entity_id' => [ | |
e501603b TO |
131 | 'name' => 'entity_id', |
132 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 133 | 'title' => ts('Entity ID'), |
215b423e | 134 | 'description' => ts('FK to entity table specified in entity_table column.'), |
c3fc2621 | 135 | 'required' => TRUE, |
a36434b9 | 136 | 'where' => 'civicrm_entity_batch.entity_id', |
522a26c9 | 137 | 'table_name' => 'civicrm_entity_batch', |
138 | 'entity' => 'EntityBatch', | |
139 | 'bao' => 'CRM_Batch_BAO_EntityBatch', | |
6a7e5e5d | 140 | 'localizable' => 0, |
a9d0587b | 141 | 'add' => '3.3', |
c3fc2621 CW |
142 | ], |
143 | 'batch_id' => [ | |
e501603b TO |
144 | 'name' => 'batch_id', |
145 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 146 | 'title' => ts('Batch ID'), |
215b423e | 147 | 'description' => ts('FK to civicrm_batch'), |
c3fc2621 | 148 | 'required' => TRUE, |
a36434b9 | 149 | 'where' => 'civicrm_entity_batch.batch_id', |
522a26c9 | 150 | 'table_name' => 'civicrm_entity_batch', |
151 | 'entity' => 'EntityBatch', | |
152 | 'bao' => 'CRM_Batch_BAO_EntityBatch', | |
6a7e5e5d | 153 | 'localizable' => 0, |
e501603b | 154 | 'FKClassName' => 'CRM_Batch_DAO_Batch', |
c3fc2621 | 155 | 'pseudoconstant' => [ |
c76af7c4 E |
156 | 'table' => 'civicrm_batch', |
157 | 'keyColumn' => 'id', | |
158 | 'labelColumn' => 'title', | |
e6ca0a57 | 159 | ], |
a9d0587b | 160 | 'add' => '3.3', |
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__, 'entity_batch', $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__, 'entity_batch', $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 | 'index_entity' => [ | |
e7a6b91a | 233 | 'name' => 'index_entity', |
c3fc2621 | 234 | 'field' => [ |
e7a6b91a AS |
235 | 0 => 'entity_table', |
236 | 1 => 'entity_id', | |
c3fc2621 CW |
237 | ], |
238 | 'localizable' => FALSE, | |
e7a6b91a | 239 | 'sig' => 'civicrm_entity_batch::0::entity_table::entity_id', |
c3fc2621 CW |
240 | ], |
241 | 'UI_batch_entity' => [ | |
e7a6b91a | 242 | 'name' => 'UI_batch_entity', |
c3fc2621 | 243 | 'field' => [ |
e7a6b91a AS |
244 | 0 => 'batch_id', |
245 | 1 => 'entity_id', | |
246 | 2 => 'entity_table', | |
c3fc2621 CW |
247 | ], |
248 | 'localizable' => FALSE, | |
249 | 'unique' => TRUE, | |
e7a6b91a | 250 | 'sig' => 'civicrm_entity_batch::1::batch_id::entity_id::entity_table', |
c3fc2621 CW |
251 | ], |
252 | ]; | |
e7a6b91a AS |
253 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
254 | } | |
c3fc2621 | 255 | |
e501603b | 256 | } |