4 * @copyright CiviCRM LLC https://civicrm.org/licensing
6 * Generated from {$table.sourceFile}
8 * (GenCodeChecksum:{$genCodeChecksum})
12 * Database access object for the {$table.entity} entity.
14 class {$table.className} extends CRM_Core_DAO {ldelim}
17 * Static instance to hold the table name.
21 public static $_tableName = '{$table.name}';
24 * Should CiviCRM log any modifications to this table in the civicrm_log table.
28 public static $_log = {$table.log|strtoupper};
30 {foreach from=$table.fields item=field}
33 * {$field.comment|regex_replace:"/\n[ ]*/":"\n* "}
36 * @var {$field.phpType}
38 public ${$field.name};
40 {/foreach} {* table.fields *}
45 public function __construct( ) {ldelim}
46 $this->__table = '{$table.name}';
48 parent::__construct( );
51 {if $table.foreignKey || $table.dynamicForeignKey}
53 * Returns foreign keys and entity references.
56 * [CRM_Core_Reference_Interface]
58 public static function getReferenceColumns() {ldelim}
59 if (!isset(Civi::$statics[__CLASS__]['links'])) {ldelim}
60 Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
61 {foreach from=$table.foreignKey item=foreign}
62 Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), '{$foreign.name}', '{$foreign.table}', '{$foreign.key}');
65 {foreach from=$table.dynamicForeignKey item=foreign}
66 Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), '{$foreign.idColumn}', NULL, '{$foreign.key|default:'id'}', '{$foreign.typeColumn}');
68 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
70 return Civi::$statics[__CLASS__]['links'];
72 {/if} {* table.foreignKey *}
75 * Returns all the column names of this table
79 public static function &fields( ) {ldelim}
80 if ( ! isset(Civi::$statics[__CLASS__]['fields']) ) {ldelim}
81 Civi::$statics[__CLASS__]['fields'] = array(
82 {foreach from=$table.fields item=field}
84 {if $field.uniqueName}
90 'name' => '{$field.name}',
91 'type' => {$field.crmType},
93 'title' => {$tsFunctionName}('{$field.title}'),
96 'description' => {$tsFunctionName}('{$field.comment|replace:"'":"\'"}'),
99 'required' => {$field.required|strtoupper},
100 {/if} {* field.required *}
102 'maxlength' => {$field.length},
103 {/if} {* field.length *}
104 {if $field.precision}
105 'precision' => array({$field.precision}),
108 'size' => {$field.size},
109 {/if} {* field.size *}
111 'rows' => {$field.rows},
112 {/if} {* field.rows *}
114 'cols' => {$field.cols},
115 {/if} {* field.cols *}
118 'import' => {$field.import|strtoupper},
120 {/if} {* field.import *}
121 'where' => '{$table.name}.{$field.name}',
122 {if $field.headerPattern}'headerPattern' => '{$field.headerPattern}',{/if}
123 {if $field.dataPattern}'dataPattern' => '{$field.dataPattern}',{/if}
125 'export' => {$field.export|strtoupper},
126 {/if} {* field.export *}
127 {if $field.contactType}
128 'contactType' => {if $field.contactType == 'null'}NULL{else}'{$field.contactType}'{/if},
131 'rule' => '{$field.rule}',
132 {/if} {* field.rule *}
133 {if !empty($field.permission)}
134 'permission' => {$field.permission|@print_array},
136 {if $field.default || $field.default === '0'}
137 'default' => '{if ($field.default[0]=="'" or $field.default[0]=='"')}{$field.default|substring:1:-1}{else}{$field.default}{/if}',
138 {/if} {* field.default *}
139 'table_name' => '{$table.name}',
140 'entity' => '{$table.entity}',
141 'bao' => '{$table.bao}',
142 'localizable' => {if $field.localizable}1{else}0{/if},
143 {if $field.localize_context}'localize_context' => '{$field.localize_context}',{/if}
145 {if $field.FKClassName}
146 'FKClassName' => '{$field.FKClassName}',
148 {if $field.serialize}
149 'serialize' => self::SERIALIZE_{$field.serialize|strtoupper},
151 {if $field.uniqueTitle}
152 'unique_title' => {$tsFunctionName}('{$field.uniqueTitle}'),
156 {foreach from=$field.html item=val key=key}
157 '{$key}' => {if $key eq 'label'}{$tsFunctionName}("{$val}"){else}'{$val}'{/if},
161 {if $field.pseudoconstant}
162 'pseudoconstant' => {$field.pseudoconstant|@print_array},
163 {/if} {* field.pseudoconstant *} ),
164 {/foreach} {* table.fields *}
166 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
168 return Civi::$statics[__CLASS__]['fields'];
172 * Return a mapping from field-name to the corresponding key (as used in fields()).
175 * Array(string $name => string $uniqueName).
177 public static function &fieldKeys( ) {ldelim}
178 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {ldelim}
179 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
181 return Civi::$statics[__CLASS__]['fieldKeys'];
185 * Returns the names of this table
189 public static function getTableName( ) {ldelim}
190 {if $table.localizable}
191 return CRM_Core_DAO::getLocaleTableName( self::$_tableName );
193 return self::$_tableName;
198 * Returns if this table needs to be logged
202 public function getLog( ) {ldelim}
207 * Returns the list of fields that can be imported
209 * @param bool $prefix
213 public static function &import( $prefix = FALSE ) {ldelim}
214 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, '{$table.labelName}', $prefix, array(
215 {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
216 {if $foreign.import}'{$foreign.className}',{/if}
223 * Returns the list of fields that can be exported
225 * @param bool $prefix
229 public static function &export( $prefix = FALSE ) {ldelim}
230 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, '{$table.labelName}', $prefix, array(
231 {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
232 {if $foreign.export}'{$foreign.className}',{/if}
239 * Returns the list of indices
241 * @param bool $localize
245 public static function indices($localize = TRUE) {ldelim}
246 $indices = {$indicesPhp};
247 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;