CRM/Event/Cart/DAO/Cart.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/Event/Cart/Cart.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:fd3bfb8e04f5a5101f38d928b1d056cb)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Event_Cart_DAO_Cart constructor.
  39  */
  40 class CRM_Event_Cart_DAO_Cart extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_event_carts';
  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    * Cart Id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * FK to civicrm_contact who created this cart
  61    *
  62    * @var int unsigned
  63    */
  64   public $user_id;
  65   /**
  66    *
  67    * @var boolean
  68    */
  69   public $completed;
  70   /**
  71    * Class constructor.
  72    */
  73   function __construct() {
  74     $this->__table = 'civicrm_event_carts';
  75     parent::__construct();
  76   }
  77   /**
  78    * Returns foreign keys and entity references.
  79    *
  80    * @return array
  81    *   [CRM_Core_Reference_Interface]
  82    */
  83   static function getReferenceColumns() {
  84     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  85       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  86       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'user_id', 'civicrm_contact', 'id');
  87       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  88     }
  89     return Civi::$statics[__CLASS__]['links'];
  90   }
  91   /**
  92    * Returns all the column names of this table
  93    *
  94    * @return array
  95    */
  96   static function &fields() {
  97     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  98       Civi::$statics[__CLASS__]['fields'] = array(
  99         'cart_id' => array(
 100           'name' => 'id',
 101           'type' => CRM_Utils_Type::T_INT,
 102           'title' => ts('Cart ID') ,
 103           'description' => 'Cart Id',
 104           'required' => true,
 105           'table_name' => 'civicrm_event_carts',
 106           'entity' => 'Cart',
 107           'bao' => 'CRM_Event_Cart_BAO_Cart',
 108           'localizable' => 0,
 109         ) ,
 110         'user_id' => array(
 111           'name' => 'user_id',
 112           'type' => CRM_Utils_Type::T_INT,
 113           'title' => ts('Created By') ,
 114           'description' => 'FK to civicrm_contact who created this cart',
 115           'table_name' => 'civicrm_event_carts',
 116           'entity' => 'Cart',
 117           'bao' => 'CRM_Event_Cart_BAO_Cart',
 118           'localizable' => 0,
 119           'FKClassName' => 'CRM_Contact_DAO_Contact',
 120         ) ,
 121         'completed' => array(
 122           'name' => 'completed',
 123           'type' => CRM_Utils_Type::T_BOOLEAN,
 124           'title' => ts('Complete?') ,
 125           'table_name' => 'civicrm_event_carts',
 126           'entity' => 'Cart',
 127           'bao' => 'CRM_Event_Cart_BAO_Cart',
 128           'localizable' => 0,
 129         ) ,
 130       );
 131       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 132     }
 133     return Civi::$statics[__CLASS__]['fields'];
 134   }
 135   /**
 136    * Return a mapping from field-name to the corresponding key (as used in fields()).
 137    *
 138    * @return array
 139    *   Array(string $name => string $uniqueName).
 140    */
 141   static function &fieldKeys() {
 142     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 143       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 144     }
 145     return Civi::$statics[__CLASS__]['fieldKeys'];
 146   }
 147   /**
 148    * Returns the names of this table
 149    *
 150    * @return string
 151    */
 152   static function getTableName() {
 153     return self::$_tableName;
 154   }
 155   /**
 156    * Returns if this table needs to be logged
 157    *
 158    * @return boolean
 159    */
 160   function getLog() {
 161     return self::$_log;
 162   }
 163   /**
 164    * Returns the list of fields that can be imported
 165    *
 166    * @param bool $prefix
 167    *
 168    * @return array
 169    */
 170   static function &import($prefix = false) {
 171     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'event_carts', $prefix, array());
 172     return $r;
 173   }
 174   /**
 175    * Returns the list of fields that can be exported
 176    *
 177    * @param bool $prefix
 178    *
 179    * @return array
 180    */
 181   static function &export($prefix = false) {
 182     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'event_carts', $prefix, array());
 183     return $r;
 184   }
 185 }