Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
8c9251b3 | 5 | * @copyright CiviCRM LLC (c) 2004-2018 |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Mailing/MailingJob.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
6c2b97b7 | 9 | * (GenCodeChecksum:51449e1b36d9d248712f346f20c9e446) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the MailingJob entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO { |
c3fc2621 | 16 | |
e501603b | 17 | /** |
f41f0342 | 18 | * Static instance to hold the table name. |
e501603b TO |
19 | * |
20 | * @var string | |
21 | */ | |
22 | static $_tableName = 'civicrm_mailing_job'; | |
c3fc2621 | 23 | |
e501603b | 24 | /** |
f41f0342 | 25 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 26 | * |
c3fc2621 | 27 | * @var bool |
e501603b | 28 | */ |
c3fc2621 CW |
29 | static $_log = FALSE; |
30 | ||
e501603b | 31 | /** |
e501603b TO |
32 | * @var int unsigned |
33 | */ | |
34 | public $id; | |
c3fc2621 | 35 | |
e501603b TO |
36 | /** |
37 | * The ID of the mailing this Job will send. | |
38 | * | |
39 | * @var int unsigned | |
40 | */ | |
41 | public $mailing_id; | |
c3fc2621 | 42 | |
e501603b TO |
43 | /** |
44 | * date on which this job was scheduled. | |
45 | * | |
6c2b97b7 | 46 | * @var timestamp |
e501603b TO |
47 | */ |
48 | public $scheduled_date; | |
c3fc2621 | 49 | |
e501603b TO |
50 | /** |
51 | * date on which this job was started. | |
52 | * | |
6c2b97b7 | 53 | * @var timestamp |
e501603b TO |
54 | */ |
55 | public $start_date; | |
c3fc2621 | 56 | |
e501603b TO |
57 | /** |
58 | * date on which this job ended. | |
59 | * | |
6c2b97b7 | 60 | * @var timestamp |
e501603b TO |
61 | */ |
62 | public $end_date; | |
c3fc2621 | 63 | |
e501603b TO |
64 | /** |
65 | * The state of this job | |
66 | * | |
67 | * @var string | |
68 | */ | |
69 | public $status; | |
c3fc2621 | 70 | |
e501603b TO |
71 | /** |
72 | * Is this job for a test mail? | |
73 | * | |
74 | * @var boolean | |
75 | */ | |
76 | public $is_test; | |
c3fc2621 | 77 | |
e501603b TO |
78 | /** |
79 | * Type of mailling job: null | child | |
80 | * | |
81 | * @var string | |
82 | */ | |
83 | public $job_type; | |
c3fc2621 | 84 | |
e501603b TO |
85 | /** |
86 | * Parent job id | |
87 | * | |
88 | * @var int unsigned | |
89 | */ | |
90 | public $parent_id; | |
c3fc2621 | 91 | |
e501603b TO |
92 | /** |
93 | * Offset of the child job | |
94 | * | |
95 | * @var int | |
96 | */ | |
97 | public $job_offset; | |
c3fc2621 | 98 | |
e501603b TO |
99 | /** |
100 | * Queue size limit for each child job | |
101 | * | |
102 | * @var int | |
103 | */ | |
104 | public $job_limit; | |
c3fc2621 | 105 | |
e501603b | 106 | /** |
f41f0342 | 107 | * Class constructor. |
e501603b | 108 | */ |
c3fc2621 | 109 | public function __construct() { |
e501603b TO |
110 | $this->__table = 'civicrm_mailing_job'; |
111 | parent::__construct(); | |
112 | } | |
c3fc2621 | 113 | |
e501603b | 114 | /** |
f41f0342 | 115 | * Returns foreign keys and entity references. |
e501603b TO |
116 | * |
117 | * @return array | |
118 | * [CRM_Core_Reference_Interface] | |
119 | */ | |
c3fc2621 | 120 | public static function getReferenceColumns() { |
346aaaba TO |
121 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
122 | Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__); | |
c3fc2621 CW |
123 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'mailing_id', 'civicrm_mailing', 'id'); |
124 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'parent_id', 'civicrm_mailing_job', 'id'); | |
346aaaba | 125 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 126 | } |
346aaaba | 127 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 128 | } |
c3fc2621 | 129 | |
e501603b TO |
130 | /** |
131 | * Returns all the column names of this table | |
132 | * | |
133 | * @return array | |
134 | */ | |
c3fc2621 | 135 | public static function &fields() { |
346aaaba | 136 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
137 | Civi::$statics[__CLASS__]['fields'] = [ |
138 | 'id' => [ | |
e501603b TO |
139 | 'name' => 'id', |
140 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
141 | 'title' => ts('Mailing Job ID'), |
142 | 'required' => TRUE, | |
522a26c9 | 143 | 'table_name' => 'civicrm_mailing_job', |
144 | 'entity' => 'MailingJob', | |
145 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 146 | 'localizable' => 0, |
c3fc2621 CW |
147 | ], |
148 | 'mailing_id' => [ | |
e501603b TO |
149 | 'name' => 'mailing_id', |
150 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 151 | 'title' => ts('Mailing'), |
e501603b | 152 | 'description' => 'The ID of the mailing this Job will send.', |
c3fc2621 | 153 | 'required' => TRUE, |
522a26c9 | 154 | 'table_name' => 'civicrm_mailing_job', |
155 | 'entity' => 'MailingJob', | |
156 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 157 | 'localizable' => 0, |
e501603b | 158 | 'FKClassName' => 'CRM_Mailing_DAO_Mailing', |
c3fc2621 CW |
159 | ], |
160 | 'scheduled_date' => [ | |
e501603b | 161 | 'name' => 'scheduled_date', |
6c2b97b7 | 162 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 163 | 'title' => ts('Mailing Scheduled Date'), |
e501603b | 164 | 'description' => 'date on which this job was scheduled.', |
c3fc2621 | 165 | 'required' => FALSE, |
6c2b97b7 | 166 | 'default' => 'NULL', |
522a26c9 | 167 | 'table_name' => 'civicrm_mailing_job', |
168 | 'entity' => 'MailingJob', | |
169 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 170 | 'localizable' => 0, |
c3fc2621 CW |
171 | ], |
172 | 'start_date' => [ | |
e501603b | 173 | 'name' => 'start_date', |
6c2b97b7 | 174 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 175 | 'title' => ts('Mailing Job Start Date'), |
e501603b | 176 | 'description' => 'date on which this job was started.', |
c3fc2621 | 177 | 'required' => FALSE, |
6c2b97b7 | 178 | 'default' => 'NULL', |
522a26c9 | 179 | 'table_name' => 'civicrm_mailing_job', |
180 | 'entity' => 'MailingJob', | |
181 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 182 | 'localizable' => 0, |
c3fc2621 CW |
183 | ], |
184 | 'end_date' => [ | |
e501603b | 185 | 'name' => 'end_date', |
6c2b97b7 | 186 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 187 | 'title' => ts('Mailing Job End Date'), |
e501603b | 188 | 'description' => 'date on which this job ended.', |
c3fc2621 | 189 | 'required' => FALSE, |
6c2b97b7 | 190 | 'default' => 'NULL', |
522a26c9 | 191 | 'table_name' => 'civicrm_mailing_job', |
192 | 'entity' => 'MailingJob', | |
193 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 194 | 'localizable' => 0, |
c3fc2621 CW |
195 | ], |
196 | 'status' => [ | |
e501603b TO |
197 | 'name' => 'status', |
198 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 199 | 'title' => ts('Mailing Job Status'), |
e501603b TO |
200 | 'description' => 'The state of this job', |
201 | 'maxlength' => 12, | |
202 | 'size' => CRM_Utils_Type::TWELVE, | |
522a26c9 | 203 | 'table_name' => 'civicrm_mailing_job', |
204 | 'entity' => 'MailingJob', | |
205 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 206 | 'localizable' => 0, |
c3fc2621 | 207 | 'html' => [ |
e501603b | 208 | 'type' => 'Select', |
c3fc2621 CW |
209 | ], |
210 | 'pseudoconstant' => [ | |
e501603b | 211 | 'callback' => 'CRM_Core_SelectValues::getMailingJobStatus', |
c3fc2621 CW |
212 | ] |
213 | ], | |
214 | 'is_test' => [ | |
e501603b TO |
215 | 'name' => 'is_test', |
216 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 217 | 'title' => ts('Mailing Job Is Test?'), |
e501603b | 218 | 'description' => 'Is this job for a test mail?', |
522a26c9 | 219 | 'table_name' => 'civicrm_mailing_job', |
220 | 'entity' => 'MailingJob', | |
221 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 222 | 'localizable' => 0, |
c3fc2621 CW |
223 | ], |
224 | 'job_type' => [ | |
e501603b TO |
225 | 'name' => 'job_type', |
226 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 227 | 'title' => ts('Mailing Job Type'), |
e501603b TO |
228 | 'description' => 'Type of mailling job: null | child ', |
229 | 'maxlength' => 255, | |
230 | 'size' => CRM_Utils_Type::HUGE, | |
522a26c9 | 231 | 'table_name' => 'civicrm_mailing_job', |
232 | 'entity' => 'MailingJob', | |
233 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 234 | 'localizable' => 0, |
c3fc2621 CW |
235 | ], |
236 | 'parent_id' => [ | |
e501603b TO |
237 | 'name' => 'parent_id', |
238 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 239 | 'title' => ts('Mailing Job Parent'), |
e501603b TO |
240 | 'description' => 'Parent job id', |
241 | 'default' => 'NULL', | |
522a26c9 | 242 | 'table_name' => 'civicrm_mailing_job', |
243 | 'entity' => 'MailingJob', | |
244 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 245 | 'localizable' => 0, |
e501603b | 246 | 'FKClassName' => 'CRM_Mailing_DAO_MailingJob', |
c3fc2621 CW |
247 | ], |
248 | 'job_offset' => [ | |
e501603b TO |
249 | 'name' => 'job_offset', |
250 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 251 | 'title' => ts('Mailing Job Offset'), |
e501603b | 252 | 'description' => 'Offset of the child job', |
522a26c9 | 253 | 'table_name' => 'civicrm_mailing_job', |
254 | 'entity' => 'MailingJob', | |
255 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 256 | 'localizable' => 0, |
c3fc2621 CW |
257 | ], |
258 | 'job_limit' => [ | |
e501603b TO |
259 | 'name' => 'job_limit', |
260 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 261 | 'title' => ts('Mailing Job Limit'), |
e501603b | 262 | 'description' => 'Queue size limit for each child job', |
522a26c9 | 263 | 'table_name' => 'civicrm_mailing_job', |
264 | 'entity' => 'MailingJob', | |
265 | 'bao' => 'CRM_Mailing_BAO_MailingJob', | |
6a7e5e5d | 266 | 'localizable' => 0, |
c3fc2621 CW |
267 | ], |
268 | ]; | |
346aaaba | 269 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 270 | } |
346aaaba | 271 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 272 | } |
c3fc2621 | 273 | |
e501603b | 274 | /** |
bd8e0b14 | 275 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
276 | * |
277 | * @return array | |
bd8e0b14 | 278 | * Array(string $name => string $uniqueName). |
e501603b | 279 | */ |
c3fc2621 | 280 | public static function &fieldKeys() { |
bd8e0b14 TO |
281 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
282 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 283 | } |
bd8e0b14 | 284 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 285 | } |
c3fc2621 | 286 | |
e501603b TO |
287 | /** |
288 | * Returns the names of this table | |
289 | * | |
290 | * @return string | |
291 | */ | |
c3fc2621 | 292 | public static function getTableName() { |
e501603b TO |
293 | return self::$_tableName; |
294 | } | |
c3fc2621 | 295 | |
e501603b TO |
296 | /** |
297 | * Returns if this table needs to be logged | |
298 | * | |
c3fc2621 | 299 | * @return bool |
e501603b | 300 | */ |
c3fc2621 | 301 | public function getLog() { |
e501603b TO |
302 | return self::$_log; |
303 | } | |
c3fc2621 | 304 | |
e501603b TO |
305 | /** |
306 | * Returns the list of fields that can be imported | |
307 | * | |
308 | * @param bool $prefix | |
309 | * | |
310 | * @return array | |
311 | */ | |
c3fc2621 CW |
312 | public static function &import($prefix = FALSE) { |
313 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_job', $prefix, []); | |
60808919 | 314 | return $r; |
e501603b | 315 | } |
c3fc2621 | 316 | |
e501603b TO |
317 | /** |
318 | * Returns the list of fields that can be exported | |
319 | * | |
320 | * @param bool $prefix | |
321 | * | |
322 | * @return array | |
323 | */ | |
c3fc2621 CW |
324 | public static function &export($prefix = FALSE) { |
325 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_job', $prefix, []); | |
60808919 | 326 | return $r; |
e501603b | 327 | } |
c3fc2621 | 328 | |
e7a6b91a AS |
329 | /** |
330 | * Returns the list of indices | |
c3fc2621 CW |
331 | * |
332 | * @param bool $localize | |
333 | * | |
334 | * @return array | |
e7a6b91a AS |
335 | */ |
336 | public static function indices($localize = TRUE) { | |
c3fc2621 | 337 | $indices = []; |
e7a6b91a AS |
338 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
339 | } | |
c3fc2621 | 340 | |
e501603b | 341 | } |