CRM/Core/DAO/Mapping.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/Mapping.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:4e293e6d117828f1e2000de5a4a0d0c0)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Core_DAO_Mapping extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_mapping';
  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 = false;
  51   /**
  52    * Mapping ID
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * Name of Mapping
  59    *
  60    * @var string
  61    */
  62   public $name;
  63   /**
  64    * Description of Mapping.
  65    *
  66    * @var string
  67    */
  68   public $description;
  69   /**
  70    * Mapping Type
  71    *
  72    * @var int unsigned
  73    */
  74   public $mapping_type_id;
  75   /**
  76    * class constructor
  77    *
  78    * @return civicrm_mapping
  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         ) ,
  99         'name' => array(
 100           'name' => 'name',
 101           'type' => CRM_Utils_Type::T_STRING,
 102           'title' => ts('Name') ,
 103           'description' => 'Name of Mapping',
 104           'maxlength' => 64,
 105           'size' => CRM_Utils_Type::BIG,
 106         ) ,
 107         'description' => array(
 108           'name' => 'description',
 109           'type' => CRM_Utils_Type::T_STRING,
 110           'title' => ts('Description') ,
 111           'description' => 'Description of Mapping.',
 112           'maxlength' => 255,
 113           'size' => CRM_Utils_Type::HUGE,
 114         ) ,
 115         'mapping_type_id' => array(
 116           'name' => 'mapping_type_id',
 117           'type' => CRM_Utils_Type::T_INT,
 118           'title' => ts('Mapping Type') ,
 119           'description' => 'Mapping Type',
 120           'html' => array(
 121             'type' => 'Select',
 122           ) ,
 123           'pseudoconstant' => array(
 124             'optionGroupName' => 'mapping_type',
 125             'optionEditPath' => 'civicrm/admin/options/mapping_type',
 126           )
 127         ) ,
 128       );
 129       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 130     }
 131     return Civi::$statics[__CLASS__]['fields'];
 132   }
 133   /**
 134    * Return a mapping from field-name to the corresponding key (as used in fields()).
 135    *
 136    * @return array
 137    *   Array(string $name => string $uniqueName).
 138    */
 139   static function &fieldKeys() {
 140     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 141       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 142     }
 143     return Civi::$statics[__CLASS__]['fieldKeys'];
 144   }
 145   /**
 146    * Returns the names of this table
 147    *
 148    * @return string
 149    */
 150   static function getTableName() {
 151     return self::$_tableName;
 152   }
 153   /**
 154    * Returns if this table needs to be logged
 155    *
 156    * @return boolean
 157    */
 158   function getLog() {
 159     return self::$_log;
 160   }
 161   /**
 162    * Returns the list of fields that can be imported
 163    *
 164    * @param bool $prefix
 165    *
 166    * @return array
 167    */
 168   static function &import($prefix = false) {
 169     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mapping', $prefix, array());
 170     return $r;
 171   }
 172   /**
 173    * Returns the list of fields that can be exported
 174    *
 175    * @param bool $prefix
 176    *
 177    * @return array
 178    */
 179   static function &export($prefix = false) {
 180     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mapping', $prefix, array());
 181     return $r;
 182   }
 183 }