CRM/Batch/DAO/EntityBatch.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Batch/EntityBatch.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:aaeb317f89d831d683f53e7c45e1b175)
  10  */
  11
  12 /**
  13  * Database access object for the EntityBatch entity.
  14  */
  15 class CRM_Batch_DAO_EntityBatch extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '3.3';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_entity_batch';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = FALSE;
  32
  33   /**
  34    * primary key
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * physical tablename for entity being joined to file, e.g. civicrm_contact
  42    *
  43    * @var string
  44    */
  45   public $entity_table;
  46
  47   /**
  48    * FK to entity table specified in entity_table column.
  49    *
  50    * @var int
  51    */
  52   public $entity_id;
  53
  54   /**
  55    * FK to civicrm_batch
  56    *
  57    * @var int
  58    */
  59   public $batch_id;
  60
  61   /**
  62    * Class constructor.
  63    */
  64   public function __construct() {
  65     $this->__table = 'civicrm_entity_batch';
  66     parent::__construct();
  67   }
  68
  69   /**
  70    * Returns localized title of this entity.
  71    *
  72    * @param bool $plural
  73    *   Whether to return the plural version of the title.
  74    */
  75   public static function getEntityTitle($plural = FALSE) {
  76     return $plural ? ts('Entity Batches') : ts('Entity Batch');
  77   }
  78
  79   /**
  80    * Returns foreign keys and entity references.
  81    *
  82    * @return array
  83    *   [CRM_Core_Reference_Interface]
  84    */
  85   public static function getReferenceColumns() {
  86     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  87       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  88       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'batch_id', 'civicrm_batch', 'id');
  89       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
  90       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  91     }
  92     return Civi::$statics[__CLASS__]['links'];
  93   }
  94
  95   /**
  96    * Returns all the column names of this table
  97    *
  98    * @return array
  99    */
 100   public static function &fields() {
 101     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 102       Civi::$statics[__CLASS__]['fields'] = [
 103         'id' => [
 104           'name' => 'id',
 105           'type' => CRM_Utils_Type::T_INT,
 106           'title' => ts('EntityBatch ID'),
 107           'description' => ts('primary key'),
 108           'required' => TRUE,
 109           'where' => 'civicrm_entity_batch.id',
 110           'table_name' => 'civicrm_entity_batch',
 111           'entity' => 'EntityBatch',
 112           'bao' => 'CRM_Batch_BAO_EntityBatch',
 113           'localizable' => 0,
 114           'add' => '3.3',
 115         ],
 116         'entity_table' => [
 117           'name' => 'entity_table',
 118           'type' => CRM_Utils_Type::T_STRING,
 119           'title' => ts('EntityBatch Table'),
 120           'description' => ts('physical tablename for entity being joined to file, e.g. civicrm_contact'),
 121           'maxlength' => 64,
 122           'size' => CRM_Utils_Type::BIG,
 123           'where' => 'civicrm_entity_batch.entity_table',
 124           'table_name' => 'civicrm_entity_batch',
 125           'entity' => 'EntityBatch',
 126           'bao' => 'CRM_Batch_BAO_EntityBatch',
 127           'localizable' => 0,
 128           'add' => '3.3',
 129         ],
 130         'entity_id' => [
 131           'name' => 'entity_id',
 132           'type' => CRM_Utils_Type::T_INT,
 133           'title' => ts('Entity ID'),
 134           'description' => ts('FK to entity table specified in entity_table column.'),
 135           'required' => TRUE,
 136           'where' => 'civicrm_entity_batch.entity_id',
 137           'table_name' => 'civicrm_entity_batch',
 138           'entity' => 'EntityBatch',
 139           'bao' => 'CRM_Batch_BAO_EntityBatch',
 140           'localizable' => 0,
 141           'add' => '3.3',
 142         ],
 143         'batch_id' => [
 144           'name' => 'batch_id',
 145           'type' => CRM_Utils_Type::T_INT,
 146           'title' => ts('Batch ID'),
 147           'description' => ts('FK to civicrm_batch'),
 148           'required' => TRUE,
 149           'where' => 'civicrm_entity_batch.batch_id',
 150           'table_name' => 'civicrm_entity_batch',
 151           'entity' => 'EntityBatch',
 152           'bao' => 'CRM_Batch_BAO_EntityBatch',
 153           'localizable' => 0,
 154           'FKClassName' => 'CRM_Batch_DAO_Batch',
 155           'pseudoconstant' => [
 156             'table' => 'civicrm_batch',
 157             'keyColumn' => 'id',
 158             'labelColumn' => 'title',
 159           ],
 160           'add' => '3.3',
 161         ],
 162       ];
 163       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 164     }
 165     return Civi::$statics[__CLASS__]['fields'];
 166   }
 167
 168   /**
 169    * Return a mapping from field-name to the corresponding key (as used in fields()).
 170    *
 171    * @return array
 172    *   Array(string $name => string $uniqueName).
 173    */
 174   public static function &fieldKeys() {
 175     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 176       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 177     }
 178     return Civi::$statics[__CLASS__]['fieldKeys'];
 179   }
 180
 181   /**
 182    * Returns the names of this table
 183    *
 184    * @return string
 185    */
 186   public static function getTableName() {
 187     return self::$_tableName;
 188   }
 189
 190   /**
 191    * Returns if this table needs to be logged
 192    *
 193    * @return bool
 194    */
 195   public function getLog() {
 196     return self::$_log;
 197   }
 198
 199   /**
 200    * Returns the list of fields that can be imported
 201    *
 202    * @param bool $prefix
 203    *
 204    * @return array
 205    */
 206   public static function &import($prefix = FALSE) {
 207     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_batch', $prefix, []);
 208     return $r;
 209   }
 210
 211   /**
 212    * Returns the list of fields that can be exported
 213    *
 214    * @param bool $prefix
 215    *
 216    * @return array
 217    */
 218   public static function &export($prefix = FALSE) {
 219     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_batch', $prefix, []);
 220     return $r;
 221   }
 222
 223   /**
 224    * Returns the list of indices
 225    *
 226    * @param bool $localize
 227    *
 228    * @return array
 229    */
 230   public static function indices($localize = TRUE) {
 231     $indices = [
 232       'index_entity' => [
 233         'name' => 'index_entity',
 234         'field' => [
 235           0 => 'entity_table',
 236           1 => 'entity_id',
 237         ],
 238         'localizable' => FALSE,
 239         'sig' => 'civicrm_entity_batch::0::entity_table::entity_id',
 240       ],
 241       'UI_batch_entity' => [
 242         'name' => 'UI_batch_entity',
 243         'field' => [
 244           0 => 'batch_id',
 245           1 => 'entity_id',
 246           2 => 'entity_table',
 247         ],
 248         'localizable' => FALSE,
 249         'unique' => TRUE,
 250         'sig' => 'civicrm_entity_batch::1::batch_id::entity_id::entity_table',
 251       ],
 252     ];
 253     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 254   }
 255
 256 }