Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 | 2 | /** |
6a488035 | 3 | * @package CRM |
ca5cec67 | 4 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 | 5 | * |
d5864876 ARW |
6 | * Generated from {$table.sourceFile} |
7 | * {$generated} | |
a8950859 | 8 | * (GenCodeChecksum:{$genCodeChecksum}) |
6a488035 | 9 | */ |
fbb7b4d8 | 10 | {$useHelper} |
f41f0342 | 11 | /** |
c3fc2621 | 12 | * Database access object for the {$table.entity} entity. |
f41f0342 | 13 | */ |
6a488035 TO |
14 | class {$table.className} extends CRM_Core_DAO {ldelim} |
15 | ||
4b4cf875 CW |
16 | const EXT = {$ext}; |
17 | const TABLE_ADDED = '{$table.add}'; | |
d31fb4e3 | 18 | {if !empty($table.component)}const COMPONENT = '{$table.component}';{/if} |
4b4cf875 | 19 | |
6a488035 | 20 | /** |
f41f0342 | 21 | * Static instance to hold the table name. |
6a488035 TO |
22 | * |
23 | * @var string | |
6a488035 | 24 | */ |
fa45b5b9 | 25 | public static $_tableName = '{$table.name}'; |
6a488035 | 26 | |
449c4e6b CW |
27 | {if $table.icon} |
28 | /** | |
29 | * Icon associated with this entity. | |
30 | * | |
31 | * @var string | |
32 | */ | |
33 | public static $_icon = '{$table.icon}'; | |
34 | {/if} | |
8ab43c93 CW |
35 | |
36 | {if $table.labelField} | |
37 | /** | |
38 | * Field to show when displaying a record. | |
39 | * | |
40 | * @var string | |
41 | */ | |
42 | public static $_labelField = '{$table.labelField}'; | |
43 | {/if} | |
6a488035 | 44 | /** |
f41f0342 | 45 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
6a488035 | 46 | * |
c3fc2621 | 47 | * @var bool |
6a488035 | 48 | */ |
fa45b5b9 | 49 | public static $_log = {$table.log|strtoupper}; |
a7bd99ff CW |
50 | {if $table.paths} |
51 | /** | |
52 | * Paths for accessing this entity in the UI. | |
53 | * | |
54 | * @var string[] | |
55 | */ | |
56 | protected static $_paths = {$table.paths|@print_array}; | |
57 | {/if} | |
6a488035 TO |
58 | |
59 | {foreach from=$table.fields item=field} | |
60 | /** | |
61 | {if $field.comment} | |
fb607354 | 62 | * {$field.comment|regex_replace:"/\n[ ]*/":"\n* "} |
6a488035 | 63 | * |
c3fc2621 | 64 | {/if} |
6a488035 TO |
65 | * @var {$field.phpType} |
66 | */ | |
67 | public ${$field.name}; | |
68 | ||
69 | {/foreach} {* table.fields *} | |
70 | ||
71 | /** | |
f41f0342 | 72 | * Class constructor. |
6a488035 | 73 | */ |
c3fc2621 | 74 | public function __construct( ) {ldelim} |
6a488035 TO |
75 | $this->__table = '{$table.name}'; |
76 | ||
77 | parent::__construct( ); | |
78 | {rdelim} | |
79 | ||
449c4e6b CW |
80 | /** |
81 | * Returns localized title of this entity. | |
7b66c3b5 AH |
82 | * |
83 | * @param bool $plural | |
84 | * Whether to return the plural version of the title. | |
449c4e6b | 85 | */ |
7b66c3b5 AH |
86 | public static function getEntityTitle($plural = FALSE) {ldelim} |
87 | return $plural ? {$tsFunctionName}('{$table.titlePlural}') : {$tsFunctionName}('{$table.title}'); | |
449c4e6b CW |
88 | {rdelim} |
89 | ||
90 | ||
91 | ||
1832ba99 | 92 | {if !empty($table.foreignKey) || !empty($table.dynamicForeignKey)} |
6a488035 | 93 | /** |
f41f0342 | 94 | * Returns foreign keys and entity references. |
6a488035 | 95 | * |
b6e60008 CW |
96 | * @return array |
97 | * [CRM_Core_Reference_Interface] | |
6a488035 | 98 | */ |
c3fc2621 | 99 | public static function getReferenceColumns() {ldelim} |
740dd877 TO |
100 | if (!isset(Civi::$statics[__CLASS__]['links'])) {ldelim} |
101 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); | |
1832ba99 | 102 | {if isset($table.foreignKey)} |
6a488035 | 103 | {foreach from=$table.foreignKey item=foreign} |
740dd877 | 104 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), '{$foreign.name}', '{$foreign.table}', '{$foreign.key}'); |
71e5aa5c | 105 | {/foreach} |
1832ba99 SL |
106 | {/if} |
107 | {if isset($table.dynamicForeignKey)} | |
71e5aa5c | 108 | {foreach from=$table.dynamicForeignKey item=foreign} |
740dd877 | 109 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), '{$foreign.idColumn}', NULL, '{$foreign.key|default:'id'}', '{$foreign.typeColumn}'); |
6a488035 | 110 | {/foreach} |
1832ba99 | 111 | {/if} |
740dd877 | 112 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
71e5aa5c | 113 | {rdelim} |
740dd877 | 114 | return Civi::$statics[__CLASS__]['links']; |
6a488035 TO |
115 | {rdelim} |
116 | {/if} {* table.foreignKey *} | |
117 | ||
118 | /** | |
b6e60008 | 119 | * Returns all the column names of this table |
6a488035 | 120 | * |
6a488035 TO |
121 | * @return array |
122 | */ | |
c3fc2621 | 123 | public static function &fields( ) {ldelim} |
740dd877 | 124 | if ( ! isset(Civi::$statics[__CLASS__]['fields']) ) {ldelim} |
c3fc2621 | 125 | Civi::$statics[__CLASS__]['fields'] = array( |
6a488035 TO |
126 | {foreach from=$table.fields item=field} |
127 | ||
128 | {if $field.uniqueName} | |
3cef3c00 | 129 | '{$field.uniqueName}' |
6a488035 TO |
130 | {else} |
131 | '{$field.name}' | |
132 | {/if} | |
133 | => array( | |
3cef3c00 | 134 | 'name' => '{$field.name}', |
6a488035 TO |
135 | 'type' => {$field.crmType}, |
136 | {if $field.title} | |
8af97d90 | 137 | 'title' => {$tsFunctionName}('{$field.title}'), |
6a488035 | 138 | {/if} |
5c7169eb | 139 | {if $field.comment} |
8af97d90 | 140 | 'description' => {$tsFunctionName}('{$field.comment|replace:"'":"\'"}'), |
5c7169eb | 141 | {/if} |
6a488035 | 142 | {if $field.required} |
c3fc2621 | 143 | 'required' => {$field.required|strtoupper}, |
6a488035 | 144 | {/if} {* field.required *} |
1832ba99 | 145 | {if isset($field.length)} |
6a488035 TO |
146 | 'maxlength' => {$field.length}, |
147 | {/if} {* field.length *} | |
1832ba99 | 148 | {if isset($field.precision)} |
ac5f2ccd TO |
149 | 'precision' => array({$field.precision}), |
150 | {/if} | |
1832ba99 | 151 | {if isset($field.size)} |
6a488035 TO |
152 | 'size' => {$field.size}, |
153 | {/if} {* field.size *} | |
1832ba99 | 154 | {if isset($field.rows)} |
6a488035 TO |
155 | 'rows' => {$field.rows}, |
156 | {/if} {* field.rows *} | |
1832ba99 | 157 | {if isset($field.cols)} |
6a488035 TO |
158 | 'cols' => {$field.cols}, |
159 | {/if} {* field.cols *} | |
160 | ||
161 | {if $field.import} | |
c3fc2621 | 162 | 'import' => {$field.import|strtoupper}, |
bf144e74 | 163 | |
6a488035 | 164 | {/if} {* field.import *} |
bf144e74 | 165 | 'where' => '{$table.name}.{$field.name}', |
166 | {if $field.headerPattern}'headerPattern' => '{$field.headerPattern}',{/if} | |
167 | {if $field.dataPattern}'dataPattern' => '{$field.dataPattern}',{/if} | |
6a488035 | 168 | {if $field.export} |
c3fc2621 | 169 | 'export' => {$field.export|strtoupper}, |
6a488035 | 170 | {/if} {* field.export *} |
f5c0f096 CW |
171 | {if $field.contactType} |
172 | 'contactType' => {if $field.contactType == 'null'}NULL{else}'{$field.contactType}'{/if}, | |
173 | {/if} | |
6a488035 TO |
174 | {if $field.rule} |
175 | 'rule' => '{$field.rule}', | |
176 | {/if} {* field.rule *} | |
1713a0ec CW |
177 | {if !empty($field.permission)} |
178 | 'permission' => {$field.permission|@print_array}, | |
042043f1 | 179 | {/if} |
45a83e42 | 180 | {if $field.default || $field.default === '0'} |
9e1ed301 | 181 | 'default' => '{if ($field.default[0]=="'" or $field.default[0]=='"')}{$field.default|substring:1:-1}{else}{$field.default}{/if}', |
6a488035 | 182 | {/if} {* field.default *} |
3cef3c00 | 183 | 'table_name' => '{$table.name}', |
184 | 'entity' => '{$table.entity}', | |
185 | 'bao' => '{$table.bao}', | |
fbdb9a4d | 186 | 'localizable' => {if $field.localizable}1{else}0{/if}, |
1832ba99 | 187 | {if isset($field.localize_context)}'localize_context' => '{$field.localize_context}',{/if} |
6a488035 | 188 | |
1832ba99 | 189 | {if isset($field.FKClassName)} |
6a488035 | 190 | 'FKClassName' => '{$field.FKClassName}', |
2a5c9b4d | 191 | {/if} |
88c31c05 CW |
192 | {if !empty($field.component)} |
193 | 'component' => '{$field.component}', | |
194 | {/if} | |
2a5c9b4d CW |
195 | {if $field.serialize} |
196 | 'serialize' => self::SERIALIZE_{$field.serialize|strtoupper}, | |
197 | {/if} | |
74db51d3 | 198 | {if $field.uniqueTitle} |
199 | 'unique_title' => {$tsFunctionName}('{$field.uniqueTitle}'), | |
200 | {/if} | |
5e545f38 | 201 | {if $field.html} |
4361de53 CW |
202 | 'html' => array( |
203 | {foreach from=$field.html item=val key=key} | |
8af97d90 | 204 | '{$key}' => {if $key eq 'label'}{$tsFunctionName}("{$val}"){else}'{$val}'{/if}, |
4361de53 CW |
205 | {/foreach} |
206 | ), | |
207 | {/if} | |
6a488035 | 208 | {if $field.pseudoconstant} |
800d9240 | 209 | 'pseudoconstant' => {$field.pseudoconstant|@print_array}, |
34745448 CW |
210 | {/if} |
211 | {if $field.readonly || $field.name === $table.primaryKey.name} | |
212 | 'readonly' => TRUE, | |
a9d0587b CW |
213 | {/if} |
214 | 'add' => {if $field.add}'{$field.add}'{else}NULL{/if}, | |
215 | ), | |
6a488035 TO |
216 | {/foreach} {* table.fields *} |
217 | ); | |
740dd877 | 218 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
6a488035 | 219 | {rdelim} |
740dd877 | 220 | return Civi::$statics[__CLASS__]['fields']; |
6a488035 TO |
221 | {rdelim} |
222 | ||
66abbb6d | 223 | /** |
787b31c7 | 224 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
66abbb6d | 225 | * |
66abbb6d | 226 | * @return array |
787b31c7 | 227 | * Array(string $name => string $uniqueName). |
66abbb6d | 228 | */ |
c3fc2621 | 229 | public static function &fieldKeys( ) {ldelim} |
787b31c7 TO |
230 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {ldelim} |
231 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
232 | {rdelim} | |
233 | return Civi::$statics[__CLASS__]['fieldKeys']; | |
66abbb6d AS |
234 | {rdelim} |
235 | ||
6a488035 | 236 | /** |
b6e60008 | 237 | * Returns the names of this table |
6a488035 | 238 | * |
6a488035 TO |
239 | * @return string |
240 | */ | |
c3fc2621 | 241 | public static function getTableName( ) {ldelim} |
6a488035 TO |
242 | {if $table.localizable} |
243 | return CRM_Core_DAO::getLocaleTableName( self::$_tableName ); | |
244 | {else} | |
245 | return self::$_tableName; | |
246 | {/if} | |
247 | {rdelim} | |
248 | ||
249 | /** | |
b6e60008 | 250 | * Returns if this table needs to be logged |
6a488035 | 251 | * |
c3fc2621 | 252 | * @return bool |
6a488035 | 253 | */ |
c3fc2621 | 254 | public function getLog( ) {ldelim} |
6a488035 TO |
255 | return self::$_log; |
256 | {rdelim} | |
257 | ||
258 | /** | |
b6e60008 CW |
259 | * Returns the list of fields that can be imported |
260 | * | |
261 | * @param bool $prefix | |
6a488035 | 262 | * |
b6e60008 | 263 | * @return array |
6a488035 | 264 | */ |
c3fc2621 | 265 | public static function &import( $prefix = FALSE ) {ldelim} |
84a0493c | 266 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, '{$table.labelName}', $prefix, array( |
1832ba99 | 267 | {if isset($table.foreignKey)}{foreach from=$table.foreignKey item=foreign} |
84a0493c TO |
268 | {if $foreign.import}'{$foreign.className}',{/if} |
269 | {/foreach}{/if} | |
270 | )); | |
271 | return $r; | |
6a488035 TO |
272 | {rdelim} |
273 | ||
274 | /** | |
b6e60008 CW |
275 | * Returns the list of fields that can be exported |
276 | * | |
277 | * @param bool $prefix | |
278 | * | |
279 | * @return array | |
280 | */ | |
c3fc2621 | 281 | public static function &export( $prefix = FALSE ) {ldelim} |
84a0493c | 282 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, '{$table.labelName}', $prefix, array( |
1832ba99 | 283 | {if isset($table.foreignKey)}{foreach from=$table.foreignKey item=foreign} |
84a0493c TO |
284 | {if $foreign.export}'{$foreign.className}',{/if} |
285 | {/foreach}{/if} | |
286 | )); | |
287 | return $r; | |
6a488035 TO |
288 | {rdelim} |
289 | ||
6b86d84f AS |
290 | /** |
291 | * Returns the list of indices | |
c3fc2621 CW |
292 | * |
293 | * @param bool $localize | |
294 | * | |
295 | * @return array | |
6b86d84f AS |
296 | */ |
297 | public static function indices($localize = TRUE) {ldelim} | |
298 | $indices = {$indicesPhp}; | |
299 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; | |
300 | {rdelim} | |
c3fc2621 | 301 | |
6a488035 | 302 | {rdelim} |