5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Mailing/MailingJob.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:e7dbe1ca234cec93cb54192911b87297)
13 * Database access object for the MailingJob entity.
15 class CRM_Mailing_DAO_MailingJob
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_mailing_job';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = FALSE;
37 * The ID of the mailing this Job will send.
44 * date on which this job was scheduled.
48 public $scheduled_date;
51 * date on which this job was started.
58 * date on which this job ended.
65 * The state of this job
72 * Is this job for a test mail?
79 * Type of mailling job: null | child
93 * Offset of the child job
100 * Queue size limit for each child job
109 public function __construct() {
110 $this->__table
= 'civicrm_mailing_job';
111 parent
::__construct();
115 * Returns foreign keys and entity references.
118 * [CRM_Core_Reference_Interface]
120 public static function getReferenceColumns() {
121 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
122 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
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');
125 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
127 return Civi
::$statics[__CLASS__
]['links'];
131 * Returns all the column names of this table
135 public static function &fields() {
136 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
137 Civi
::$statics[__CLASS__
]['fields'] = [
140 'type' => CRM_Utils_Type
::T_INT
,
141 'title' => ts('Mailing Job ID'),
143 'where' => 'civicrm_mailing_job.id',
144 'table_name' => 'civicrm_mailing_job',
145 'entity' => 'MailingJob',
146 'bao' => 'CRM_Mailing_BAO_MailingJob',
150 'name' => 'mailing_id',
151 'type' => CRM_Utils_Type
::T_INT
,
152 'title' => ts('Mailing'),
153 'description' => ts('The ID of the mailing this Job will send.'),
155 'where' => 'civicrm_mailing_job.mailing_id',
156 'table_name' => 'civicrm_mailing_job',
157 'entity' => 'MailingJob',
158 'bao' => 'CRM_Mailing_BAO_MailingJob',
160 'FKClassName' => 'CRM_Mailing_DAO_Mailing',
162 'scheduled_date' => [
163 'name' => 'scheduled_date',
164 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
165 'title' => ts('Mailing Scheduled Date'),
166 'description' => ts('date on which this job was scheduled.'),
168 'where' => 'civicrm_mailing_job.scheduled_date',
170 'table_name' => 'civicrm_mailing_job',
171 'entity' => 'MailingJob',
172 'bao' => 'CRM_Mailing_BAO_MailingJob',
176 'name' => 'start_date',
177 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
178 'title' => ts('Mailing Job Start Date'),
179 'description' => ts('date on which this job was started.'),
181 'where' => 'civicrm_mailing_job.start_date',
183 'table_name' => 'civicrm_mailing_job',
184 'entity' => 'MailingJob',
185 'bao' => 'CRM_Mailing_BAO_MailingJob',
189 'name' => 'end_date',
190 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
191 'title' => ts('Mailing Job End Date'),
192 'description' => ts('date on which this job ended.'),
194 'where' => 'civicrm_mailing_job.end_date',
196 'table_name' => 'civicrm_mailing_job',
197 'entity' => 'MailingJob',
198 'bao' => 'CRM_Mailing_BAO_MailingJob',
203 'type' => CRM_Utils_Type
::T_STRING
,
204 'title' => ts('Mailing Job Status'),
205 'description' => ts('The state of this job'),
207 'size' => CRM_Utils_Type
::TWELVE
,
208 'where' => 'civicrm_mailing_job.status',
209 'table_name' => 'civicrm_mailing_job',
210 'entity' => 'MailingJob',
211 'bao' => 'CRM_Mailing_BAO_MailingJob',
216 'pseudoconstant' => [
217 'callback' => 'CRM_Core_SelectValues::getMailingJobStatus',
222 'type' => CRM_Utils_Type
::T_BOOLEAN
,
223 'title' => ts('Mailing Job Is Test?'),
224 'description' => ts('Is this job for a test mail?'),
225 'where' => 'civicrm_mailing_job.is_test',
227 'table_name' => 'civicrm_mailing_job',
228 'entity' => 'MailingJob',
229 'bao' => 'CRM_Mailing_BAO_MailingJob',
233 'name' => 'job_type',
234 'type' => CRM_Utils_Type
::T_STRING
,
235 'title' => ts('Mailing Job Type'),
236 'description' => ts('Type of mailling job: null | child '),
238 'size' => CRM_Utils_Type
::HUGE
,
239 'where' => 'civicrm_mailing_job.job_type',
240 'table_name' => 'civicrm_mailing_job',
241 'entity' => 'MailingJob',
242 'bao' => 'CRM_Mailing_BAO_MailingJob',
246 'name' => 'parent_id',
247 'type' => CRM_Utils_Type
::T_INT
,
248 'title' => ts('Mailing Job Parent'),
249 'description' => ts('Parent job id'),
250 'where' => 'civicrm_mailing_job.parent_id',
252 'table_name' => 'civicrm_mailing_job',
253 'entity' => 'MailingJob',
254 'bao' => 'CRM_Mailing_BAO_MailingJob',
256 'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
259 'name' => 'job_offset',
260 'type' => CRM_Utils_Type
::T_INT
,
261 'title' => ts('Mailing Job Offset'),
262 'description' => ts('Offset of the child job'),
263 'where' => 'civicrm_mailing_job.job_offset',
265 'table_name' => 'civicrm_mailing_job',
266 'entity' => 'MailingJob',
267 'bao' => 'CRM_Mailing_BAO_MailingJob',
271 'name' => 'job_limit',
272 'type' => CRM_Utils_Type
::T_INT
,
273 'title' => ts('Mailing Job Limit'),
274 'description' => ts('Queue size limit for each child job'),
275 'where' => 'civicrm_mailing_job.job_limit',
277 'table_name' => 'civicrm_mailing_job',
278 'entity' => 'MailingJob',
279 'bao' => 'CRM_Mailing_BAO_MailingJob',
283 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
285 return Civi
::$statics[__CLASS__
]['fields'];
289 * Return a mapping from field-name to the corresponding key (as used in fields()).
292 * Array(string $name => string $uniqueName).
294 public static function &fieldKeys() {
295 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
296 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
298 return Civi
::$statics[__CLASS__
]['fieldKeys'];
302 * Returns the names of this table
306 public static function getTableName() {
307 return self
::$_tableName;
311 * Returns if this table needs to be logged
315 public function getLog() {
320 * Returns the list of fields that can be imported
322 * @param bool $prefix
326 public static function &import($prefix = FALSE) {
327 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_job', $prefix, []);
332 * Returns the list of fields that can be exported
334 * @param bool $prefix
338 public static function &export($prefix = FALSE) {
339 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_job', $prefix, []);
344 * Returns the list of indices
346 * @param bool $localize
350 public static function indices($localize = TRUE) {
352 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;