3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
32 * Generated from {$table.sourceFile}
34 * (GenCodeChecksum:{$genCodeChecksum})
37 require_once 'CRM/Core/DAO.php';
38 require_once 'CRM/Utils/Type.php';
40 class {$table.className} extends CRM_Core_DAO {ldelim}
43 * static instance to hold the table name
47 static $_tableName = '{$table.name}';
50 * static value to see if we should log any modifications to
51 * this table in the civicrm_log table
55 static $_log = {$table.log};
57 {foreach from=$table.fields item=field}
63 * @var {$field.phpType}
65 public ${$field.name};
67 {/foreach} {* table.fields *}
72 * @return {$table.name}
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 *}
167 {if $field.FKClassName}
168 'FKClassName' => '{$field.FKClassName}',
169 {/if} {* field.FKClassName *}
171 {assign var=htmlOptions value=$field.html}
173 {*{$htmlOptions|@print_array}*}
174 {foreach from=$htmlOptions key=optionKey item=optionValue}
175 '{$optionKey}' => '{$optionValue}',
178 {/if} {* field.html *}
179 {if $field.pseudoconstant}
180 {assign var=pseudoOptions value=$field.pseudoconstant}
181 'pseudoconstant' => array(
182 {*{$pseudoOptions|@print_array}*}
183 {foreach from=$pseudoOptions key=optionKey item=optionValue}
184 '{$optionKey}' => '{$optionValue}',
187 {/if} {* field.pseudoconstant *} ),
188 {/foreach} {* table.fields *}
190 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
192 return Civi::$statics[__CLASS__]['fields'];
196 * Return a mapping from field-name to the corresponding key (as used in fields()).
199 * Array(string $name => string $uniqueName).
201 static function &fieldKeys( ) {ldelim}
202 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {ldelim}
203 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
205 return Civi::$statics[__CLASS__]['fieldKeys'];
209 * Returns the names of this table
213 static function getTableName( ) {ldelim}
214 {if $table.localizable}
215 return CRM_Core_DAO::getLocaleTableName( self::$_tableName );
217 return self::$_tableName;
222 * Returns if this table needs to be logged
226 function getLog( ) {ldelim}
231 * Returns the list of fields that can be imported
233 * @param bool $prefix
237 static function &import( $prefix = false ) {ldelim}
238 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, '{$table.labelName}', $prefix, array(
239 {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
240 {if $foreign.import}'{$foreign.className}',{/if}
247 * Returns the list of fields that can be exported
249 * @param bool $prefix
253 static function &export( $prefix = false ) {ldelim}
254 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, '{$table.labelName}', $prefix, array(
255 {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
256 {if $foreign.export}'{$foreign.className}',{/if}