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