3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2017
31 * Generated from xml/schema/CRM/Mailing/Spool.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:8cdc46330195fed32b15c2560dee858d)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Mailing_DAO_Spool constructor.
40 class CRM_Mailing_DAO_Spool
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_mailing_spool';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
65 * The email of the receipients this mail is to be sent.
69 public $recipient_email;
71 * The header information of this mailing .
77 * The body of this mailing.
83 * date on which this job was added.
89 * date on which this job was removed.
97 function __construct() {
98 $this->__table
= 'civicrm_mailing_spool';
99 parent
::__construct();
102 * Returns foreign keys and entity references.
105 * [CRM_Core_Reference_Interface]
107 static function getReferenceColumns() {
108 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
109 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
110 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'job_id', 'civicrm_mailing_job', 'id');
111 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
113 return Civi
::$statics[__CLASS__
]['links'];
116 * Returns all the column names of this table
120 static function &fields() {
121 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
122 Civi
::$statics[__CLASS__
]['fields'] = array(
125 'type' => CRM_Utils_Type
::T_INT
,
126 'title' => ts('Spool ID') ,
128 'table_name' => 'civicrm_mailing_spool',
130 'bao' => 'CRM_Mailing_BAO_Spool',
135 'type' => CRM_Utils_Type
::T_INT
,
136 'title' => ts('Mailing Job') ,
137 'description' => 'The ID of the Job .',
139 'table_name' => 'civicrm_mailing_spool',
141 'bao' => 'CRM_Mailing_BAO_Spool',
143 'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
145 'recipient_email' => array(
146 'name' => 'recipient_email',
147 'type' => CRM_Utils_Type
::T_TEXT
,
148 'title' => ts('Recipient Email') ,
149 'description' => 'The email of the receipients this mail is to be sent.',
150 'table_name' => 'civicrm_mailing_spool',
152 'bao' => 'CRM_Mailing_BAO_Spool',
157 'type' => CRM_Utils_Type
::T_TEXT
,
158 'title' => ts('Headers') ,
159 'description' => 'The header information of this mailing .',
160 'table_name' => 'civicrm_mailing_spool',
162 'bao' => 'CRM_Mailing_BAO_Spool',
167 'type' => CRM_Utils_Type
::T_TEXT
,
168 'title' => ts('Body') ,
169 'description' => 'The body of this mailing.',
170 'table_name' => 'civicrm_mailing_spool',
172 'bao' => 'CRM_Mailing_BAO_Spool',
176 'name' => 'added_at',
177 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
178 'title' => ts('Added') ,
179 'description' => 'date on which this job was added.',
182 'table_name' => 'civicrm_mailing_spool',
184 'bao' => 'CRM_Mailing_BAO_Spool',
187 'removed_at' => array(
188 'name' => 'removed_at',
189 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
190 'title' => ts('Removed') ,
191 'description' => 'date on which this job was removed.',
194 'table_name' => 'civicrm_mailing_spool',
196 'bao' => 'CRM_Mailing_BAO_Spool',
200 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
202 return Civi
::$statics[__CLASS__
]['fields'];
205 * Return a mapping from field-name to the corresponding key (as used in fields()).
208 * Array(string $name => string $uniqueName).
210 static function &fieldKeys() {
211 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
212 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
214 return Civi
::$statics[__CLASS__
]['fieldKeys'];
217 * Returns the names of this table
221 static function getTableName() {
222 return self
::$_tableName;
225 * Returns if this table needs to be logged
233 * Returns the list of fields that can be imported
235 * @param bool $prefix
239 static function &import($prefix = false) {
240 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_spool', $prefix, array());
244 * Returns the list of fields that can be exported
246 * @param bool $prefix
250 static function &export($prefix = false) {
251 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_spool', $prefix, array());
255 * Returns the list of indices
257 public static function indices($localize = TRUE) {
259 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;