3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2017
32 * Generated from {$table.sourceFile}
34 * (GenCodeChecksum:{$genCodeChecksum})
37 require_once 'CRM/Core/DAO.php';
38 require_once 'CRM/Utils/Type.php';
41 * {$table.className} constructor.
43 class {$table.className} extends CRM_Core_DAO {ldelim}
46 * Static instance to hold the table name.
50 static $_tableName = '{$table.name}';
53 * Should CiviCRM log any modifications to this table in the civicrm_log table.
57 static $_log = {$table.log};
59 {foreach from=$table.fields item=field}
65 * @var {$field.phpType}
67 public ${$field.name};
69 {/foreach} {* table.fields *}
74 function __construct( ) {ldelim}
75 $this->__table = '{$table.name}';
77 parent::__construct( );
80 {if $table.foreignKey || $table.dynamicForeignKey}
82 * Returns foreign keys and entity references.
85 * [CRM_Core_Reference_Interface]
87 static function getReferenceColumns() {ldelim}
88 if (!isset(Civi::$statics[__CLASS__]['links'])) {ldelim}
89 Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
90 {foreach from=$table.foreignKey item=foreign}
91 Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), '{$foreign.name}', '{$foreign.table}', '{$foreign.key}');
94 {foreach from=$table.dynamicForeignKey item=foreign}
95 Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), '{$foreign.idColumn}', NULL, '{$foreign.key|default:'id'}', '{$foreign.typeColumn}');
97 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
99 return Civi::$statics[__CLASS__]['links'];
101 {/if} {* table.foreignKey *}
104 * Returns all the column names of this table
108 static function &fields( ) {ldelim}
109 if ( ! isset(Civi::$statics[__CLASS__]['fields']) ) {ldelim}
110 Civi::$statics[__CLASS__]['fields'] = array (
111 {foreach from=$table.fields item=field}
113 {if $field.uniqueName}
114 '{$field.uniqueName}'
119 'name' => '{$field.name}',
120 'type' => {$field.crmType},
122 'title' => ts('{$field.title}'),
125 'description' => '{$field.comment|replace:"'":"\'"}',
128 'required' => {$field.required},
129 {/if} {* field.required *}
131 'maxlength' => {$field.length},
132 {/if} {* field.length *}
133 {if $field.precision}
134 'precision' => array({$field.precision}),
137 'size' => {$field.size},
138 {/if} {* field.size *}
140 'rows' => {$field.rows},
141 {/if} {* field.rows *}
143 'cols' => {$field.cols},
144 {/if} {* field.cols *}
147 'import' => {$field.import},
148 'where' => '{$table.name}.{$field.name}',
149 'headerPattern' => '{$field.headerPattern}',
150 'dataPattern' => '{$field.dataPattern}',
151 {/if} {* field.import *}
153 'export' => {$field.export},
155 'where' => '{$table.name}.{$field.name}',
156 'headerPattern' => '{$field.headerPattern}',
157 'dataPattern' => '{$field.dataPattern}',
159 {/if} {* field.export *}
161 'rule' => '{$field.rule}',
162 {/if} {* field.rule *}
164 'default' => '{if ($field.default[0]=="'" or $field.default[0]=='"')}{$field.default|substring:1:-1}{else}{$field.default}{/if}',
165 {/if} {* field.default *}
166 'table_name' => '{$table.name}',
167 'entity' => '{$table.entity}',
168 'bao' => '{$table.bao}',
169 'localizable' => {if ($field.localizable)}{1}{else}{0}{/if},
171 {if $field.FKClassName}
172 'FKClassName' => '{$field.FKClassName}',
173 {/if} {* field.FKClassName *}
175 {assign var=htmlOptions value=$field.html}
177 {*{$htmlOptions|@print_array}*}
178 {foreach from=$htmlOptions key=optionKey item=optionValue}
179 '{$optionKey}' => '{$optionValue}',
182 {/if} {* field.html *}
183 {if $field.pseudoconstant}
184 {assign var=pseudoOptions value=$field.pseudoconstant}
185 'pseudoconstant' => array(
186 {*{$pseudoOptions|@print_array}*}
187 {foreach from=$pseudoOptions key=optionKey item=optionValue}
188 '{$optionKey}' => '{$optionValue}',
191 {/if} {* field.pseudoconstant *} ),
192 {/foreach} {* table.fields *}
194 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
196 return Civi::$statics[__CLASS__]['fields'];
200 * Return a mapping from field-name to the corresponding key (as used in fields()).
203 * Array(string $name => string $uniqueName).
205 static function &fieldKeys( ) {ldelim}
206 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {ldelim}
207 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
209 return Civi::$statics[__CLASS__]['fieldKeys'];
213 * Returns the names of this table
217 static function getTableName( ) {ldelim}
218 {if $table.localizable}
219 return CRM_Core_DAO::getLocaleTableName( self::$_tableName );
221 return self::$_tableName;
226 * Returns if this table needs to be logged
230 function getLog( ) {ldelim}
235 * Returns the list of fields that can be imported
237 * @param bool $prefix
241 static function &import( $prefix = false ) {ldelim}
242 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, '{$table.labelName}', $prefix, array(
243 {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
244 {if $foreign.import}'{$foreign.className}',{/if}
251 * Returns the list of fields that can be exported
253 * @param bool $prefix
257 static function &export( $prefix = false ) {ldelim}
258 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, '{$table.labelName}', $prefix, array(
259 {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
260 {if $foreign.export}'{$foreign.className}',{/if}
267 * Returns the list of indices
269 public static function indices($localize = TRUE) {ldelim}
270 $indices = {$indicesPhp};
271 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;