Commit | Line | Data |
---|---|---|
e501603b TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2016 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | /** | |
28 | * @package CRM | |
29 | * @copyright CiviCRM LLC (c) 2004-2016 | |
30 | * | |
31 | * Generated from xml/schema/CRM/Batch/EntityBatch.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
33 | * (GenCodeChecksum:3532122d86ee946a7af9cc381ee81ea2) | |
34 | */ | |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
37 | class CRM_Batch_DAO_EntityBatch extends CRM_Core_DAO { | |
38 | /** | |
39 | * static instance to hold the table name | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | static $_tableName = 'civicrm_entity_batch'; | |
44 | /** | |
45 | * static instance to hold the field values | |
46 | * | |
47 | * @var array | |
48 | */ | |
49 | static $_fields = null; | |
50 | /** | |
51 | * static instance to hold the keys used in $_fields for each field. | |
52 | * | |
53 | * @var array | |
54 | */ | |
55 | static $_fieldKeys = null; | |
56 | /** | |
57 | * static instance to hold the FK relationships | |
58 | * | |
59 | * @var string | |
60 | */ | |
61 | static $_links = null; | |
62 | /** | |
63 | * static instance to hold the values that can | |
64 | * be imported | |
65 | * | |
66 | * @var array | |
67 | */ | |
68 | static $_import = null; | |
69 | /** | |
70 | * static instance to hold the values that can | |
71 | * be exported | |
72 | * | |
73 | * @var array | |
74 | */ | |
75 | static $_export = null; | |
76 | /** | |
77 | * static value to see if we should log any modifications to | |
78 | * this table in the civicrm_log table | |
79 | * | |
80 | * @var boolean | |
81 | */ | |
82 | static $_log = false; | |
83 | /** | |
84 | * primary key | |
85 | * | |
86 | * @var int unsigned | |
87 | */ | |
88 | public $id; | |
89 | /** | |
90 | * physical tablename for entity being joined to file, e.g. civicrm_contact | |
91 | * | |
92 | * @var string | |
93 | */ | |
94 | public $entity_table; | |
95 | /** | |
96 | * FK to entity table specified in entity_table column. | |
97 | * | |
98 | * @var int unsigned | |
99 | */ | |
100 | public $entity_id; | |
101 | /** | |
102 | * FK to civicrm_batch | |
103 | * | |
104 | * @var int unsigned | |
105 | */ | |
106 | public $batch_id; | |
107 | /** | |
108 | * class constructor | |
109 | * | |
110 | * @return civicrm_entity_batch | |
111 | */ | |
112 | function __construct() { | |
113 | $this->__table = 'civicrm_entity_batch'; | |
114 | parent::__construct(); | |
115 | } | |
116 | /** | |
117 | * Returns foreign keys and entity references | |
118 | * | |
119 | * @return array | |
120 | * [CRM_Core_Reference_Interface] | |
121 | */ | |
122 | static function getReferenceColumns() { | |
123 | if (!self::$_links) { | |
124 | self::$_links = static ::createReferenceColumns(__CLASS__); | |
125 | self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'batch_id', 'civicrm_batch', 'id'); | |
126 | self::$_links[] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table'); | |
127 | } | |
128 | return self::$_links; | |
129 | } | |
130 | /** | |
131 | * Returns all the column names of this table | |
132 | * | |
133 | * @return array | |
134 | */ | |
135 | static function &fields() { | |
136 | if (!(self::$_fields)) { | |
137 | self::$_fields = array( | |
138 | 'id' => array( | |
139 | 'name' => 'id', | |
140 | 'type' => CRM_Utils_Type::T_INT, | |
141 | 'title' => ts('EntityBatch ID') , | |
142 | 'description' => 'primary key', | |
143 | 'required' => true, | |
144 | ) , | |
145 | 'entity_table' => array( | |
146 | 'name' => 'entity_table', | |
147 | 'type' => CRM_Utils_Type::T_STRING, | |
148 | 'title' => ts('EntityBatch Table') , | |
149 | 'description' => 'physical tablename for entity being joined to file, e.g. civicrm_contact', | |
150 | 'maxlength' => 64, | |
151 | 'size' => CRM_Utils_Type::BIG, | |
152 | ) , | |
153 | 'entity_id' => array( | |
154 | 'name' => 'entity_id', | |
155 | 'type' => CRM_Utils_Type::T_INT, | |
156 | 'title' => ts('Entity ID') , | |
157 | 'description' => 'FK to entity table specified in entity_table column.', | |
158 | 'required' => true, | |
159 | ) , | |
160 | 'batch_id' => array( | |
161 | 'name' => 'batch_id', | |
162 | 'type' => CRM_Utils_Type::T_INT, | |
163 | 'title' => ts('Batch ID') , | |
164 | 'description' => 'FK to civicrm_batch', | |
165 | 'required' => true, | |
166 | 'FKClassName' => 'CRM_Batch_DAO_Batch', | |
167 | ) , | |
168 | ); | |
169 | } | |
170 | return self::$_fields; | |
171 | } | |
172 | /** | |
173 | * Returns an array containing, for each field, the arary key used for that | |
174 | * field in self::$_fields. | |
175 | * | |
176 | * @return array | |
177 | */ | |
178 | static function &fieldKeys() { | |
179 | if (!(self::$_fieldKeys)) { | |
180 | self::$_fieldKeys = array( | |
181 | 'id' => 'id', | |
182 | 'entity_table' => 'entity_table', | |
183 | 'entity_id' => 'entity_id', | |
184 | 'batch_id' => 'batch_id', | |
185 | ); | |
186 | } | |
187 | return self::$_fieldKeys; | |
188 | } | |
189 | /** | |
190 | * Returns the names of this table | |
191 | * | |
192 | * @return string | |
193 | */ | |
194 | static function getTableName() { | |
195 | return self::$_tableName; | |
196 | } | |
197 | /** | |
198 | * Returns if this table needs to be logged | |
199 | * | |
200 | * @return boolean | |
201 | */ | |
202 | function getLog() { | |
203 | return self::$_log; | |
204 | } | |
205 | /** | |
206 | * Returns the list of fields that can be imported | |
207 | * | |
208 | * @param bool $prefix | |
209 | * | |
210 | * @return array | |
211 | */ | |
212 | static function &import($prefix = false) { | |
213 | if (!(self::$_import)) { | |
214 | self::$_import = array(); | |
215 | $fields = self::fields(); | |
216 | foreach($fields as $name => $field) { | |
217 | if (CRM_Utils_Array::value('import', $field)) { | |
218 | if ($prefix) { | |
219 | self::$_import['entity_batch'] = & $fields[$name]; | |
220 | } else { | |
221 | self::$_import[$name] = & $fields[$name]; | |
222 | } | |
223 | } | |
224 | } | |
225 | } | |
226 | return self::$_import; | |
227 | } | |
228 | /** | |
229 | * Returns the list of fields that can be exported | |
230 | * | |
231 | * @param bool $prefix | |
232 | * | |
233 | * @return array | |
234 | */ | |
235 | static function &export($prefix = false) { | |
236 | if (!(self::$_export)) { | |
237 | self::$_export = array(); | |
238 | $fields = self::fields(); | |
239 | foreach($fields as $name => $field) { | |
240 | if (CRM_Utils_Array::value('export', $field)) { | |
241 | if ($prefix) { | |
242 | self::$_export['entity_batch'] = & $fields[$name]; | |
243 | } else { | |
244 | self::$_export[$name] = & $fields[$name]; | |
245 | } | |
246 | } | |
247 | } | |
248 | } | |
249 | return self::$_export; | |
250 | } | |
251 | } |