Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
201f27ba | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
6a488035 | 29 | * @package CRM |
201f27ba | 30 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 | 31 | * |
d5864876 ARW |
32 | * Generated from {$table.sourceFile} |
33 | * {$generated} | |
a8950859 | 34 | * (GenCodeChecksum:{$genCodeChecksum}) |
6a488035 TO |
35 | */ |
36 | ||
37 | require_once 'CRM/Core/DAO.php'; | |
38 | require_once 'CRM/Utils/Type.php'; | |
39 | ||
f41f0342 | 40 | /** |
41 | * {$table.className} constructor. | |
42 | */ | |
6a488035 TO |
43 | class {$table.className} extends CRM_Core_DAO {ldelim} |
44 | ||
45 | /** | |
f41f0342 | 46 | * Static instance to hold the table name. |
6a488035 TO |
47 | * |
48 | * @var string | |
6a488035 TO |
49 | */ |
50 | static $_tableName = '{$table.name}'; | |
51 | ||
6a488035 | 52 | /** |
f41f0342 | 53 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
6a488035 TO |
54 | * |
55 | * @var boolean | |
6a488035 TO |
56 | */ |
57 | static $_log = {$table.log}; | |
58 | ||
59 | {foreach from=$table.fields item=field} | |
60 | /** | |
61 | {if $field.comment} | |
62 | * {$field.comment} | |
63 | {/if} | |
64 | * | |
65 | * @var {$field.phpType} | |
66 | */ | |
67 | public ${$field.name}; | |
68 | ||
69 | {/foreach} {* table.fields *} | |
70 | ||
71 | /** | |
f41f0342 | 72 | * Class constructor. |
6a488035 TO |
73 | */ |
74 | function __construct( ) {ldelim} | |
75 | $this->__table = '{$table.name}'; | |
76 | ||
77 | parent::__construct( ); | |
78 | {rdelim} | |
79 | ||
71e5aa5c | 80 | {if $table.foreignKey || $table.dynamicForeignKey} |
6a488035 | 81 | /** |
f41f0342 | 82 | * Returns foreign keys and entity references. |
6a488035 | 83 | * |
b6e60008 CW |
84 | * @return array |
85 | * [CRM_Core_Reference_Interface] | |
6a488035 | 86 | */ |
71e5aa5c | 87 | static function getReferenceColumns() {ldelim} |
740dd877 TO |
88 | if (!isset(Civi::$statics[__CLASS__]['links'])) {ldelim} |
89 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); | |
6a488035 | 90 | {foreach from=$table.foreignKey item=foreign} |
740dd877 | 91 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), '{$foreign.name}', '{$foreign.table}', '{$foreign.key}'); |
71e5aa5c ARW |
92 | {/foreach} |
93 | ||
94 | {foreach from=$table.dynamicForeignKey item=foreign} | |
740dd877 | 95 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), '{$foreign.idColumn}', NULL, '{$foreign.key|default:'id'}', '{$foreign.typeColumn}'); |
6a488035 | 96 | {/foreach} |
740dd877 | 97 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
71e5aa5c | 98 | {rdelim} |
740dd877 | 99 | return Civi::$statics[__CLASS__]['links']; |
6a488035 TO |
100 | {rdelim} |
101 | {/if} {* table.foreignKey *} | |
102 | ||
103 | /** | |
b6e60008 | 104 | * Returns all the column names of this table |
6a488035 | 105 | * |
6a488035 TO |
106 | * @return array |
107 | */ | |
108 | static function &fields( ) {ldelim} | |
740dd877 TO |
109 | if ( ! isset(Civi::$statics[__CLASS__]['fields']) ) {ldelim} |
110 | Civi::$statics[__CLASS__]['fields'] = array ( | |
6a488035 TO |
111 | {foreach from=$table.fields item=field} |
112 | ||
113 | {if $field.uniqueName} | |
3cef3c00 | 114 | '{$field.uniqueName}' |
6a488035 TO |
115 | {else} |
116 | '{$field.name}' | |
117 | {/if} | |
118 | => array( | |
3cef3c00 | 119 | 'name' => '{$field.name}', |
6a488035 TO |
120 | 'type' => {$field.crmType}, |
121 | {if $field.title} | |
122 | 'title' => ts('{$field.title}'), | |
123 | {/if} | |
5c7169eb CW |
124 | {if $field.comment} |
125 | 'description' => '{$field.comment|replace:"'":"\'"}', | |
126 | {/if} | |
6a488035 TO |
127 | {if $field.required} |
128 | 'required' => {$field.required}, | |
129 | {/if} {* field.required *} | |
130 | {if $field.length} | |
131 | 'maxlength' => {$field.length}, | |
132 | {/if} {* field.length *} | |
ac5f2ccd TO |
133 | {if $field.precision} |
134 | 'precision' => array({$field.precision}), | |
135 | {/if} | |
6a488035 TO |
136 | {if $field.size} |
137 | 'size' => {$field.size}, | |
138 | {/if} {* field.size *} | |
139 | {if $field.rows} | |
140 | 'rows' => {$field.rows}, | |
141 | {/if} {* field.rows *} | |
142 | {if $field.cols} | |
143 | 'cols' => {$field.cols}, | |
144 | {/if} {* field.cols *} | |
145 | ||
146 | {if $field.import} | |
147 | 'import' => {$field.import}, | |
148 | 'where' => '{$table.name}.{$field.name}', | |
149 | 'headerPattern' => '{$field.headerPattern}', | |
150 | 'dataPattern' => '{$field.dataPattern}', | |
151 | {/if} {* field.import *} | |
152 | {if $field.export} | |
153 | 'export' => {$field.export}, | |
154 | {if ! $field.import} | |
155 | 'where' => '{$table.name}.{$field.name}', | |
156 | 'headerPattern' => '{$field.headerPattern}', | |
157 | 'dataPattern' => '{$field.dataPattern}', | |
158 | {/if} | |
159 | {/if} {* field.export *} | |
160 | {if $field.rule} | |
161 | 'rule' => '{$field.rule}', | |
162 | {/if} {* field.rule *} | |
163 | {if $field.default} | |
9e1ed301 | 164 | 'default' => '{if ($field.default[0]=="'" or $field.default[0]=='"')}{$field.default|substring:1:-1}{else}{$field.default}{/if}', |
6a488035 | 165 | {/if} {* field.default *} |
3cef3c00 | 166 | 'table_name' => '{$table.name}', |
167 | 'entity' => '{$table.entity}', | |
168 | 'bao' => '{$table.bao}', | |
7db08f50 | 169 | 'localizable' => {if ($field.localizable)}{1}{else}{0}{/if}, |
6a488035 TO |
170 | |
171 | {if $field.FKClassName} | |
172 | 'FKClassName' => '{$field.FKClassName}', | |
173 | {/if} {* field.FKClassName *} | |
5e545f38 CW |
174 | {if $field.html} |
175 | {assign var=htmlOptions value=$field.html} | |
176 | 'html' => array( | |
177 | {*{$htmlOptions|@print_array}*} | |
178 | {foreach from=$htmlOptions key=optionKey item=optionValue} | |
179 | '{$optionKey}' => '{$optionValue}', | |
180 | {/foreach} | |
181 | ), | |
182 | {/if} {* field.html *} | |
6a488035 TO |
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} | |
3cef3c00 | 188 | '{$optionKey}' => '{$optionValue}', |
189 | {/foreach} | |
6a488035 TO |
190 | ) |
191 | {/if} {* field.pseudoconstant *} ), | |
192 | {/foreach} {* table.fields *} | |
193 | ); | |
740dd877 | 194 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
6a488035 | 195 | {rdelim} |
740dd877 | 196 | return Civi::$statics[__CLASS__]['fields']; |
6a488035 TO |
197 | {rdelim} |
198 | ||
66abbb6d | 199 | /** |
787b31c7 | 200 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
66abbb6d | 201 | * |
66abbb6d | 202 | * @return array |
787b31c7 | 203 | * Array(string $name => string $uniqueName). |
66abbb6d AS |
204 | */ |
205 | static function &fieldKeys( ) {ldelim} | |
787b31c7 TO |
206 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {ldelim} |
207 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
208 | {rdelim} | |
209 | return Civi::$statics[__CLASS__]['fieldKeys']; | |
66abbb6d AS |
210 | {rdelim} |
211 | ||
6a488035 | 212 | /** |
b6e60008 | 213 | * Returns the names of this table |
6a488035 | 214 | * |
6a488035 TO |
215 | * @return string |
216 | */ | |
217 | static function getTableName( ) {ldelim} | |
218 | {if $table.localizable} | |
219 | return CRM_Core_DAO::getLocaleTableName( self::$_tableName ); | |
220 | {else} | |
221 | return self::$_tableName; | |
222 | {/if} | |
223 | {rdelim} | |
224 | ||
225 | /** | |
b6e60008 | 226 | * Returns if this table needs to be logged |
6a488035 | 227 | * |
6a488035 TO |
228 | * @return boolean |
229 | */ | |
230 | function getLog( ) {ldelim} | |
231 | return self::$_log; | |
232 | {rdelim} | |
233 | ||
234 | /** | |
b6e60008 CW |
235 | * Returns the list of fields that can be imported |
236 | * | |
237 | * @param bool $prefix | |
6a488035 | 238 | * |
b6e60008 | 239 | * @return array |
6a488035 TO |
240 | */ |
241 | static function &import( $prefix = false ) {ldelim} | |
84a0493c TO |
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} | |
245 | {/foreach}{/if} | |
246 | )); | |
247 | return $r; | |
6a488035 TO |
248 | {rdelim} |
249 | ||
250 | /** | |
b6e60008 CW |
251 | * Returns the list of fields that can be exported |
252 | * | |
253 | * @param bool $prefix | |
254 | * | |
255 | * @return array | |
256 | */ | |
6a488035 | 257 | static function &export( $prefix = false ) {ldelim} |
84a0493c TO |
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} | |
261 | {/foreach}{/if} | |
262 | )); | |
263 | return $r; | |
6a488035 TO |
264 | {rdelim} |
265 | ||
6b86d84f AS |
266 | /** |
267 | * Returns the list of indices | |
268 | */ | |
269 | public static function indices($localize = TRUE) {ldelim} | |
270 | $indices = {$indicesPhp}; | |
271 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; | |
272 | {rdelim} | |
6a488035 | 273 | {rdelim} |