CRM/Queue/DAO/QueueItem.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  30  *
  31  * Generated from xml/schema/CRM/Queue/QueueItem.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:45218486c40b902ee5e043e22b1a7d20)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Queue_DAO_QueueItem extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_queue_item';
  44   /**
  45    * static instance to hold the field values
  46    *
  47    * @var array
  48    */
  49   static $_fields = null;
  50   /**
  51    * static instance to hold the keys used in $_fields for each field.
  52    *
  53    * @var array
  54    */
  55   static $_fieldKeys = null;
  56   /**
  57    * static instance to hold the FK relationships
  58    *
  59    * @var string
  60    */
  61   static $_links = null;
  62   /**
  63    * static value to see if we should log any modifications to
  64    * this table in the civicrm_log table
  65    *
  66    * @var boolean
  67    */
  68   static $_log = false;
  69   /**
  70    *
  71    * @var int unsigned
  72    */
  73   public $id;
  74   /**
  75    * Name of the queue which includes this item
  76    *
  77    * @var string
  78    */
  79   public $queue_name;
  80   /**
  81    *
  82    * @var int
  83    */
  84   public $weight;
  85   /**
  86    * date on which this item was submitted to the queue
  87    *
  88    * @var datetime
  89    */
  90   public $submit_time;
  91   /**
  92    * date on which this job becomes available; null if ASAP
  93    *
  94    * @var datetime
  95    */
  96   public $release_time;
  97   /**
  98    * Serialized queue
  99    *
 100    * @var text
 101    */
 102   public $data;
 103   /**
 104    * class constructor
 105    *
 106    * @return civicrm_queue_item
 107    */
 108   function __construct() {
 109     $this->__table = 'civicrm_queue_item';
 110     parent::__construct();
 111   }
 112   /**
 113    * Returns all the column names of this table
 114    *
 115    * @return array
 116    */
 117   static function &fields() {
 118     if (!(self::$_fields)) {
 119       self::$_fields = array(
 120         'id' => array(
 121           'name' => 'id',
 122           'type' => CRM_Utils_Type::T_INT,
 123           'title' => ts('Queue ID') ,
 124           'required' => true,
 125         ) ,
 126         'queue_name' => array(
 127           'name' => 'queue_name',
 128           'type' => CRM_Utils_Type::T_STRING,
 129           'title' => ts('Queue Name') ,
 130           'description' => 'Name of the queue which includes this item',
 131           'required' => true,
 132           'maxlength' => 64,
 133           'size' => CRM_Utils_Type::BIG,
 134           'html' => array(
 135             'type' => 'Text',
 136           ) ,
 137         ) ,
 138         'weight' => array(
 139           'name' => 'weight',
 140           'type' => CRM_Utils_Type::T_INT,
 141           'title' => ts('Order') ,
 142           'required' => true,
 143           'html' => array(
 144             'type' => 'Text',
 145           ) ,
 146         ) ,
 147         'submit_time' => array(
 148           'name' => 'submit_time',
 149           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 150           'title' => ts('Submit Time') ,
 151           'description' => 'date on which this item was submitted to the queue',
 152           'required' => true,
 153           'html' => array(
 154             'type' => 'Select Date',
 155           ) ,
 156         ) ,
 157         'release_time' => array(
 158           'name' => 'release_time',
 159           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 160           'title' => ts('Release Time') ,
 161           'description' => 'date on which this job becomes available; null if ASAP',
 162           'html' => array(
 163             'type' => 'Select Date',
 164           ) ,
 165         ) ,
 166         'data' => array(
 167           'name' => 'data',
 168           'type' => CRM_Utils_Type::T_TEXT,
 169           'title' => ts('Queue item datas') ,
 170           'description' => 'Serialized queue',
 171         ) ,
 172       );
 173     }
 174     return self::$_fields;
 175   }
 176   /**
 177    * Returns an array containing, for each field, the arary key used for that
 178    * field in self::$_fields.
 179    *
 180    * @return array
 181    */
 182   static function &fieldKeys() {
 183     if (!(self::$_fieldKeys)) {
 184       self::$_fieldKeys = array(
 185         'id' => 'id',
 186         'queue_name' => 'queue_name',
 187         'weight' => 'weight',
 188         'submit_time' => 'submit_time',
 189         'release_time' => 'release_time',
 190         'data' => 'data',
 191       );
 192     }
 193     return self::$_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 }