CRM/Core/DAO/LocationType.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  30  *
  31  * Generated from xml/schema/CRM/Core/LocationType.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:f0327e335eb583862d2bd8afad6444ac)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Core_DAO_LocationType extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_location_type';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = true;
  51   /**
  52    * Location Type ID
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * Location Type Name.
  59    *
  60    * @var string
  61    */
  62   public $name;
  63   /**
  64    * Location Type Display Name.
  65    *
  66    * @var string
  67    */
  68   public $display_name;
  69   /**
  70    * vCard Location Type Name.
  71    *
  72    * @var string
  73    */
  74   public $vcard_name;
  75   /**
  76    * Location Type Description.
  77    *
  78    * @var string
  79    */
  80   public $description;
  81   /**
  82    * Is this location type a predefined system location?
  83    *
  84    * @var boolean
  85    */
  86   public $is_reserved;
  87   /**
  88    * Is this property active?
  89    *
  90    * @var boolean
  91    */
  92   public $is_active;
  93   /**
  94    * Is this location type the default?
  95    *
  96    * @var boolean
  97    */
  98   public $is_default;
  99   /**
 100    * class constructor
 101    *
 102    * @return civicrm_location_type
 103    */
 104   function __construct() {
 105     $this->__table = 'civicrm_location_type';
 106     parent::__construct();
 107   }
 108   /**
 109    * Returns all the column names of this table
 110    *
 111    * @return array
 112    */
 113   static function &fields() {
 114     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 115       Civi::$statics[__CLASS__]['fields'] = array(
 116         'id' => array(
 117           'name' => 'id',
 118           'type' => CRM_Utils_Type::T_INT,
 119           'title' => ts('Location Type ID') ,
 120           'description' => 'Location Type ID',
 121           'required' => true,
 122         ) ,
 123         'name' => array(
 124           'name' => 'name',
 125           'type' => CRM_Utils_Type::T_STRING,
 126           'title' => ts('Location Type') ,
 127           'description' => 'Location Type Name.',
 128           'maxlength' => 64,
 129           'size' => CRM_Utils_Type::BIG,
 130         ) ,
 131         'display_name' => array(
 132           'name' => 'display_name',
 133           'type' => CRM_Utils_Type::T_STRING,
 134           'title' => ts('Display Name') ,
 135           'description' => 'Location Type Display Name.',
 136           'maxlength' => 64,
 137           'size' => CRM_Utils_Type::BIG,
 138         ) ,
 139         'vcard_name' => array(
 140           'name' => 'vcard_name',
 141           'type' => CRM_Utils_Type::T_STRING,
 142           'title' => ts('vCard Location Type') ,
 143           'description' => 'vCard Location Type Name.',
 144           'maxlength' => 64,
 145           'size' => CRM_Utils_Type::BIG,
 146         ) ,
 147         'description' => array(
 148           'name' => 'description',
 149           'type' => CRM_Utils_Type::T_STRING,
 150           'title' => ts('Description') ,
 151           'description' => 'Location Type Description.',
 152           'maxlength' => 255,
 153           'size' => CRM_Utils_Type::HUGE,
 154         ) ,
 155         'is_reserved' => array(
 156           'name' => 'is_reserved',
 157           'type' => CRM_Utils_Type::T_BOOLEAN,
 158           'title' => ts('Location Type is Reserved?') ,
 159           'description' => 'Is this location type a predefined system location?',
 160         ) ,
 161         'is_active' => array(
 162           'name' => 'is_active',
 163           'type' => CRM_Utils_Type::T_BOOLEAN,
 164           'title' => ts('Location Type is Active?') ,
 165           'description' => 'Is this property active?',
 166         ) ,
 167         'is_default' => array(
 168           'name' => 'is_default',
 169           'type' => CRM_Utils_Type::T_BOOLEAN,
 170           'title' => ts('Default Location Type?') ,
 171           'description' => 'Is this location type the default?',
 172         ) ,
 173       );
 174       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 175     }
 176     return Civi::$statics[__CLASS__]['fields'];
 177   }
 178   /**
 179    * Return a mapping from field-name to the corresponding key (as used in fields()).
 180    *
 181    * @return array
 182    *   Array(string $name => string $uniqueName).
 183    */
 184   static function &fieldKeys() {
 185     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 186       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 187     }
 188     return Civi::$statics[__CLASS__]['fieldKeys'];
 189   }
 190   /**
 191    * Returns the names of this table
 192    *
 193    * @return string
 194    */
 195   static function getTableName() {
 196     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 197   }
 198   /**
 199    * Returns if this table needs to be logged
 200    *
 201    * @return boolean
 202    */
 203   function getLog() {
 204     return self::$_log;
 205   }
 206   /**
 207    * Returns the list of fields that can be imported
 208    *
 209    * @param bool $prefix
 210    *
 211    * @return array
 212    */
 213   static function &import($prefix = false) {
 214     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'location_type', $prefix, array());
 215     return $r;
 216   }
 217   /**
 218    * Returns the list of fields that can be exported
 219    *
 220    * @param bool $prefix
 221    *
 222    * @return array
 223    */
 224   static function &export($prefix = false) {
 225     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'location_type', $prefix, array());
 226     return $r;
 227   }
 228 }