CRM/Mailing/DAO/MailingJob.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Mailing/MailingJob.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:91fa15df43a9b86ba6cd53f1cc9783eb)
  10  */
  11
  12 /**
  13  * Database access object for the MailingJob entity.
  14  */
  15 class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_mailing_job';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = FALSE;
  30
  31   /**
  32    * @var int
  33    */
  34   public $id;
  35
  36   /**
  37    * The ID of the mailing this Job will send.
  38    *
  39    * @var int
  40    */
  41   public $mailing_id;
  42
  43   /**
  44    * date on which this job was scheduled.
  45    *
  46    * @var timestamp
  47    */
  48   public $scheduled_date;
  49
  50   /**
  51    * date on which this job was started.
  52    *
  53    * @var timestamp
  54    */
  55   public $start_date;
  56
  57   /**
  58    * date on which this job ended.
  59    *
  60    * @var timestamp
  61    */
  62   public $end_date;
  63
  64   /**
  65    * The state of this job
  66    *
  67    * @var string
  68    */
  69   public $status;
  70
  71   /**
  72    * Is this job for a test mail?
  73    *
  74    * @var bool
  75    */
  76   public $is_test;
  77
  78   /**
  79    * Type of mailling job: null | child
  80    *
  81    * @var string
  82    */
  83   public $job_type;
  84
  85   /**
  86    * Parent job id
  87    *
  88    * @var int
  89    */
  90   public $parent_id;
  91
  92   /**
  93    * Offset of the child job
  94    *
  95    * @var int
  96    */
  97   public $job_offset;
  98
  99   /**
 100    * Queue size limit for each child job
 101    *
 102    * @var int
 103    */
 104   public $job_limit;
 105
 106   /**
 107    * Class constructor.
 108    */
 109   public function __construct() {
 110     $this->__table = 'civicrm_mailing_job';
 111     parent::__construct();
 112   }
 113
 114   /**
 115    * Returns foreign keys and entity references.
 116    *
 117    * @return array
 118    *   [CRM_Core_Reference_Interface]
 119    */
 120   public static function getReferenceColumns() {
 121     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 122       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 123       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'mailing_id', 'civicrm_mailing', 'id');
 124       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'parent_id', 'civicrm_mailing_job', 'id');
 125       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 126     }
 127     return Civi::$statics[__CLASS__]['links'];
 128   }
 129
 130   /**
 131    * Returns all the column names of this table
 132    *
 133    * @return array
 134    */
 135   public static function &fields() {
 136     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 137       Civi::$statics[__CLASS__]['fields'] = [
 138         'id' => [
 139           'name' => 'id',
 140           'type' => CRM_Utils_Type::T_INT,
 141           'title' => ts('Mailing Job ID'),
 142           'required' => TRUE,
 143           'where' => 'civicrm_mailing_job.id',
 144           'table_name' => 'civicrm_mailing_job',
 145           'entity' => 'MailingJob',
 146           'bao' => 'CRM_Mailing_BAO_MailingJob',
 147           'localizable' => 0,
 148         ],
 149         'mailing_id' => [
 150           'name' => 'mailing_id',
 151           'type' => CRM_Utils_Type::T_INT,
 152           'title' => ts('Mailing'),
 153           'description' => ts('The ID of the mailing this Job will send.'),
 154           'required' => TRUE,
 155           'where' => 'civicrm_mailing_job.mailing_id',
 156           'table_name' => 'civicrm_mailing_job',
 157           'entity' => 'MailingJob',
 158           'bao' => 'CRM_Mailing_BAO_MailingJob',
 159           'localizable' => 0,
 160           'FKClassName' => 'CRM_Mailing_DAO_Mailing',
 161         ],
 162         'scheduled_date' => [
 163           'name' => 'scheduled_date',
 164           'type' => CRM_Utils_Type::T_TIMESTAMP,
 165           'title' => ts('Mailing Scheduled Date'),
 166           'description' => ts('date on which this job was scheduled.'),
 167           'required' => FALSE,
 168           'where' => 'civicrm_mailing_job.scheduled_date',
 169           'default' => 'NULL',
 170           'table_name' => 'civicrm_mailing_job',
 171           'entity' => 'MailingJob',
 172           'bao' => 'CRM_Mailing_BAO_MailingJob',
 173           'localizable' => 0,
 174           'html' => [
 175             'type' => 'Select Date',
 176             'formatType' => 'activityDateTime',
 177           ],
 178         ],
 179         'mailing_job_start_date' => [
 180           'name' => 'start_date',
 181           'type' => CRM_Utils_Type::T_TIMESTAMP,
 182           'title' => ts('Mailing Job Start Date'),
 183           'description' => ts('date on which this job was started.'),
 184           'required' => FALSE,
 185           'where' => 'civicrm_mailing_job.start_date',
 186           'default' => 'NULL',
 187           'table_name' => 'civicrm_mailing_job',
 188           'entity' => 'MailingJob',
 189           'bao' => 'CRM_Mailing_BAO_MailingJob',
 190           'localizable' => 0,
 191           'unique_title' => ts('Mailing Start Date'),
 192           'html' => [
 193             'type' => 'Select Date',
 194             'formatType' => 'activityDateTime',
 195           ],
 196         ],
 197         'end_date' => [
 198           'name' => 'end_date',
 199           'type' => CRM_Utils_Type::T_TIMESTAMP,
 200           'title' => ts('Mailing Job End Date'),
 201           'description' => ts('date on which this job ended.'),
 202           'required' => FALSE,
 203           'where' => 'civicrm_mailing_job.end_date',
 204           'default' => 'NULL',
 205           'table_name' => 'civicrm_mailing_job',
 206           'entity' => 'MailingJob',
 207           'bao' => 'CRM_Mailing_BAO_MailingJob',
 208           'localizable' => 0,
 209           'html' => [
 210             'type' => 'Select Date',
 211             'formatType' => 'activityDateTime',
 212           ],
 213         ],
 214         'mailing_job_status' => [
 215           'name' => 'status',
 216           'type' => CRM_Utils_Type::T_STRING,
 217           'title' => ts('Mailing Job Status'),
 218           'description' => ts('The state of this job'),
 219           'maxlength' => 12,
 220           'size' => CRM_Utils_Type::TWELVE,
 221           'where' => 'civicrm_mailing_job.status',
 222           'table_name' => 'civicrm_mailing_job',
 223           'entity' => 'MailingJob',
 224           'bao' => 'CRM_Mailing_BAO_MailingJob',
 225           'localizable' => 0,
 226           'html' => [
 227             'type' => 'Select',
 228           ],
 229           'pseudoconstant' => [
 230             'callback' => 'CRM_Core_SelectValues::getMailingJobStatus',
 231           ],
 232         ],
 233         'is_test' => [
 234           'name' => 'is_test',
 235           'type' => CRM_Utils_Type::T_BOOLEAN,
 236           'title' => ts('Mailing Job Is Test?'),
 237           'description' => ts('Is this job for a test mail?'),
 238           'where' => 'civicrm_mailing_job.is_test',
 239           'default' => '0',
 240           'table_name' => 'civicrm_mailing_job',
 241           'entity' => 'MailingJob',
 242           'bao' => 'CRM_Mailing_BAO_MailingJob',
 243           'localizable' => 0,
 244         ],
 245         'job_type' => [
 246           'name' => 'job_type',
 247           'type' => CRM_Utils_Type::T_STRING,
 248           'title' => ts('Mailing Job Type'),
 249           'description' => ts('Type of mailling job: null | child '),
 250           'maxlength' => 255,
 251           'size' => CRM_Utils_Type::HUGE,
 252           'where' => 'civicrm_mailing_job.job_type',
 253           'table_name' => 'civicrm_mailing_job',
 254           'entity' => 'MailingJob',
 255           'bao' => 'CRM_Mailing_BAO_MailingJob',
 256           'localizable' => 0,
 257         ],
 258         'parent_id' => [
 259           'name' => 'parent_id',
 260           'type' => CRM_Utils_Type::T_INT,
 261           'title' => ts('Mailing Job Parent'),
 262           'description' => ts('Parent job id'),
 263           'where' => 'civicrm_mailing_job.parent_id',
 264           'default' => 'NULL',
 265           'table_name' => 'civicrm_mailing_job',
 266           'entity' => 'MailingJob',
 267           'bao' => 'CRM_Mailing_BAO_MailingJob',
 268           'localizable' => 0,
 269           'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
 270         ],
 271         'job_offset' => [
 272           'name' => 'job_offset',
 273           'type' => CRM_Utils_Type::T_INT,
 274           'title' => ts('Mailing Job Offset'),
 275           'description' => ts('Offset of the child job'),
 276           'where' => 'civicrm_mailing_job.job_offset',
 277           'default' => '0',
 278           'table_name' => 'civicrm_mailing_job',
 279           'entity' => 'MailingJob',
 280           'bao' => 'CRM_Mailing_BAO_MailingJob',
 281           'localizable' => 0,
 282         ],
 283         'job_limit' => [
 284           'name' => 'job_limit',
 285           'type' => CRM_Utils_Type::T_INT,
 286           'title' => ts('Mailing Job Limit'),
 287           'description' => ts('Queue size limit for each child job'),
 288           'where' => 'civicrm_mailing_job.job_limit',
 289           'default' => '0',
 290           'table_name' => 'civicrm_mailing_job',
 291           'entity' => 'MailingJob',
 292           'bao' => 'CRM_Mailing_BAO_MailingJob',
 293           'localizable' => 0,
 294         ],
 295       ];
 296       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 297     }
 298     return Civi::$statics[__CLASS__]['fields'];
 299   }
 300
 301   /**
 302    * Return a mapping from field-name to the corresponding key (as used in fields()).
 303    *
 304    * @return array
 305    *   Array(string $name => string $uniqueName).
 306    */
 307   public static function &fieldKeys() {
 308     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 309       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 310     }
 311     return Civi::$statics[__CLASS__]['fieldKeys'];
 312   }
 313
 314   /**
 315    * Returns the names of this table
 316    *
 317    * @return string
 318    */
 319   public static function getTableName() {
 320     return self::$_tableName;
 321   }
 322
 323   /**
 324    * Returns if this table needs to be logged
 325    *
 326    * @return bool
 327    */
 328   public function getLog() {
 329     return self::$_log;
 330   }
 331
 332   /**
 333    * Returns the list of fields that can be imported
 334    *
 335    * @param bool $prefix
 336    *
 337    * @return array
 338    */
 339   public static function &import($prefix = FALSE) {
 340     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_job', $prefix, []);
 341     return $r;
 342   }
 343
 344   /**
 345    * Returns the list of fields that can be exported
 346    *
 347    * @param bool $prefix
 348    *
 349    * @return array
 350    */
 351   public static function &export($prefix = FALSE) {
 352     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_job', $prefix, []);
 353     return $r;
 354   }
 355
 356   /**
 357    * Returns the list of indices
 358    *
 359    * @param bool $localize
 360    *
 361    * @return array
 362    */
 363   public static function indices($localize = TRUE) {
 364     $indices = [];
 365     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 366   }
 367
 368 }