xml/templates/dao.tpl

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