CRM/Core/DAO/Job.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  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.   |
  13 |                                                                    |
  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.        |
  18 |                                                                    |
  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 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Core/Job.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:ec2775b0ba09eb61d32f1565ebbaf4f8)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_Job constructor.
  39  */
  40 class CRM_Core_DAO_Job extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_job';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    * Job Id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Which Domain is this scheduled job for
  61    *
  62    * @var int unsigned
  63    */
  64   public $domain_id;
  65   /**
  66    * Scheduled job run frequency.
  67    *
  68    * @var string
  69    */
  70   public $run_frequency;
  71   /**
  72    * When was this cron entry last run
  73    *
  74    * @var timestamp
  75    */
  76   public $last_run;
  77   /**
  78    * When is this cron entry scheduled to run
  79    *
  80    * @var timestamp
  81    */
  82   public $scheduled_run_date;
  83   /**
  84    * Title of the job
  85    *
  86    * @var string
  87    */
  88   public $name;
  89   /**
  90    * Description of the job
  91    *
  92    * @var string
  93    */
  94   public $description;
  95   /**
  96    * Entity of the job api call
  97    *
  98    * @var string
  99    */
 100   public $api_entity;
 101   /**
 102    * Action of the job api call
 103    *
 104    * @var string
 105    */
 106   public $api_action;
 107   /**
 108    * List of parameters to the command.
 109    *
 110    * @var text
 111    */
 112   public $parameters;
 113   /**
 114    * Is this job active?
 115    *
 116    * @var boolean
 117    */
 118   public $is_active;
 119   /**
 120    * Class constructor.
 121    */
 122   function __construct() {
 123     $this->__table = 'civicrm_job';
 124     parent::__construct();
 125   }
 126   /**
 127    * Returns foreign keys and entity references.
 128    *
 129    * @return array
 130    *   [CRM_Core_Reference_Interface]
 131    */
 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']);
 137     }
 138     return Civi::$statics[__CLASS__]['links'];
 139   }
 140   /**
 141    * Returns all the column names of this table
 142    *
 143    * @return array
 144    */
 145   static function &fields() {
 146     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 147       Civi::$statics[__CLASS__]['fields'] = array(
 148         'id' => array(
 149           'name' => 'id',
 150           'type' => CRM_Utils_Type::T_INT,
 151           'title' => ts('Job ID') ,
 152           'description' => 'Job Id',
 153           'required' => true,
 154           'table_name' => 'civicrm_job',
 155           'entity' => 'Job',
 156           'bao' => 'CRM_Core_BAO_Job',
 157           'localizable' => 0,
 158         ) ,
 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',
 164           'required' => true,
 165           'table_name' => 'civicrm_job',
 166           'entity' => 'Job',
 167           'bao' => 'CRM_Core_BAO_Job',
 168           'localizable' => 0,
 169           'FKClassName' => 'CRM_Core_DAO_Domain',
 170           'pseudoconstant' => array(
 171             'table' => 'civicrm_domain',
 172             'keyColumn' => 'id',
 173             'labelColumn' => 'name',
 174           )
 175         ) ,
 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.',
 181           'maxlength' => 8,
 182           'size' => CRM_Utils_Type::EIGHT,
 183           'default' => 'Daily',
 184           'table_name' => 'civicrm_job',
 185           'entity' => 'Job',
 186           'bao' => 'CRM_Core_BAO_Job',
 187           'localizable' => 0,
 188           'html' => array(
 189             'type' => 'Select',
 190           ) ,
 191           'pseudoconstant' => array(
 192             'callback' => 'CRM_Core_SelectValues::getJobFrequency',
 193           )
 194         ) ,
 195         'last_run' => array(
 196           'name' => 'last_run',
 197           'type' => CRM_Utils_Type::T_TIMESTAMP,
 198           'title' => ts('Last Run') ,
 199           'description' => 'When was this cron entry last run',
 200           'required' => false,
 201           'default' => 'NULL',
 202           'table_name' => 'civicrm_job',
 203           'entity' => 'Job',
 204           'bao' => 'CRM_Core_BAO_Job',
 205           'localizable' => 0,
 206         ) ,
 207         'scheduled_run_date' => array(
 208           'name' => 'scheduled_run_date',
 209           'type' => CRM_Utils_Type::T_TIMESTAMP,
 210           'title' => ts('Scheduled Run Date') ,
 211           'description' => 'When is this cron entry scheduled to run',
 212           'required' => false,
 213           'default' => 'NULL',
 214           'table_name' => 'civicrm_job',
 215           'entity' => 'Job',
 216           'bao' => 'CRM_Core_BAO_Job',
 217           'localizable' => 0,
 218         ) ,
 219         'name' => array(
 220           'name' => 'name',
 221           'type' => CRM_Utils_Type::T_STRING,
 222           'title' => ts('Job Name') ,
 223           'description' => 'Title of the job',
 224           'maxlength' => 255,
 225           'size' => CRM_Utils_Type::HUGE,
 226           'table_name' => 'civicrm_job',
 227           'entity' => 'Job',
 228           'bao' => 'CRM_Core_BAO_Job',
 229           'localizable' => 0,
 230         ) ,
 231         'description' => array(
 232           'name' => 'description',
 233           'type' => CRM_Utils_Type::T_STRING,
 234           'title' => ts('Job Description') ,
 235           'description' => 'Description of the job',
 236           'maxlength' => 255,
 237           'size' => CRM_Utils_Type::HUGE,
 238           'table_name' => 'civicrm_job',
 239           'entity' => 'Job',
 240           'bao' => 'CRM_Core_BAO_Job',
 241           'localizable' => 0,
 242         ) ,
 243         'api_entity' => array(
 244           'name' => 'api_entity',
 245           'type' => CRM_Utils_Type::T_STRING,
 246           'title' => ts('API Entity') ,
 247           'description' => 'Entity of the job api call',
 248           'maxlength' => 255,
 249           'size' => CRM_Utils_Type::HUGE,
 250           'table_name' => 'civicrm_job',
 251           'entity' => 'Job',
 252           'bao' => 'CRM_Core_BAO_Job',
 253           'localizable' => 0,
 254         ) ,
 255         'api_action' => array(
 256           'name' => 'api_action',
 257           'type' => CRM_Utils_Type::T_STRING,
 258           'title' => ts('API Action') ,
 259           'description' => 'Action of the job api call',
 260           'maxlength' => 255,
 261           'size' => CRM_Utils_Type::HUGE,
 262           'table_name' => 'civicrm_job',
 263           'entity' => 'Job',
 264           'bao' => 'CRM_Core_BAO_Job',
 265           'localizable' => 0,
 266         ) ,
 267         'parameters' => array(
 268           'name' => 'parameters',
 269           'type' => CRM_Utils_Type::T_TEXT,
 270           'title' => ts('API Parameters') ,
 271           'description' => 'List of parameters to the command.',
 272           'rows' => 4,
 273           'cols' => 60,
 274           'table_name' => 'civicrm_job',
 275           'entity' => 'Job',
 276           'bao' => 'CRM_Core_BAO_Job',
 277           'localizable' => 0,
 278           'html' => array(
 279             'type' => 'TextArea',
 280           ) ,
 281         ) ,
 282         'is_active' => array(
 283           'name' => 'is_active',
 284           'type' => CRM_Utils_Type::T_BOOLEAN,
 285           'title' => ts('Job Is Active?') ,
 286           'description' => 'Is this job active?',
 287           'table_name' => 'civicrm_job',
 288           'entity' => 'Job',
 289           'bao' => 'CRM_Core_BAO_Job',
 290           'localizable' => 0,
 291         ) ,
 292       );
 293       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 294     }
 295     return Civi::$statics[__CLASS__]['fields'];
 296   }
 297   /**
 298    * Return a mapping from field-name to the corresponding key (as used in fields()).
 299    *
 300    * @return array
 301    *   Array(string $name => string $uniqueName).
 302    */
 303   static function &fieldKeys() {
 304     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 305       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 306     }
 307     return Civi::$statics[__CLASS__]['fieldKeys'];
 308   }
 309   /**
 310    * Returns the names of this table
 311    *
 312    * @return string
 313    */
 314   static function getTableName() {
 315     return self::$_tableName;
 316   }
 317   /**
 318    * Returns if this table needs to be logged
 319    *
 320    * @return boolean
 321    */
 322   function getLog() {
 323     return self::$_log;
 324   }
 325   /**
 326    * Returns the list of fields that can be imported
 327    *
 328    * @param bool $prefix
 329    *
 330    * @return array
 331    */
 332   static function &import($prefix = false) {
 333     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'job', $prefix, array());
 334     return $r;
 335   }
 336   /**
 337    * Returns the list of fields that can be exported
 338    *
 339    * @param bool $prefix
 340    *
 341    * @return array
 342    */
 343   static function &export($prefix = false) {
 344     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'job', $prefix, array());
 345     return $r;
 346   }
 347   /**
 348    * Returns the list of indices
 349    */
 350   public static function indices($localize = TRUE) {
 351     $indices = array();
 352     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 353   }
 354 }