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:a7927e0d742d5a5600ffe80c75d90bf6)
  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           'localizable' => 0,
 111         ) ,
 112         'queue_name' => array(
 113           'name' => 'queue_name',
 114           'type' => CRM_Utils_Type::T_STRING,
 115           'title' => ts('Queue Name') ,
 116           'description' => 'Name of the queue which includes this item',
 117           'required' => true,
 118           'maxlength' => 64,
 119           'size' => CRM_Utils_Type::BIG,
 120           'table_name' => 'civicrm_queue_item',
 121           'entity' => 'QueueItem',
 122           'bao' => 'CRM_Queue_BAO_QueueItem',
 123           'localizable' => 0,
 124           'html' => array(
 125             'type' => 'Text',
 126           ) ,
 127         ) ,
 128         'weight' => array(
 129           'name' => 'weight',
 130           'type' => CRM_Utils_Type::T_INT,
 131           'title' => ts('Order') ,
 132           'required' => true,
 133           'table_name' => 'civicrm_queue_item',
 134           'entity' => 'QueueItem',
 135           'bao' => 'CRM_Queue_BAO_QueueItem',
 136           'localizable' => 0,
 137           'html' => array(
 138             'type' => 'Text',
 139           ) ,
 140         ) ,
 141         'submit_time' => array(
 142           'name' => 'submit_time',
 143           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 144           'title' => ts('Submit Time') ,
 145           'description' => 'date on which this item was submitted to the queue',
 146           'required' => true,
 147           'table_name' => 'civicrm_queue_item',
 148           'entity' => 'QueueItem',
 149           'bao' => 'CRM_Queue_BAO_QueueItem',
 150           'localizable' => 0,
 151           'html' => array(
 152             'type' => 'Select Date',
 153           ) ,
 154         ) ,
 155         'release_time' => array(
 156           'name' => 'release_time',
 157           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 158           'title' => ts('Release Time') ,
 159           'description' => 'date on which this job becomes available; null if ASAP',
 160           'table_name' => 'civicrm_queue_item',
 161           'entity' => 'QueueItem',
 162           'bao' => 'CRM_Queue_BAO_QueueItem',
 163           'localizable' => 0,
 164           'html' => array(
 165             'type' => 'Select Date',
 166           ) ,
 167         ) ,
 168         'data' => array(
 169           'name' => 'data',
 170           'type' => CRM_Utils_Type::T_TEXT,
 171           'title' => ts('Queue item datas') ,
 172           'description' => 'Serialized queue',
 173           'table_name' => 'civicrm_queue_item',
 174           'entity' => 'QueueItem',
 175           'bao' => 'CRM_Queue_BAO_QueueItem',
 176           'localizable' => 0,
 177         ) ,
 178       );
 179       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 180     }
 181     return Civi::$statics[__CLASS__]['fields'];
 182   }
 183   /**
 184    * Return a mapping from field-name to the corresponding key (as used in fields()).
 185    *
 186    * @return array
 187    *   Array(string $name => string $uniqueName).
 188    */
 189   static function &fieldKeys() {
 190     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 191       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 192     }
 193     return Civi::$statics[__CLASS__]['fieldKeys'];
 194   }
 195   /**
 196    * Returns the names of this table
 197    *
 198    * @return string
 199    */
 200   static function getTableName() {
 201     return self::$_tableName;
 202   }
 203   /**
 204    * Returns if this table needs to be logged
 205    *
 206    * @return boolean
 207    */
 208   function getLog() {
 209     return self::$_log;
 210   }
 211   /**
 212    * Returns the list of fields that can be imported
 213    *
 214    * @param bool $prefix
 215    *
 216    * @return array
 217    */
 218   static function &import($prefix = false) {
 219     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'queue_item', $prefix, array());
 220     return $r;
 221   }
 222   /**
 223    * Returns the list of fields that can be exported
 224    *
 225    * @param bool $prefix
 226    *
 227    * @return array
 228    */
 229   static function &export($prefix = false) {
 230     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'queue_item', $prefix, array());
 231     return $r;
 232   }
 233 }