<?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/Setting.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:a9b0b7aaf6ae42696ce402c1ff9acb89)
+ * (GenCodeChecksum:5aa73137509e3760555c0f3d1d746b05)
*/
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
/**
- * CRM_Core_DAO_Setting constructor.
+ * Database access object for the Setting entity.
*/
class CRM_Core_DAO_Setting extends CRM_Core_DAO {
+
/**
* Static instance to hold the table name.
*
* @var string
*/
static $_tableName = 'civicrm_setting';
+
/**
* Should CiviCRM log any modifications to this table in the civicrm_log table.
*
- * @var boolean
+ * @var bool
*/
- static $_log = false;
+ static $_log = FALSE;
+
/**
- *
* @var int unsigned
*/
public $id;
+
/**
* Unique name for setting
*
* @var string
*/
public $name;
+
/**
* data associated with this group / name combo
*
* @var text
*/
public $value;
+
/**
* Which Domain is this menu item for
*
* @var int unsigned
*/
public $domain_id;
+
/**
* FK to Contact ID if the setting is localized to a contact
*
* @var int unsigned
*/
public $contact_id;
+
/**
* Is this setting a contact specific or site wide setting?
*
* @var boolean
*/
public $is_domain;
+
/**
* Component that this menu item belongs to
*
* @var int unsigned
*/
public $component_id;
+
/**
* When was the setting created
*
* @var datetime
*/
public $created_date;
+
/**
* FK to civicrm_contact, who created this setting
*
* @var int unsigned
*/
public $created_id;
+
/**
* Class constructor.
*/
- function __construct() {
+ public function __construct() {
$this->__table = 'civicrm_setting';
parent::__construct();
}
+
/**
* 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() , 'domain_id', 'civicrm_domain', 'id');
- 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() , 'component_id', 'civicrm_component', 'id');
- Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'created_id', 'civicrm_contact', 'id');
+ Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'domain_id', 'civicrm_domain', 'id');
+ 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(), 'component_id', 'civicrm_component', 'id');
+ Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_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('Setting ID') ,
- 'required' => true,
+ 'title' => ts('Setting ID'),
+ 'required' => TRUE,
'table_name' => 'civicrm_setting',
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
- ) ,
- 'name' => array(
+ ],
+ 'name' => [
'name' => 'name',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Setting Name') ,
+ 'title' => ts('Setting Name'),
'description' => 'Unique name for setting',
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
- ) ,
- 'value' => array(
+ ],
+ 'value' => [
'name' => 'value',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Value') ,
+ 'title' => ts('Value'),
'description' => 'data associated with this group / name combo',
'table_name' => 'civicrm_setting',
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
- ) ,
- 'domain_id' => array(
+ 'serialize' => self::SERIALIZE_PHP,
+ ],
+ 'domain_id' => [
'name' => 'domain_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Setting Domain') ,
+ 'title' => ts('Setting Domain'),
'description' => 'Which Domain is this menu item for',
- 'required' => true,
+ 'required' => TRUE,
'table_name' => 'civicrm_setting',
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
'FKClassName' => 'CRM_Core_DAO_Domain',
- 'pseudoconstant' => array(
+ 'pseudoconstant' => [
'table' => 'civicrm_domain',
'keyColumn' => 'id',
'labelColumn' => 'name',
- )
- ) ,
- 'contact_id' => array(
+ ]
+ ],
+ 'contact_id' => [
'name' => 'contact_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Setting Contact') ,
+ 'title' => ts('Setting Contact'),
'description' => 'FK to Contact ID if the setting is localized to a contact',
'table_name' => 'civicrm_setting',
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
- ) ,
- 'is_domain' => array(
+ ],
+ 'is_domain' => [
'name' => 'is_domain',
'type' => CRM_Utils_Type::T_BOOLEAN,
- 'title' => ts('Is Domain Setting?') ,
+ 'title' => ts('Is Domain Setting?'),
'description' => 'Is this setting a contact specific or site wide setting?',
'table_name' => 'civicrm_setting',
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
- ) ,
- 'component_id' => array(
+ ],
+ 'component_id' => [
'name' => 'component_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Setting Component') ,
+ 'title' => ts('Setting Component'),
'description' => 'Component that this menu item belongs to',
'table_name' => 'civicrm_setting',
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
'FKClassName' => 'CRM_Core_DAO_Component',
- 'html' => array(
+ 'html' => [
'type' => 'Select',
- ) ,
- 'pseudoconstant' => array(
+ ],
+ 'pseudoconstant' => [
'table' => 'civicrm_component',
'keyColumn' => 'id',
'labelColumn' => 'name',
- )
- ) ,
- 'created_date' => array(
+ ]
+ ],
+ 'created_date' => [
'name' => 'created_date',
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
- 'title' => ts('Setting Created Date') ,
+ 'title' => ts('Setting Created Date'),
'description' => 'When was the setting created',
'table_name' => 'civicrm_setting',
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
- ) ,
- 'created_id' => array(
+ ],
+ 'created_id' => [
'name' => 'created_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Setting Created By') ,
+ 'title' => ts('Setting Created By'),
'description' => 'FK to civicrm_contact, who created this setting',
'table_name' => 'civicrm_setting',
'entity' => 'Setting',
'bao' => 'CRM_Core_BAO_Setting',
'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
- ) ,
- );
+ ],
+ ];
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__, 'setting', $prefix, array());
+ public static function &import($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'setting', $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__, 'setting', $prefix, array());
+ public static function &export($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'setting', $prefix, []);
return $r;
}
+
/**
* Returns the list of indices
+ *
+ * @param bool $localize
+ *
+ * @return array
*/
public static function indices($localize = TRUE) {
- $indices = array(
- 'index_domain_contact_name' => array(
+ $indices = [
+ 'index_domain_contact_name' => [
'name' => 'index_domain_contact_name',
- 'field' => array(
+ 'field' => [
0 => 'domain_id',
1 => 'contact_id',
2 => 'name',
- ) ,
- 'localizable' => false,
- 'unique' => true,
+ ],
+ 'localizable' => FALSE,
+ 'unique' => TRUE,
'sig' => 'civicrm_setting::1::domain_id::contact_id::name',
- ) ,
- );
+ ],
+ ];
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
}
+
}
projects / civicrm-core.git / blobdiff