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 value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = false;
  51   /**
  52    *
  53    * @var int unsigned
  54    */
  55   public $id;
  56   /**
  57    * Name of the queue which includes this item
  58    *
  59    * @var string
  60    */
  61   public $queue_name;
  62   /**
  63    *
  64    * @var int
  65    */
  66   public $weight;
  67   /**
  68    * date on which this item was submitted to the queue
  69    *
  70    * @var datetime
  71    */
  72   public $submit_time;
  73   /**
  74    * date on which this job becomes available; null if ASAP
  75    *
  76    * @var datetime
  77    */
  78   public $release_time;
  79   /**
  80    * Serialized queue
  81    *
  82    * @var text
  83    */
  84   public $data;
  85   /**
  86    * class constructor
  87    *
  88    * @return civicrm_queue_item
  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         ) ,
 108         'queue_name' => array(
 109           'name' => 'queue_name',
 110           'type' => CRM_Utils_Type::T_STRING,
 111           'title' => ts('Queue Name') ,
 112           'description' => 'Name of the queue which includes this item',
 113           'required' => true,
 114           'maxlength' => 64,
 115           'size' => CRM_Utils_Type::BIG,
 116           'html' => array(
 117             'type' => 'Text',
 118           ) ,
 119         ) ,
 120         'weight' => array(
 121           'name' => 'weight',
 122           'type' => CRM_Utils_Type::T_INT,
 123           'title' => ts('Order') ,
 124           'required' => true,
 125           'html' => array(
 126             'type' => 'Text',
 127           ) ,
 128         ) ,
 129         'submit_time' => array(
 130           'name' => 'submit_time',
 131           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 132           'title' => ts('Submit Time') ,
 133           'description' => 'date on which this item was submitted to the queue',
 134           'required' => true,
 135           'html' => array(
 136             'type' => 'Select Date',
 137           ) ,
 138         ) ,
 139         'release_time' => array(
 140           'name' => 'release_time',
 141           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 142           'title' => ts('Release Time') ,
 143           'description' => 'date on which this job becomes available; null if ASAP',
 144           'html' => array(
 145             'type' => 'Select Date',
 146           ) ,
 147         ) ,
 148         'data' => array(
 149           'name' => 'data',
 150           'type' => CRM_Utils_Type::T_TEXT,
 151           'title' => ts('Queue item datas') ,
 152           'description' => 'Serialized queue',
 153         ) ,
 154       );
 155       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 156     }
 157     return Civi::$statics[__CLASS__]['fields'];
 158   }
 159   /**
 160    * Return a mapping from field-name to the corresponding key (as used in fields()).
 161    *
 162    * @return array
 163    *   Array(string $name => string $uniqueName).
 164    */
 165   static function &fieldKeys() {
 166     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 167       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 168     }
 169     return Civi::$statics[__CLASS__]['fieldKeys'];
 170   }
 171   /**
 172    * Returns the names of this table
 173    *
 174    * @return string
 175    */
 176   static function getTableName() {
 177     return self::$_tableName;
 178   }
 179   /**
 180    * Returns if this table needs to be logged
 181    *
 182    * @return boolean
 183    */
 184   function getLog() {
 185     return self::$_log;
 186   }
 187   /**
 188    * Returns the list of fields that can be imported
 189    *
 190    * @param bool $prefix
 191    *
 192    * @return array
 193    */
 194   static function &import($prefix = false) {
 195     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'queue_item', $prefix, array());
 196     return $r;
 197   }
 198   /**
 199    * Returns the list of fields that can be exported
 200    *
 201    * @param bool $prefix
 202    *
 203    * @return array
 204    */
 205   static function &export($prefix = false) {
 206     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'queue_item', $prefix, array());
 207     return $r;
 208   }
 209 }