3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2015
31 * Generated from xml/schema/CRM/Batch/EntityBatch.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
34 require_once 'CRM/Core/DAO.php';
35 require_once 'CRM/Utils/Type.php';
36 class CRM_Batch_DAO_EntityBatch
extends CRM_Core_DAO
{
38 * static instance to hold the table name
42 static $_tableName = 'civicrm_entity_batch';
44 * static instance to hold the field values
48 static $_fields = null;
50 * static instance to hold the keys used in $_fields for each field.
54 static $_fieldKeys = null;
56 * static instance to hold the FK relationships
60 static $_links = null;
62 * static instance to hold the values that can
67 static $_import = null;
69 * static instance to hold the values that can
74 static $_export = null;
76 * static value to see if we should log any modifications to
77 * this table in the civicrm_log table
89 * physical tablename for entity being joined to file, e.g. civicrm_contact
95 * FK to entity table specified in entity_table column.
101 * FK to civicrm_batch
109 * @return civicrm_entity_batch
111 function __construct() {
112 $this->__table
= 'civicrm_entity_batch';
113 parent
::__construct();
116 * Returns foreign keys and entity references
119 * [CRM_Core_Reference_Interface]
121 static function getReferenceColumns() {
122 if (!self
::$_links) {
123 self
::$_links = static ::createReferenceColumns(__CLASS__
);
124 self
::$_links[] = new CRM_Core_Reference_Basic(self
::getTableName() , 'batch_id', 'civicrm_batch', 'id');
125 self
::$_links[] = new CRM_Core_Reference_Dynamic(self
::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
127 return self
::$_links;
130 * Returns all the column names of this table
134 static function &fields() {
135 if (!(self
::$_fields)) {
136 self
::$_fields = array(
139 'type' => CRM_Utils_Type
::T_INT
,
140 'description' => 'primary key',
143 'entity_table' => array(
144 'name' => 'entity_table',
145 'type' => CRM_Utils_Type
::T_STRING
,
146 'title' => ts('Entity Table') ,
147 'description' => 'physical tablename for entity being joined to file, e.g. civicrm_contact',
149 'size' => CRM_Utils_Type
::BIG
,
151 'entity_id' => array(
152 'name' => 'entity_id',
153 'type' => CRM_Utils_Type
::T_INT
,
154 'description' => 'FK to entity table specified in entity_table column.',
158 'name' => 'batch_id',
159 'type' => CRM_Utils_Type
::T_INT
,
160 'description' => 'FK to civicrm_batch',
162 'FKClassName' => 'CRM_Batch_DAO_Batch',
166 return self
::$_fields;
169 * Returns an array containing, for each field, the arary key used for that
170 * field in self::$_fields.
174 static function &fieldKeys() {
175 if (!(self
::$_fieldKeys)) {
176 self
::$_fieldKeys = array(
178 'entity_table' => 'entity_table',
179 'entity_id' => 'entity_id',
180 'batch_id' => 'batch_id',
183 return self
::$_fieldKeys;
186 * Returns the names of this table
190 static function getTableName() {
191 return self
::$_tableName;
194 * Returns if this table needs to be logged
202 * Returns the list of fields that can be imported
204 * @param bool $prefix
208 static function &import($prefix = false) {
209 if (!(self
::$_import)) {
210 self
::$_import = array();
211 $fields = self
::fields();
212 foreach($fields as $name => $field) {
213 if (CRM_Utils_Array
::value('import', $field)) {
215 self
::$_import['entity_batch'] = & $fields[$name];
217 self
::$_import[$name] = & $fields[$name];
222 return self
::$_import;
225 * Returns the list of fields that can be exported
227 * @param bool $prefix
231 static function &export($prefix = false) {
232 if (!(self
::$_export)) {
233 self
::$_export = array();
234 $fields = self
::fields();
235 foreach($fields as $name => $field) {
236 if (CRM_Utils_Array
::value('export', $field)) {
238 self
::$_export['entity_batch'] = & $fields[$name];
240 self
::$_export[$name] = & $fields[$name];
245 return self
::$_export;