3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
31 * Generated from xml/schema/CRM/Mailing/MailingJob.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:df7f5d74b6be9d995c7990e4315bfe40)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
37 class CRM_Mailing_DAO_MailingJob
extends CRM_Core_DAO
{
39 * static instance to hold the table name
43 static $_tableName = 'civicrm_mailing_job';
45 * static value to see if we should log any modifications to
46 * this table in the civicrm_log table
57 * The ID of the mailing this Job will send.
63 * date on which this job was scheduled.
67 public $scheduled_date;
69 * date on which this job was started.
75 * date on which this job ended.
81 * The state of this job
87 * Is this job for a test mail?
93 * Type of mailling job: null | child
105 * Offset of the child job
111 * Queue size limit for each child job
119 * @return civicrm_mailing_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') ,
154 'mailing_id' => array(
155 'name' => 'mailing_id',
156 'type' => CRM_Utils_Type
::T_INT
,
157 'title' => ts('Mailing') ,
158 'description' => 'The ID of the mailing this Job will send.',
160 'FKClassName' => 'CRM_Mailing_DAO_Mailing',
162 'scheduled_date' => array(
163 'name' => 'scheduled_date',
164 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
165 'title' => ts('Mailing Scheduled Date') ,
166 'description' => 'date on which this job was scheduled.',
168 'start_date' => array(
169 'name' => 'start_date',
170 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
171 'title' => ts('Mailing Job Start Date') ,
172 'description' => 'date on which this job was started.',
175 'name' => 'end_date',
176 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
177 'title' => ts('Mailing Job End Date') ,
178 'description' => 'date on which this job ended.',
182 'type' => CRM_Utils_Type
::T_STRING
,
183 'title' => ts('Mailing Job Status') ,
184 'description' => 'The state of this job',
186 'size' => CRM_Utils_Type
::TWELVE
,
190 'pseudoconstant' => array(
191 'callback' => 'CRM_Core_SelectValues::getMailingJobStatus',
196 'type' => CRM_Utils_Type
::T_BOOLEAN
,
197 'title' => ts('Mailing Job Is Test?') ,
198 'description' => 'Is this job for a test mail?',
201 'name' => 'job_type',
202 'type' => CRM_Utils_Type
::T_STRING
,
203 'title' => ts('Mailing Job Type') ,
204 'description' => 'Type of mailling job: null | child ',
206 'size' => CRM_Utils_Type
::HUGE
,
208 'parent_id' => array(
209 'name' => 'parent_id',
210 'type' => CRM_Utils_Type
::T_INT
,
211 'title' => ts('Mailing Job Parent') ,
212 'description' => 'Parent job id',
214 'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
216 'job_offset' => array(
217 'name' => 'job_offset',
218 'type' => CRM_Utils_Type
::T_INT
,
219 'title' => ts('Mailing Job Offset') ,
220 'description' => 'Offset of the child job',
222 'job_limit' => array(
223 'name' => 'job_limit',
224 'type' => CRM_Utils_Type
::T_INT
,
225 'title' => ts('Mailing Job Limit') ,
226 'description' => 'Queue size limit for each child job',
229 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
231 return Civi
::$statics[__CLASS__
]['fields'];
234 * Return a mapping from field-name to the corresponding key (as used in fields()).
237 * Array(string $name => string $uniqueName).
239 static function &fieldKeys() {
240 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
241 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
243 return Civi
::$statics[__CLASS__
]['fieldKeys'];
246 * Returns the names of this table
250 static function getTableName() {
251 return self
::$_tableName;
254 * Returns if this table needs to be logged
262 * Returns the list of fields that can be imported
264 * @param bool $prefix
268 static function &import($prefix = false) {
269 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_job', $prefix, array());
273 * Returns the list of fields that can be exported
275 * @param bool $prefix
279 static function &export($prefix = false) {
280 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_job', $prefix, array());