<?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
+ * @copyright CiviCRM LLC (c) 2004-2018
*
* Generated from xml/schema/CRM/Mailing/Component.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
* (GenCodeChecksum:33742feaa53eaba2c4a543c4e5c673ab)
*/
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
/**
- * CRM_Mailing_DAO_Component constructor.
+ * Database access object for the Component entity.
*/
class CRM_Mailing_DAO_Component extends CRM_Core_DAO {
+
/**
* Static instance to hold the table name.
*
* @var string
*/
static $_tableName = 'civicrm_mailing_component';
+
/**
* 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;
+
/**
* The name of this component
*
* @var string
*/
public $name;
+
/**
* Type of Component.
*
* @var string
*/
public $component_type;
+
/**
- *
* @var string
*/
public $subject;
+
/**
* Body of the component in html format.
*
* @var text
*/
public $body_html;
+
/**
* Body of the component in text format.
*
* @var text
*/
public $body_text;
+
/**
* Is this the default component for this component_type?
*
* @var boolean
*/
public $is_default;
+
/**
* Is this property active?
*
* @var boolean
*/
public $is_active;
+
/**
* Class constructor.
*/
- function __construct() {
+ public function __construct() {
$this->__table = 'civicrm_mailing_component';
parent::__construct();
}
+
/**
* 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('Mailing Component ID') ,
- 'required' => true,
+ 'title' => ts('Mailing Component ID'),
+ 'required' => TRUE,
'table_name' => 'civicrm_mailing_component',
'entity' => 'Component',
'bao' => 'CRM_Mailing_BAO_Component',
'localizable' => 0,
- ) ,
- 'name' => array(
+ ],
+ 'name' => [
'name' => 'name',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Component Name') ,
+ 'title' => ts('Component Name'),
'description' => 'The name of this component',
'maxlength' => 64,
'size' => CRM_Utils_Type::BIG,
'entity' => 'Component',
'bao' => 'CRM_Mailing_BAO_Component',
'localizable' => 0,
- ) ,
- 'component_type' => array(
+ ],
+ 'component_type' => [
'name' => 'component_type',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Mailing Component Type') ,
+ 'title' => ts('Mailing Component Type'),
'description' => 'Type of Component.',
'maxlength' => 12,
'size' => CRM_Utils_Type::TWELVE,
'entity' => 'Component',
'bao' => 'CRM_Mailing_BAO_Component',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'Select',
- ) ,
- 'pseudoconstant' => array(
+ ],
+ 'pseudoconstant' => [
'callback' => 'CRM_Core_SelectValues::mailingComponents',
- )
- ) ,
- 'subject' => array(
+ ]
+ ],
+ 'subject' => [
'name' => 'subject',
'type' => CRM_Utils_Type::T_STRING,
- 'title' => ts('Subject') ,
+ 'title' => ts('Subject'),
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'table_name' => 'civicrm_mailing_component',
'entity' => 'Component',
'bao' => 'CRM_Mailing_BAO_Component',
'localizable' => 0,
- ) ,
- 'body_html' => array(
+ ],
+ 'body_html' => [
'name' => 'body_html',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Mailing Component Body HTML') ,
+ 'title' => ts('Mailing Component Body HTML'),
'description' => 'Body of the component in html format.',
'rows' => 8,
'cols' => 80,
'entity' => 'Component',
'bao' => 'CRM_Mailing_BAO_Component',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'TextArea',
- ) ,
- ) ,
- 'body_text' => array(
+ ],
+ ],
+ 'body_text' => [
'name' => 'body_text',
'type' => CRM_Utils_Type::T_TEXT,
- 'title' => ts('Body Text') ,
+ 'title' => ts('Body Text'),
'description' => 'Body of the component in text format.',
'rows' => 8,
'cols' => 80,
'entity' => 'Component',
'bao' => 'CRM_Mailing_BAO_Component',
'localizable' => 0,
- 'html' => array(
+ 'html' => [
'type' => 'TextArea',
- ) ,
- ) ,
- 'is_default' => array(
+ ],
+ ],
+ 'is_default' => [
'name' => 'is_default',
'type' => CRM_Utils_Type::T_BOOLEAN,
- 'title' => ts('Mailing Component is Default?') ,
+ 'title' => ts('Mailing Component is Default?'),
'description' => 'Is this the default component for this component_type?',
'table_name' => 'civicrm_mailing_component',
'entity' => 'Component',
'bao' => 'CRM_Mailing_BAO_Component',
'localizable' => 0,
- ) ,
- 'is_active' => array(
+ ],
+ 'is_active' => [
'name' => 'is_active',
'type' => CRM_Utils_Type::T_BOOLEAN,
- 'title' => ts('Mailing Component Is Active?') ,
+ 'title' => ts('Mailing Component Is Active?'),
'description' => 'Is this property active?',
'table_name' => 'civicrm_mailing_component',
'entity' => 'Component',
'bao' => 'CRM_Mailing_BAO_Component',
'localizable' => 0,
- ) ,
- );
+ ],
+ ];
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__, 'mailing_component', $prefix, array());
+ public static function &import($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_component', $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__, 'mailing_component', $prefix, array());
+ public static function &export($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_component', $prefix, []);
return $r;
}
+
/**
* Returns the list of indices
+ *
+ * @param bool $localize
+ *
+ * @return array
*/
public static function indices($localize = TRUE) {
- $indices = array();
+ $indices = [];
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
}
+
}