CRM/Queue/DAO/QueueItem.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/Queue/QueueItem.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:29c70cc367a66f90eb5616927289949e)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Queue_DAO_QueueItem constructor.
  39  */
  40 class CRM_Queue_DAO_QueueItem extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_queue_item';
  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    *
  55    * @var int unsigned
  56    */
  57   public $id;
  58   /**
  59    * Name of the queue which includes this item
  60    *
  61    * @var string
  62    */
  63   public $queue_name;
  64   /**
  65    *
  66    * @var int
  67    */
  68   public $weight;
  69   /**
  70    * date on which this item was submitted to the queue
  71    *
  72    * @var datetime
  73    */
  74   public $submit_time;
  75   /**
  76    * date on which this job becomes available; null if ASAP
  77    *
  78    * @var datetime
  79    */
  80   public $release_time;
  81   /**
  82    * Serialized queue
  83    *
  84    * @var text
  85    */
  86   public $data;
  87   /**
  88    * Class constructor.
  89    */
  90   function __construct() {
  91     $this->__table = 'civicrm_queue_item';
  92     parent::__construct();
  93   }
  94   /**
  95    * Returns all the column names of this table
  96    *
  97    * @return array
  98    */
  99   static function &fields() {
 100     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 101       Civi::$statics[__CLASS__]['fields'] = array(
 102         'id' => array(
 103           'name' => 'id',
 104           'type' => CRM_Utils_Type::T_INT,
 105           'title' => ts('Queue ID') ,
 106           'required' => true,
 107           'table_name' => 'civicrm_queue_item',
 108           'entity' => 'QueueItem',
 109           'bao' => 'CRM_Queue_BAO_QueueItem',
 110         ) ,
 111         'queue_name' => array(
 112           'name' => 'queue_name',
 113           'type' => CRM_Utils_Type::T_STRING,
 114           'title' => ts('Queue Name') ,
 115           'description' => 'Name of the queue which includes this item',
 116           'required' => true,
 117           'maxlength' => 64,
 118           'size' => CRM_Utils_Type::BIG,
 119           'table_name' => 'civicrm_queue_item',
 120           'entity' => 'QueueItem',
 121           'bao' => 'CRM_Queue_BAO_QueueItem',
 122           'html' => array(
 123             'type' => 'Text',
 124           ) ,
 125         ) ,
 126         'weight' => array(
 127           'name' => 'weight',
 128           'type' => CRM_Utils_Type::T_INT,
 129           'title' => ts('Order') ,
 130           'required' => true,
 131           'table_name' => 'civicrm_queue_item',
 132           'entity' => 'QueueItem',
 133           'bao' => 'CRM_Queue_BAO_QueueItem',
 134           'html' => array(
 135             'type' => 'Text',
 136           ) ,
 137         ) ,
 138         'submit_time' => array(
 139           'name' => 'submit_time',
 140           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 141           'title' => ts('Submit Time') ,
 142           'description' => 'date on which this item was submitted to the queue',
 143           'required' => true,
 144           'table_name' => 'civicrm_queue_item',
 145           'entity' => 'QueueItem',
 146           'bao' => 'CRM_Queue_BAO_QueueItem',
 147           'html' => array(
 148             'type' => 'Select Date',
 149           ) ,
 150         ) ,
 151         'release_time' => array(
 152           'name' => 'release_time',
 153           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 154           'title' => ts('Release Time') ,
 155           'description' => 'date on which this job becomes available; null if ASAP',
 156           'table_name' => 'civicrm_queue_item',
 157           'entity' => 'QueueItem',
 158           'bao' => 'CRM_Queue_BAO_QueueItem',
 159           'html' => array(
 160             'type' => 'Select Date',
 161           ) ,
 162         ) ,
 163         'data' => array(
 164           'name' => 'data',
 165           'type' => CRM_Utils_Type::T_TEXT,
 166           'title' => ts('Queue item datas') ,
 167           'description' => 'Serialized queue',
 168           'table_name' => 'civicrm_queue_item',
 169           'entity' => 'QueueItem',
 170           'bao' => 'CRM_Queue_BAO_QueueItem',
 171         ) ,
 172       );
 173       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 174     }
 175     return Civi::$statics[__CLASS__]['fields'];
 176   }
 177   /**
 178    * Return a mapping from field-name to the corresponding key (as used in fields()).
 179    *
 180    * @return array
 181    *   Array(string $name => string $uniqueName).
 182    */
 183   static function &fieldKeys() {
 184     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 185       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 186     }
 187     return Civi::$statics[__CLASS__]['fieldKeys'];
 188   }
 189   /**
 190    * Returns the names of this table
 191    *
 192    * @return string
 193    */
 194   static function getTableName() {
 195     return self::$_tableName;
 196   }
 197   /**
 198    * Returns if this table needs to be logged
 199    *
 200    * @return boolean
 201    */
 202   function getLog() {
 203     return self::$_log;
 204   }
 205   /**
 206    * Returns the list of fields that can be imported
 207    *
 208    * @param bool $prefix
 209    *
 210    * @return array
 211    */
 212   static function &import($prefix = false) {
 213     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'queue_item', $prefix, array());
 214     return $r;
 215   }
 216   /**
 217    * Returns the list of fields that can be exported
 218    *
 219    * @param bool $prefix
 220    *
 221    * @return array
 222    */
 223   static function &export($prefix = false) {
 224     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'queue_item', $prefix, array());
 225     return $r;
 226   }
 227 }