CRM/Batch/DAO/EntityBatch.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/Batch/EntityBatch.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:db880689cbebab222e9decece8487c1d)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Batch_DAO_EntityBatch constructor.
  39  */
  40 class CRM_Batch_DAO_EntityBatch extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_entity_batch';
  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    * primary key
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * physical tablename for entity being joined to file, e.g. civicrm_contact
  61    *
  62    * @var string
  63    */
  64   public $entity_table;
  65   /**
  66    * FK to entity table specified in entity_table column.
  67    *
  68    * @var int unsigned
  69    */
  70   public $entity_id;
  71   /**
  72    * FK to civicrm_batch
  73    *
  74    * @var int unsigned
  75    */
  76   public $batch_id;
  77   /**
  78    * Class constructor.
  79    */
  80   function __construct() {
  81     $this->__table = 'civicrm_entity_batch';
  82     parent::__construct();
  83   }
  84   /**
  85    * Returns foreign keys and entity references.
  86    *
  87    * @return array
  88    *   [CRM_Core_Reference_Interface]
  89    */
  90   static function getReferenceColumns() {
  91     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  92       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  93       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'batch_id', 'civicrm_batch', 'id');
  94       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
  95       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  96     }
  97     return Civi::$statics[__CLASS__]['links'];
  98   }
  99   /**
 100    * Returns all the column names of this table
 101    *
 102    * @return array
 103    */
 104   static function &fields() {
 105     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 106       Civi::$statics[__CLASS__]['fields'] = array(
 107         'id' => array(
 108           'name' => 'id',
 109           'type' => CRM_Utils_Type::T_INT,
 110           'title' => ts('EntityBatch ID') ,
 111           'description' => 'primary key',
 112           'required' => true,
 113           'table_name' => 'civicrm_entity_batch',
 114           'entity' => 'EntityBatch',
 115           'bao' => 'CRM_Batch_BAO_EntityBatch',
 116         ) ,
 117         'entity_table' => array(
 118           'name' => 'entity_table',
 119           'type' => CRM_Utils_Type::T_STRING,
 120           'title' => ts('EntityBatch Table') ,
 121           'description' => 'physical tablename for entity being joined to file, e.g. civicrm_contact',
 122           'maxlength' => 64,
 123           'size' => CRM_Utils_Type::BIG,
 124           'table_name' => 'civicrm_entity_batch',
 125           'entity' => 'EntityBatch',
 126           'bao' => 'CRM_Batch_BAO_EntityBatch',
 127         ) ,
 128         'entity_id' => array(
 129           'name' => 'entity_id',
 130           'type' => CRM_Utils_Type::T_INT,
 131           'title' => ts('Entity ID') ,
 132           'description' => 'FK to entity table specified in entity_table column.',
 133           'required' => true,
 134           'table_name' => 'civicrm_entity_batch',
 135           'entity' => 'EntityBatch',
 136           'bao' => 'CRM_Batch_BAO_EntityBatch',
 137         ) ,
 138         'batch_id' => array(
 139           'name' => 'batch_id',
 140           'type' => CRM_Utils_Type::T_INT,
 141           'title' => ts('Batch ID') ,
 142           'description' => 'FK to civicrm_batch',
 143           'required' => true,
 144           'table_name' => 'civicrm_entity_batch',
 145           'entity' => 'EntityBatch',
 146           'bao' => 'CRM_Batch_BAO_EntityBatch',
 147           'FKClassName' => 'CRM_Batch_DAO_Batch',
 148           'pseudoconstant' => array(
 149             'table' => 'civicrm_batch',
 150             'keyColumn' => 'id',
 151             'labelColumn' => 'title',
 152           )
 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__, 'entity_batch', $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__, 'entity_batch', $prefix, array());
 207     return $r;
 208   }
 209 }