xml/templates/dao.tpl

   1 <?php
   2 /**
   3  * @package CRM
   4  * @copyright CiviCRM LLC (c) 2004-2018
   5  *
   6  * Generated from {$table.sourceFile}
   7  * {$generated}
   8  * (GenCodeChecksum:{$genCodeChecksum})
   9  */
  10
  11 /**
  12  * Database access object for the {$table.entity} entity.
  13  */
  14 class {$table.className} extends CRM_Core_DAO {ldelim}
  15
  16      /**
  17       * Static instance to hold the table name.
  18       *
  19       * @var string
  20       */
  21       static $_tableName = '{$table.name}';
  22
  23       /**
  24        * Should CiviCRM log any modifications to this table in the civicrm_log table.
  25        *
  26        * @var bool
  27        */
  28       static $_log = {$table.log|strtoupper};
  29
  30 {foreach from=$table.fields item=field}
  31     /**
  32 {if $field.comment}
  33      * {$field.comment}
  34      *
  35 {/if}
  36      * @var {$field.phpType}
  37      */
  38     public ${$field.name};
  39
  40 {/foreach} {* table.fields *}
  41
  42     /**
  43      * Class constructor.
  44      */
  45     public function __construct( ) {ldelim}
  46         $this->__table = '{$table.name}';
  47
  48         parent::__construct( );
  49     {rdelim}
  50
  51 {if $table.foreignKey || $table.dynamicForeignKey}
  52     /**
  53      * Returns foreign keys and entity references.
  54      *
  55      * @return array
  56      *   [CRM_Core_Reference_Interface]
  57      */
  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}');
  63 {/foreach}
  64
  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}');
  67 {/foreach}
  68         CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  69       {rdelim}
  70       return Civi::$statics[__CLASS__]['links'];
  71     {rdelim}
  72 {/if} {* table.foreignKey *}
  73
  74       /**
  75        * Returns all the column names of this table
  76        *
  77        * @return array
  78        */
  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}
  83
  84 {if $field.uniqueName}
  85   '{$field.uniqueName}'
  86 {else}
  87                                             '{$field.name}'
  88 {/if}
  89                => array(
  90                  'name'      => '{$field.name}',
  91                                                                       'type'      => {$field.crmType},
  92 {if $field.title}
  93                                                                       'title'     => ts('{$field.title}'),
  94 {/if}
  95 {if $field.comment}
  96                                                                       'description'     => '{$field.comment|replace:"'":"\'"}',
  97 {/if}
  98 {if $field.required}
  99                                         'required'  => {$field.required|strtoupper},
 100 {/if} {* field.required *}
 101 {if $field.length}
 102                       'maxlength' => {$field.length},
 103 {/if} {* field.length *}
 104 {if $field.precision}
 105                       'precision'      => array({$field.precision}),
 106 {/if}
 107 {if $field.size}
 108                       'size'      => {$field.size},
 109 {/if} {* field.size *}
 110 {if $field.rows}
 111                       'rows'      => {$field.rows},
 112 {/if} {* field.rows *}
 113 {if $field.cols}
 114                       'cols'      => {$field.cols},
 115 {/if} {* field.cols *}
 116
 117 {if $field.import}
 118                       'import'    => {$field.import|strtoupper},
 119                                                                       'where'     => '{$table.name}.{$field.name}',
 120                                       'headerPattern' => '{$field.headerPattern}',
 121                                       'dataPattern' => '{$field.dataPattern}',
 122 {/if} {* field.import *}
 123 {if $field.export}
 124                       'export'    => {$field.export|strtoupper},
 125                                       {if ! $field.import}
 126                       'where'     => '{$table.name}.{$field.name}',
 127                                       'headerPattern' => '{$field.headerPattern}',
 128                                       'dataPattern' => '{$field.dataPattern}',
 129               {/if}
 130 {/if} {* field.export *}
 131 {if $field.rule}
 132                       'rule'      => '{$field.rule}',
 133 {/if} {* field.rule *}
 134 {if $field.default}
 135                          'default'   => '{if ($field.default[0]=="'" or $field.default[0]=='"')}{$field.default|substring:1:-1}{else}{$field.default}{/if}',
 136 {/if} {* field.default *}
 137   'table_name' => '{$table.name}',
 138   'entity' => '{$table.entity}',
 139   'bao' => '{$table.bao}',
 140   'localizable' => {if ($field.localizable)}{1}{else}{0}{/if},
 141
 142 {if $field.FKClassName}
 143                       'FKClassName' => '{$field.FKClassName}',
 144 {/if}
 145 {if $field.serialize}
 146   'serialize' => self::SERIALIZE_{$field.serialize|strtoupper},
 147 {/if}
 148 {if $field.html}
 149   'html' => {$field.html|@print_array},
 150 {/if} {* field.html *}
 151 {if $field.pseudoconstant}
 152   'pseudoconstant' => {$field.pseudoconstant|@print_array}
 153 {/if} {* field.pseudoconstant *}                                                                    ),
 154 {/foreach} {* table.fields *}
 155                                       );
 156             CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 157           {rdelim}
 158           return Civi::$statics[__CLASS__]['fields'];
 159       {rdelim}
 160
 161       /**
 162        * Return a mapping from field-name to the corresponding key (as used in fields()).
 163        *
 164        * @return array
 165        *   Array(string $name => string $uniqueName).
 166        */
 167       public static function &fieldKeys( ) {ldelim}
 168         if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {ldelim}
 169           Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 170         {rdelim}
 171         return Civi::$statics[__CLASS__]['fieldKeys'];
 172       {rdelim}
 173
 174       /**
 175        * Returns the names of this table
 176        *
 177        * @return string
 178        */
 179       public static function getTableName( ) {ldelim}
 180         {if $table.localizable}
 181           return CRM_Core_DAO::getLocaleTableName( self::$_tableName );
 182         {else}
 183           return self::$_tableName;
 184         {/if}
 185       {rdelim}
 186
 187       /**
 188        * Returns if this table needs to be logged
 189        *
 190        * @return bool
 191        */
 192       public function getLog( ) {ldelim}
 193           return self::$_log;
 194       {rdelim}
 195
 196       /**
 197        * Returns the list of fields that can be imported
 198        *
 199        * @param bool $prefix
 200        *
 201        * @return array
 202        */
 203        public static function &import( $prefix = FALSE ) {ldelim}
 204             $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, '{$table.labelName}', $prefix, array(
 205             {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
 206               {if $foreign.import}'{$foreign.className}',{/if}
 207             {/foreach}{/if}
 208             ));
 209             return $r;
 210       {rdelim}
 211
 212        /**
 213         * Returns the list of fields that can be exported
 214         *
 215         * @param bool $prefix
 216         *
 217         * @return array
 218         */
 219        public static function &export( $prefix = FALSE ) {ldelim}
 220             $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, '{$table.labelName}', $prefix, array(
 221             {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
 222               {if $foreign.export}'{$foreign.className}',{/if}
 223             {/foreach}{/if}
 224             ));
 225             return $r;
 226       {rdelim}
 227
 228       /**
 229        * Returns the list of indices
 230        *
 231        * @param bool $localize
 232        *
 233        * @return array
 234        */
 235       public static function indices($localize = TRUE) {ldelim}
 236         $indices = {$indicesPhp};
 237         return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 238       {rdelim}
 239
 240 {rdelim}