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/Core/Job.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:c3340527b2d2cb17211eba848371b469)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Core_DAO_Job constructor.
40 class CRM_Core_DAO_Job
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_job';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
60 * Which Domain is this scheduled job for
66 * Scheduled job run frequency.
70 public $run_frequency;
72 * When was this cron entry last run
78 * When is this cron entry scheduled to run
82 public $scheduled_run_date;
90 * Description of the job
96 * Entity of the job api call
102 * Action of the job api call
108 * List of parameters to the command.
114 * Is this job active?
122 function __construct() {
123 $this->__table
= 'civicrm_job';
124 parent
::__construct();
127 * Returns foreign keys and entity references.
130 * [CRM_Core_Reference_Interface]
132 static function getReferenceColumns() {
133 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
134 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
135 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'domain_id', 'civicrm_domain', '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('Job ID') ,
152 'description' => 'Job Id',
154 'table_name' => 'civicrm_job',
156 'bao' => 'CRM_Core_BAO_Job',
159 'domain_id' => array(
160 'name' => 'domain_id',
161 'type' => CRM_Utils_Type
::T_INT
,
162 'title' => ts('Job Domain') ,
163 'description' => 'Which Domain is this scheduled job for',
165 'table_name' => 'civicrm_job',
167 'bao' => 'CRM_Core_BAO_Job',
169 'FKClassName' => 'CRM_Core_DAO_Domain',
170 'pseudoconstant' => array(
171 'table' => 'civicrm_domain',
173 'labelColumn' => 'name',
176 'run_frequency' => array(
177 'name' => 'run_frequency',
178 'type' => CRM_Utils_Type
::T_STRING
,
179 'title' => ts('Job Frequency') ,
180 'description' => 'Scheduled job run frequency.',
182 'size' => CRM_Utils_Type
::EIGHT
,
183 'default' => 'Daily',
184 'table_name' => 'civicrm_job',
186 'bao' => 'CRM_Core_BAO_Job',
191 'pseudoconstant' => array(
192 'callback' => 'CRM_Core_SelectValues::getJobFrequency',
196 'name' => 'last_run',
197 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
198 'title' => ts('Last Run') ,
199 'description' => 'When was this cron entry last run',
201 'table_name' => 'civicrm_job',
203 'bao' => 'CRM_Core_BAO_Job',
206 'scheduled_run_date' => array(
207 'name' => 'scheduled_run_date',
208 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
209 'title' => ts('Scheduled Run Date') ,
210 'description' => 'When is this cron entry scheduled to run',
213 'table_name' => 'civicrm_job',
215 'bao' => 'CRM_Core_BAO_Job',
220 'type' => CRM_Utils_Type
::T_STRING
,
221 'title' => ts('Job Name') ,
222 'description' => 'Title of the job',
224 'size' => CRM_Utils_Type
::HUGE
,
225 'table_name' => 'civicrm_job',
227 'bao' => 'CRM_Core_BAO_Job',
230 'description' => array(
231 'name' => 'description',
232 'type' => CRM_Utils_Type
::T_STRING
,
233 'title' => ts('Job Description') ,
234 'description' => 'Description of the job',
236 'size' => CRM_Utils_Type
::HUGE
,
237 'table_name' => 'civicrm_job',
239 'bao' => 'CRM_Core_BAO_Job',
242 'api_entity' => array(
243 'name' => 'api_entity',
244 'type' => CRM_Utils_Type
::T_STRING
,
245 'title' => ts('API Entity') ,
246 'description' => 'Entity of the job api call',
248 'size' => CRM_Utils_Type
::HUGE
,
249 'table_name' => 'civicrm_job',
251 'bao' => 'CRM_Core_BAO_Job',
254 'api_action' => array(
255 'name' => 'api_action',
256 'type' => CRM_Utils_Type
::T_STRING
,
257 'title' => ts('API Action') ,
258 'description' => 'Action of the job api call',
260 'size' => CRM_Utils_Type
::HUGE
,
261 'table_name' => 'civicrm_job',
263 'bao' => 'CRM_Core_BAO_Job',
266 'parameters' => array(
267 'name' => 'parameters',
268 'type' => CRM_Utils_Type
::T_TEXT
,
269 'title' => ts('API Parameters') ,
270 'description' => 'List of parameters to the command.',
273 'table_name' => 'civicrm_job',
275 'bao' => 'CRM_Core_BAO_Job',
278 'type' => 'TextArea',
281 'is_active' => array(
282 'name' => 'is_active',
283 'type' => CRM_Utils_Type
::T_BOOLEAN
,
284 'title' => ts('Job Is Active?') ,
285 'description' => 'Is this job active?',
286 'table_name' => 'civicrm_job',
288 'bao' => 'CRM_Core_BAO_Job',
292 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
294 return Civi
::$statics[__CLASS__
]['fields'];
297 * Return a mapping from field-name to the corresponding key (as used in fields()).
300 * Array(string $name => string $uniqueName).
302 static function &fieldKeys() {
303 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
304 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
306 return Civi
::$statics[__CLASS__
]['fieldKeys'];
309 * Returns the names of this table
313 static function getTableName() {
314 return self
::$_tableName;
317 * Returns if this table needs to be logged
325 * Returns the list of fields that can be imported
327 * @param bool $prefix
331 static function &import($prefix = false) {
332 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'job', $prefix, array());
336 * Returns the list of fields that can be exported
338 * @param bool $prefix
342 static function &export($prefix = false) {
343 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'job', $prefix, array());
347 * Returns the list of indices
349 public static function indices($localize = TRUE) {
351 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;