CRM/Core/DAO/Mapping.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/Mapping.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:6ebbd7d124ddee297d44168f135ce38b)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_Mapping constructor.
  39  */
  40 class CRM_Core_DAO_Mapping extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_mapping';
  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    * Mapping ID
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Name of Mapping
  61    *
  62    * @var string
  63    */
  64   public $name;
  65   /**
  66    * Description of Mapping.
  67    *
  68    * @var string
  69    */
  70   public $description;
  71   /**
  72    * Mapping Type
  73    *
  74    * @var int unsigned
  75    */
  76   public $mapping_type_id;
  77   /**
  78    * Class constructor.
  79    */
  80   function __construct() {
  81     $this->__table = 'civicrm_mapping';
  82     parent::__construct();
  83   }
  84   /**
  85    * Returns all the column names of this table
  86    *
  87    * @return array
  88    */
  89   static function &fields() {
  90     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  91       Civi::$statics[__CLASS__]['fields'] = array(
  92         'id' => array(
  93           'name' => 'id',
  94           'type' => CRM_Utils_Type::T_INT,
  95           'title' => ts('Mapping ID') ,
  96           'description' => 'Mapping ID',
  97           'required' => true,
  98           'table_name' => 'civicrm_mapping',
  99           'entity' => 'Mapping',
 100           'bao' => 'CRM_Core_BAO_Mapping',
 101           'localizable' => 0,
 102         ) ,
 103         'name' => array(
 104           'name' => 'name',
 105           'type' => CRM_Utils_Type::T_STRING,
 106           'title' => ts('Name') ,
 107           'description' => 'Name of Mapping',
 108           'maxlength' => 64,
 109           'size' => CRM_Utils_Type::BIG,
 110           'table_name' => 'civicrm_mapping',
 111           'entity' => 'Mapping',
 112           'bao' => 'CRM_Core_BAO_Mapping',
 113           'localizable' => 0,
 114         ) ,
 115         'description' => array(
 116           'name' => 'description',
 117           'type' => CRM_Utils_Type::T_STRING,
 118           'title' => ts('Description') ,
 119           'description' => 'Description of Mapping.',
 120           'maxlength' => 255,
 121           'size' => CRM_Utils_Type::HUGE,
 122           'table_name' => 'civicrm_mapping',
 123           'entity' => 'Mapping',
 124           'bao' => 'CRM_Core_BAO_Mapping',
 125           'localizable' => 0,
 126         ) ,
 127         'mapping_type_id' => array(
 128           'name' => 'mapping_type_id',
 129           'type' => CRM_Utils_Type::T_INT,
 130           'title' => ts('Mapping Type') ,
 131           'description' => 'Mapping Type',
 132           'table_name' => 'civicrm_mapping',
 133           'entity' => 'Mapping',
 134           'bao' => 'CRM_Core_BAO_Mapping',
 135           'localizable' => 0,
 136           'html' => array(
 137             'type' => 'Select',
 138           ) ,
 139           'pseudoconstant' => array(
 140             'optionGroupName' => 'mapping_type',
 141             'optionEditPath' => 'civicrm/admin/options/mapping_type',
 142           )
 143         ) ,
 144       );
 145       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 146     }
 147     return Civi::$statics[__CLASS__]['fields'];
 148   }
 149   /**
 150    * Return a mapping from field-name to the corresponding key (as used in fields()).
 151    *
 152    * @return array
 153    *   Array(string $name => string $uniqueName).
 154    */
 155   static function &fieldKeys() {
 156     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 157       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 158     }
 159     return Civi::$statics[__CLASS__]['fieldKeys'];
 160   }
 161   /**
 162    * Returns the names of this table
 163    *
 164    * @return string
 165    */
 166   static function getTableName() {
 167     return self::$_tableName;
 168   }
 169   /**
 170    * Returns if this table needs to be logged
 171    *
 172    * @return boolean
 173    */
 174   function getLog() {
 175     return self::$_log;
 176   }
 177   /**
 178    * Returns the list of fields that can be imported
 179    *
 180    * @param bool $prefix
 181    *
 182    * @return array
 183    */
 184   static function &import($prefix = false) {
 185     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mapping', $prefix, array());
 186     return $r;
 187   }
 188   /**
 189    * Returns the list of fields that can be exported
 190    *
 191    * @param bool $prefix
 192    *
 193    * @return array
 194    */
 195   static function &export($prefix = false) {
 196     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mapping', $prefix, array());
 197     return $r;
 198   }
 199   /**
 200    * Returns the list of indices
 201    */
 202   public static function indices($localize = TRUE) {
 203     $indices = array(
 204       'UI_name' => array(
 205         'name' => 'UI_name',
 206         'field' => array(
 207           0 => 'name',
 208         ) ,
 209         'localizable' => false,
 210         'sig' => 'civicrm_mapping::0::name',
 211       ) ,
 212     );
 213     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 214   }
 215 }