5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Batch/EntityBatch.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:aaeb317f89d831d683f53e7c45e1b175)
13 * Database access object for the EntityBatch entity.
15 class CRM_Batch_DAO_EntityBatch
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '3.3';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_entity_batch';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = FALSE;
41 * physical tablename for entity being joined to file, e.g. civicrm_contact
48 * FK to entity table specified in entity_table column.
64 public function __construct() {
65 $this->__table
= 'civicrm_entity_batch';
66 parent
::__construct();
70 * Returns localized title of this entity.
73 * Whether to return the plural version of the title.
75 public static function getEntityTitle($plural = FALSE) {
76 return $plural ?
ts('Entity Batches') : ts('Entity Batch');
80 * Returns foreign keys and entity references.
83 * [CRM_Core_Reference_Interface]
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']);
92 return Civi
::$statics[__CLASS__
]['links'];
96 * Returns all the column names of this table
100 public static function &fields() {
101 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
102 Civi
::$statics[__CLASS__
]['fields'] = [
105 'type' => CRM_Utils_Type
::T_INT
,
106 'title' => ts('EntityBatch ID'),
107 'description' => ts('primary key'),
109 'where' => 'civicrm_entity_batch.id',
110 'table_name' => 'civicrm_entity_batch',
111 'entity' => 'EntityBatch',
112 'bao' => 'CRM_Batch_BAO_EntityBatch',
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'),
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',
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.'),
136 'where' => 'civicrm_entity_batch.entity_id',
137 'table_name' => 'civicrm_entity_batch',
138 'entity' => 'EntityBatch',
139 'bao' => 'CRM_Batch_BAO_EntityBatch',
144 'name' => 'batch_id',
145 'type' => CRM_Utils_Type
::T_INT
,
146 'title' => ts('Batch ID'),
147 'description' => ts('FK to civicrm_batch'),
149 'where' => 'civicrm_entity_batch.batch_id',
150 'table_name' => 'civicrm_entity_batch',
151 'entity' => 'EntityBatch',
152 'bao' => 'CRM_Batch_BAO_EntityBatch',
154 'FKClassName' => 'CRM_Batch_DAO_Batch',
155 'pseudoconstant' => [
156 'table' => 'civicrm_batch',
158 'labelColumn' => 'title',
163 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
165 return Civi
::$statics[__CLASS__
]['fields'];
169 * Return a mapping from field-name to the corresponding key (as used in fields()).
172 * Array(string $name => string $uniqueName).
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()));
178 return Civi
::$statics[__CLASS__
]['fieldKeys'];
182 * Returns the names of this table
186 public static function getTableName() {
187 return self
::$_tableName;
191 * Returns if this table needs to be logged
195 public function getLog() {
200 * Returns the list of fields that can be imported
202 * @param bool $prefix
206 public static function &import($prefix = FALSE) {
207 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'entity_batch', $prefix, []);
212 * Returns the list of fields that can be exported
214 * @param bool $prefix
218 public static function &export($prefix = FALSE) {
219 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'entity_batch', $prefix, []);
224 * Returns the list of indices
226 * @param bool $localize
230 public static function indices($localize = TRUE) {
233 'name' => 'index_entity',
238 'localizable' => FALSE,
239 'sig' => 'civicrm_entity_batch::0::entity_table::entity_id',
241 'UI_batch_entity' => [
242 'name' => 'UI_batch_entity',
248 'localizable' => FALSE,
250 'sig' => 'civicrm_entity_batch::1::batch_id::entity_id::entity_table',
253 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;