3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2017
31 * Generated from xml/schema/CRM/Mailing/MailingJob.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:0d980fe5408cdcfa95a640da20a9f2f2)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Mailing_DAO_MailingJob constructor.
40 class CRM_Mailing_DAO_MailingJob
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_mailing_job';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
59 * The ID of the mailing this Job will send.
65 * date on which this job was scheduled.
69 public $scheduled_date;
71 * date on which this job was started.
77 * date on which this job ended.
83 * The state of this job
89 * Is this job for a test mail?
95 * Type of mailling job: null | child
107 * Offset of the child job
113 * Queue size limit for each child job
121 function __construct() {
122 $this->__table
= 'civicrm_mailing_job';
123 parent
::__construct();
126 * Returns foreign keys and entity references.
129 * [CRM_Core_Reference_Interface]
131 static function getReferenceColumns() {
132 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
133 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
134 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'mailing_id', 'civicrm_mailing', 'id');
135 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'parent_id', 'civicrm_mailing_job', 'id');
136 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
138 return Civi
::$statics[__CLASS__
]['links'];
141 * Returns all the column names of this table
145 static function &fields() {
146 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
147 Civi
::$statics[__CLASS__
]['fields'] = array(
150 'type' => CRM_Utils_Type
::T_INT
,
151 'title' => ts('Mailing Job ID') ,
153 'table_name' => 'civicrm_mailing_job',
154 'entity' => 'MailingJob',
155 'bao' => 'CRM_Mailing_BAO_MailingJob',
157 'mailing_id' => array(
158 'name' => 'mailing_id',
159 'type' => CRM_Utils_Type
::T_INT
,
160 'title' => ts('Mailing') ,
161 'description' => 'The ID of the mailing this Job will send.',
163 'table_name' => 'civicrm_mailing_job',
164 'entity' => 'MailingJob',
165 'bao' => 'CRM_Mailing_BAO_MailingJob',
166 'FKClassName' => 'CRM_Mailing_DAO_Mailing',
168 'scheduled_date' => array(
169 'name' => 'scheduled_date',
170 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
171 'title' => ts('Mailing Scheduled Date') ,
172 'description' => 'date on which this job was scheduled.',
173 'table_name' => 'civicrm_mailing_job',
174 'entity' => 'MailingJob',
175 'bao' => 'CRM_Mailing_BAO_MailingJob',
177 'start_date' => array(
178 'name' => 'start_date',
179 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
180 'title' => ts('Mailing Job Start Date') ,
181 'description' => 'date on which this job was started.',
182 'table_name' => 'civicrm_mailing_job',
183 'entity' => 'MailingJob',
184 'bao' => 'CRM_Mailing_BAO_MailingJob',
187 'name' => 'end_date',
188 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
189 'title' => ts('Mailing Job End Date') ,
190 'description' => 'date on which this job ended.',
191 'table_name' => 'civicrm_mailing_job',
192 'entity' => 'MailingJob',
193 'bao' => 'CRM_Mailing_BAO_MailingJob',
197 'type' => CRM_Utils_Type
::T_STRING
,
198 'title' => ts('Mailing Job Status') ,
199 'description' => 'The state of this job',
201 'size' => CRM_Utils_Type
::TWELVE
,
202 'table_name' => 'civicrm_mailing_job',
203 'entity' => 'MailingJob',
204 'bao' => 'CRM_Mailing_BAO_MailingJob',
208 'pseudoconstant' => array(
209 'callback' => 'CRM_Core_SelectValues::getMailingJobStatus',
214 'type' => CRM_Utils_Type
::T_BOOLEAN
,
215 'title' => ts('Mailing Job Is Test?') ,
216 'description' => 'Is this job for a test mail?',
217 'table_name' => 'civicrm_mailing_job',
218 'entity' => 'MailingJob',
219 'bao' => 'CRM_Mailing_BAO_MailingJob',
222 'name' => 'job_type',
223 'type' => CRM_Utils_Type
::T_STRING
,
224 'title' => ts('Mailing Job Type') ,
225 'description' => 'Type of mailling job: null | child ',
227 'size' => CRM_Utils_Type
::HUGE
,
228 'table_name' => 'civicrm_mailing_job',
229 'entity' => 'MailingJob',
230 'bao' => 'CRM_Mailing_BAO_MailingJob',
232 'parent_id' => array(
233 'name' => 'parent_id',
234 'type' => CRM_Utils_Type
::T_INT
,
235 'title' => ts('Mailing Job Parent') ,
236 'description' => 'Parent job id',
238 'table_name' => 'civicrm_mailing_job',
239 'entity' => 'MailingJob',
240 'bao' => 'CRM_Mailing_BAO_MailingJob',
241 'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
243 'job_offset' => array(
244 'name' => 'job_offset',
245 'type' => CRM_Utils_Type
::T_INT
,
246 'title' => ts('Mailing Job Offset') ,
247 'description' => 'Offset of the child job',
248 'table_name' => 'civicrm_mailing_job',
249 'entity' => 'MailingJob',
250 'bao' => 'CRM_Mailing_BAO_MailingJob',
252 'job_limit' => array(
253 'name' => 'job_limit',
254 'type' => CRM_Utils_Type
::T_INT
,
255 'title' => ts('Mailing Job Limit') ,
256 'description' => 'Queue size limit for each child job',
257 'table_name' => 'civicrm_mailing_job',
258 'entity' => 'MailingJob',
259 'bao' => 'CRM_Mailing_BAO_MailingJob',
262 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
264 return Civi
::$statics[__CLASS__
]['fields'];
267 * Return a mapping from field-name to the corresponding key (as used in fields()).
270 * Array(string $name => string $uniqueName).
272 static function &fieldKeys() {
273 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
274 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
276 return Civi
::$statics[__CLASS__
]['fieldKeys'];
279 * Returns the names of this table
283 static function getTableName() {
284 return self
::$_tableName;
287 * Returns if this table needs to be logged
295 * Returns the list of fields that can be imported
297 * @param bool $prefix
301 static function &import($prefix = false) {
302 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_job', $prefix, array());
306 * Returns the list of fields that can be exported
308 * @param bool $prefix
312 static function &export($prefix = false) {
313 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_job', $prefix, array());