CRM/Core/DAO/AddressFormat.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Core/AddressFormat.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:ef2bb5732dc5f40f6713f48c72f011ba)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_AddressFormat constructor.
  39  */
  40 class CRM_Core_DAO_AddressFormat extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_address_format';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    * Address Format Id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * The format of an address
  61    *
  62    * @var text
  63    */
  64   public $format;
  65   /**
  66    * Class constructor.
  67    */
  68   function __construct() {
  69     $this->__table = 'civicrm_address_format';
  70     parent::__construct();
  71   }
  72   /**
  73    * Returns all the column names of this table
  74    *
  75    * @return array
  76    */
  77   static function &fields() {
  78     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  79       Civi::$statics[__CLASS__]['fields'] = array(
  80         'id' => array(
  81           'name' => 'id',
  82           'type' => CRM_Utils_Type::T_INT,
  83           'title' => ts('Address Format ID') ,
  84           'description' => 'Address Format Id',
  85           'required' => true,
  86         ) ,
  87         'format' => array(
  88           'name' => 'format',
  89           'type' => CRM_Utils_Type::T_TEXT,
  90           'title' => ts('Address Format') ,
  91           'description' => 'The format of an address',
  92         ) ,
  93       );
  94       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
  95     }
  96     return Civi::$statics[__CLASS__]['fields'];
  97   }
  98   /**
  99    * Return a mapping from field-name to the corresponding key (as used in fields()).
 100    *
 101    * @return array
 102    *   Array(string $name => string $uniqueName).
 103    */
 104   static function &fieldKeys() {
 105     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 106       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 107     }
 108     return Civi::$statics[__CLASS__]['fieldKeys'];
 109   }
 110   /**
 111    * Returns the names of this table
 112    *
 113    * @return string
 114    */
 115   static function getTableName() {
 116     return self::$_tableName;
 117   }
 118   /**
 119    * Returns if this table needs to be logged
 120    *
 121    * @return boolean
 122    */
 123   function getLog() {
 124     return self::$_log;
 125   }
 126   /**
 127    * Returns the list of fields that can be imported
 128    *
 129    * @param bool $prefix
 130    *
 131    * @return array
 132    */
 133   static function &import($prefix = false) {
 134     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'address_format', $prefix, array());
 135     return $r;
 136   }
 137   /**
 138    * Returns the list of fields that can be exported
 139    *
 140    * @param bool $prefix
 141    *
 142    * @return array
 143    */
 144   static function &export($prefix = false) {
 145     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'address_format', $prefix, array());
 146     return $r;
 147   }
 148 }