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:5c0e5cb30a7aaee5be8f3a2e6d23b84b)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
37 class CRM_Core_DAO_Job
extends CRM_Core_DAO
{
39 * static instance to hold the table name
43 static $_tableName = 'civicrm_job';
45 * static value to see if we should log any modifications to
46 * this table in the civicrm_log table
58 * Which Domain is this scheduled job for
64 * Scheduled job run frequency.
68 public $run_frequency;
70 * When was this cron entry last run
76 * When is this cron entry scheduled to run
80 public $scheduled_run_date;
88 * Description of the job
94 * Entity of the job api call
100 * Action of the job api call
106 * List of parameters to the command.
112 * Is this job active?
120 * @return civicrm_job
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',
155 'domain_id' => array(
156 'name' => 'domain_id',
157 'type' => CRM_Utils_Type
::T_INT
,
158 'title' => ts('Job Domain') ,
159 'description' => 'Which Domain is this scheduled job for',
161 'FKClassName' => 'CRM_Core_DAO_Domain',
162 'pseudoconstant' => array(
163 'table' => 'civicrm_domain',
165 'labelColumn' => 'name',
168 'run_frequency' => array(
169 'name' => 'run_frequency',
170 'type' => CRM_Utils_Type
::T_STRING
,
171 'title' => ts('Job Frequency') ,
172 'description' => 'Scheduled job run frequency.',
174 'size' => CRM_Utils_Type
::EIGHT
,
175 'default' => 'Daily',
179 'pseudoconstant' => array(
180 'callback' => 'CRM_Core_SelectValues::getJobFrequency',
184 'name' => 'last_run',
185 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
186 'title' => ts('Last Run') ,
187 'description' => 'When was this cron entry last run',
190 'scheduled_run_date' => array(
191 'name' => 'scheduled_run_date',
192 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
193 'title' => ts('Scheduled Run Date') ,
194 'description' => 'When is this cron entry scheduled to run',
200 'type' => CRM_Utils_Type
::T_STRING
,
201 'title' => ts('Job Name') ,
202 'description' => 'Title of the job',
204 'size' => CRM_Utils_Type
::HUGE
,
206 'description' => array(
207 'name' => 'description',
208 'type' => CRM_Utils_Type
::T_STRING
,
209 'title' => ts('Job Description') ,
210 'description' => 'Description of the job',
212 'size' => CRM_Utils_Type
::HUGE
,
214 'api_entity' => array(
215 'name' => 'api_entity',
216 'type' => CRM_Utils_Type
::T_STRING
,
217 'title' => ts('API Entity') ,
218 'description' => 'Entity of the job api call',
220 'size' => CRM_Utils_Type
::HUGE
,
222 'api_action' => array(
223 'name' => 'api_action',
224 'type' => CRM_Utils_Type
::T_STRING
,
225 'title' => ts('API Action') ,
226 'description' => 'Action of the job api call',
228 'size' => CRM_Utils_Type
::HUGE
,
230 'parameters' => array(
231 'name' => 'parameters',
232 'type' => CRM_Utils_Type
::T_TEXT
,
233 'title' => ts('API Parameters') ,
234 'description' => 'List of parameters to the command.',
238 'type' => 'TextArea',
241 'is_active' => array(
242 'name' => 'is_active',
243 'type' => CRM_Utils_Type
::T_BOOLEAN
,
244 'title' => ts('Job Is Active?') ,
245 'description' => 'Is this job active?',
248 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
250 return Civi
::$statics[__CLASS__
]['fields'];
253 * Return a mapping from field-name to the corresponding key (as used in fields()).
256 * Array(string $name => string $uniqueName).
258 static function &fieldKeys() {
259 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
260 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
262 return Civi
::$statics[__CLASS__
]['fieldKeys'];
265 * Returns the names of this table
269 static function getTableName() {
270 return self
::$_tableName;
273 * Returns if this table needs to be logged
281 * Returns the list of fields that can be imported
283 * @param bool $prefix
287 static function &import($prefix = false) {
288 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'job', $prefix, array());
292 * Returns the list of fields that can be exported
294 * @param bool $prefix
298 static function &export($prefix = false) {
299 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'job', $prefix, array());