<?php
-/*
-+--------------------------------------------------------------------+
-| CiviCRM version 4.7 |
-+--------------------------------------------------------------------+
-| Copyright CiviCRM LLC (c) 2004-2017 |
-+--------------------------------------------------------------------+
-| This file is a part of CiviCRM. |
-| |
-| CiviCRM is free software; you can copy, modify, and distribute it |
-| under the terms of the GNU Affero General Public License |
-| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
-| |
-| CiviCRM is distributed in the hope that it will be useful, but |
-| WITHOUT ANY WARRANTY; without even the implied warranty of |
-| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
-| See the GNU Affero General Public License for more details. |
-| |
-| You should have received a copy of the GNU Affero General Public |
-| License and the CiviCRM Licensing Exception along |
-| with this program; if not, contact CiviCRM LLC |
-| at info[AT]civicrm[DOT]org. If you have questions about the |
-| GNU Affero General Public License or the licensing of CiviCRM, |
-| see the CiviCRM license FAQ at http://civicrm.org/licensing |
-+--------------------------------------------------------------------+
-*/
+
/**
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2017
*
* Generated from xml/schema/CRM/Core/Domain.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:a403ee4e3ef5f8398d0103c8a5ba1645)
+ * (GenCodeChecksum:7bc078fa4adebf142c73c95fab321f25)
+ */
+
+/**
+ * Database access object for the Domain entity.
*/
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
class CRM_Core_DAO_Domain extends CRM_Core_DAO {
+
/**
- * static instance to hold the table name
+ * Static instance to hold the table name.
*
* @var string
*/
static $_tableName = 'civicrm_domain';
+
/**
- * static value to see if we should log any modifications to
- * this table in the civicrm_log table
+ * Should CiviCRM log any modifications to this table in the civicrm_log table.
*
- * @var boolean
+ * @var bool
*/
- static $_log = false;
+ static $_log = FALSE;
+
/**
* Domain ID
*
* @var int unsigned
*/
public $id;
+
/**
* Name of Domain / Organization
*
* @var string
*/
public $name;
+
/**
* Description of Domain.
*
* @var string
*/
public $description;
+
/**
* Backend configuration.
*
* @var text
*/
public $config_backend;
+
/**
* The civicrm version this instance is running
*
* @var string
*/
public $version;
+
/**
* FK to Contact ID. This is specifically not an FK to avoid circular constraints
*
* @var int unsigned
*/
public $contact_id;
+
/**
* list of locales supported by the current db state (NULL for single-lang install)
*
* @var text
*/
public $locales;
+
/**
* Locale specific string overrides
*
* @var text
*/
public $locale_custom_strings;
+
/**
- * class constructor
- *
- * @return civicrm_domain
+ * Class constructor.
*/
- function __construct() {
+ public function __construct() {
$this->__table = 'civicrm_domain';
parent::__construct();
}
+
/**
- * Returns foreign keys and entity references
+ * Returns foreign keys and entity references.
*
* @return array
* [CRM_Core_Reference_Interface]
*/
- static function getReferenceColumns() {
+ public static function getReferenceColumns() {
if (!isset(Civi::$statics[__CLASS__]['links'])) {
Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
- Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
+ Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
}
return Civi::$statics[__CLASS__]['links'];
}
+
/**
* Returns all the column names of this table
*
* @return array
*/
- static function &fields() {
+ public static function &fields() {
if (!isset(Civi::$statics[__CLASS__]['fields'])) {
- Civi::$statics[__CLASS__]['fields'] = array(
- 'id' => array(
+ Civi::$statics[__CLASS__]['fields'] = [
+ 'id' => [
'name' => 'id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Domain ID') ,
+ 'title' => ts('Domain ID'),
'description' => 'Domain ID',
- 'required' => true,
- ) ,
- 'name' => array(
+ 'required' => TRUE,
+ 'table_name' => 'civicrm_domain',
+ 'entity' => 'Domain',
+ 'bao' => 'CRM_Core_BAO_Domain',
+ 'localizable' => 0,
+ ],
+ 'name' => [
'name' => 'name',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Domain Name') ,
+ 'title' => ts('Domain Name'),
'description' => 'Name of Domain / Organization',
'maxlength' => 64,
'size' => CRM_Utils_Type::BIG,
- 'html' => array(
+ 'table_name' => 'civicrm_domain',
+ 'entity' => 'Domain',
+ 'bao' => 'CRM_Core_BAO_Domain',
+ 'localizable' => 0,
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'description' => array(
+ ],
+ ],
+ 'description' => [
'name' => 'description',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Domain Description') ,
+ 'title' => ts('Domain Description'),
'description' => 'Description of Domain.',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
- 'html' => array(
+ 'table_name' => 'civicrm_domain',
+ 'entity' => 'Domain',
+ 'bao' => 'CRM_Core_BAO_Domain',
+ 'localizable' => 0,
+ 'html' => [
'type' => 'Text',
- ) ,
- ) ,
- 'config_backend' => array(
+ ],
+ ],
+ 'config_backend' => [
'name' => 'config_backend',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Domain Configuration') ,
+ 'title' => ts('Domain Configuration'),
'description' => 'Backend configuration.',
- 'rows' => 20,
- 'cols' => 80,
- 'html' => array(
- 'type' => 'TextArea',
- ) ,
- ) ,
- 'version' => array(
+ 'table_name' => 'civicrm_domain',
+ 'entity' => 'Domain',
+ 'bao' => 'CRM_Core_BAO_Domain',
+ 'localizable' => 0,
+ 'serialize' => self::SERIALIZE_PHP,
+ ],
+ 'version' => [
'name' => 'version',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('CiviCRM Version') ,
+ 'title' => ts('CiviCRM Version'),
'description' => 'The civicrm version this instance is running',
'maxlength' => 32,
'size' => CRM_Utils_Type::MEDIUM,
- ) ,
- 'contact_id' => array(
+ 'table_name' => 'civicrm_domain',
+ 'entity' => 'Domain',
+ 'bao' => 'CRM_Core_BAO_Domain',
+ 'localizable' => 0,
+ ],
+ 'contact_id' => [
'name' => 'contact_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Domain Contact') ,
+ 'title' => ts('Domain Contact'),
'description' => 'FK to Contact ID. This is specifically not an FK to avoid circular constraints',
+ 'table_name' => 'civicrm_domain',
+ 'entity' => 'Domain',
+ 'bao' => 'CRM_Core_BAO_Domain',
+ 'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
- ) ,
- 'locales' => array(
+ ],
+ 'locales' => [
'name' => 'locales',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Supported Languages') ,
+ 'title' => ts('Supported Languages'),
'description' => 'list of locales supported by the current db state (NULL for single-lang install)',
- ) ,
- 'locale_custom_strings' => array(
+ 'table_name' => 'civicrm_domain',
+ 'entity' => 'Domain',
+ 'bao' => 'CRM_Core_BAO_Domain',
+ 'localizable' => 0,
+ ],
+ 'locale_custom_strings' => [
'name' => 'locale_custom_strings',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Language Customizations') ,
+ 'title' => ts('Language Customizations'),
'description' => 'Locale specific string overrides',
- 'rows' => 20,
- 'cols' => 80,
- 'html' => array(
- 'type' => 'TextArea',
- ) ,
- ) ,
- );
+ 'table_name' => 'civicrm_domain',
+ 'entity' => 'Domain',
+ 'bao' => 'CRM_Core_BAO_Domain',
+ 'localizable' => 0,
+ 'serialize' => self::SERIALIZE_PHP,
+ ],
+ ];
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
}
return Civi::$statics[__CLASS__]['fields'];
}
+
/**
* Return a mapping from field-name to the corresponding key (as used in fields()).
*
* @return array
* Array(string $name => string $uniqueName).
*/
- static function &fieldKeys() {
+ public static function &fieldKeys() {
if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
}
return Civi::$statics[__CLASS__]['fieldKeys'];
}
+
/**
* Returns the names of this table
*
* @return string
*/
- static function getTableName() {
+ public static function getTableName() {
return self::$_tableName;
}
+
/**
* Returns if this table needs to be logged
*
- * @return boolean
+ * @return bool
*/
- function getLog() {
+ public function getLog() {
return self::$_log;
}
+
/**
* Returns the list of fields that can be imported
*
*
* @return array
*/
- static function &import($prefix = false) {
- $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'domain', $prefix, array());
+ public static function &import($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'domain', $prefix, []);
return $r;
}
+
/**
* Returns the list of fields that can be exported
*
*
* @return array
*/
- static function &export($prefix = false) {
- $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'domain', $prefix, array());
+ public static function &export($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'domain', $prefix, []);
return $r;
}
+
+ /**
+ * Returns the list of indices
+ *
+ * @param bool $localize
+ *
+ * @return array
+ */
+ public static function indices($localize = TRUE) {
+ $indices = [
+ 'UI_name' => [
+ 'name' => 'UI_name',
+ 'field' => [
+ 0 => 'name',
+ ],
+ 'localizable' => FALSE,
+ 'unique' => TRUE,
+ 'sig' => 'civicrm_domain::1::name',
+ ],
+ ];
+ return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
+ }
+
}