xml/templates/dao.tpl

   1 <?php
   2 /**
   3  * @package CRM
   4  * @copyright CiviCRM LLC (c) 2004-2019
   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       public 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       public static $_log = {$table.log|strtoupper};
  29
  30 {foreach from=$table.fields item=field}
  31     /**
  32 {if $field.comment}
  33      * {$field.comment|regex_replace:"/\n[ ]*/":"\n* "}
  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'     => {$tsFunctionName}('{$field.title}'),
  94 {/if}
  95 {if $field.comment}
  96                                                                       'description'     => {$tsFunctionName}('{$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
 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}
 124 {if $field.export}
 125                       'export'    => {$field.export|strtoupper},
 126 {/if} {* field.export *}
 127
 128 {if $field.rule}
 129                       'rule'      => '{$field.rule}',
 130 {/if} {* field.rule *}
 131 {if !empty($field.permission)}
 132                       'permission'      => {$field.permission|@print_array},
 133 {/if}
 134 {if $field.default || $field.default === '0'}
 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   {if $field.localize_context}'localize_context' => '{$field.localize_context}',{/if}
 142
 143 {if $field.FKClassName}
 144                       'FKClassName' => '{$field.FKClassName}',
 145 {/if}
 146 {if $field.serialize}
 147   'serialize' => self::SERIALIZE_{$field.serialize|strtoupper},
 148 {/if}
 149 {if $field.html}
 150   'html' => array(
 151   {foreach from=$field.html item=val key=key}
 152     '{$key}' => {if $key eq 'label'}{$tsFunctionName}("{$val}"){else}'{$val}'{/if},
 153   {/foreach}
 154   ),
 155 {/if}
 156 {if $field.pseudoconstant}
 157   'pseudoconstant' => {$field.pseudoconstant|@print_array},
 158 {/if} {* field.pseudoconstant *}                                                                    ),
 159 {/foreach} {* table.fields *}
 160                                       );
 161             CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 162           {rdelim}
 163           return Civi::$statics[__CLASS__]['fields'];
 164       {rdelim}
 165
 166       /**
 167        * Return a mapping from field-name to the corresponding key (as used in fields()).
 168        *
 169        * @return array
 170        *   Array(string $name => string $uniqueName).
 171        */
 172       public static function &fieldKeys( ) {ldelim}
 173         if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {ldelim}
 174           Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 175         {rdelim}
 176         return Civi::$statics[__CLASS__]['fieldKeys'];
 177       {rdelim}
 178
 179       /**
 180        * Returns the names of this table
 181        *
 182        * @return string
 183        */
 184       public static function getTableName( ) {ldelim}
 185         {if $table.localizable}
 186           return CRM_Core_DAO::getLocaleTableName( self::$_tableName );
 187         {else}
 188           return self::$_tableName;
 189         {/if}
 190       {rdelim}
 191
 192       /**
 193        * Returns if this table needs to be logged
 194        *
 195        * @return bool
 196        */
 197       public function getLog( ) {ldelim}
 198           return self::$_log;
 199       {rdelim}
 200
 201       /**
 202        * Returns the list of fields that can be imported
 203        *
 204        * @param bool $prefix
 205        *
 206        * @return array
 207        */
 208        public static function &import( $prefix = FALSE ) {ldelim}
 209             $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, '{$table.labelName}', $prefix, array(
 210             {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
 211               {if $foreign.import}'{$foreign.className}',{/if}
 212             {/foreach}{/if}
 213             ));
 214             return $r;
 215       {rdelim}
 216
 217        /**
 218         * Returns the list of fields that can be exported
 219         *
 220         * @param bool $prefix
 221         *
 222         * @return array
 223         */
 224        public static function &export( $prefix = FALSE ) {ldelim}
 225             $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, '{$table.labelName}', $prefix, array(
 226             {if $table.foreignKey}{foreach from=$table.foreignKey item=foreign}
 227               {if $foreign.export}'{$foreign.className}',{/if}
 228             {/foreach}{/if}
 229             ));
 230             return $r;
 231       {rdelim}
 232
 233       /**
 234        * Returns the list of indices
 235        *
 236        * @param bool $localize
 237        *
 238        * @return array
 239        */
 240       public static function indices($localize = TRUE) {ldelim}
 241         $indices = {$indicesPhp};
 242         return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 243       {rdelim}
 244
 245 {rdelim}