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:1062bf7f253de6cdb25f4a434249b050)
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',
134 'type' => CRM_Utils_Type
::T_INT
,
135 'title' => ts('Mailing Job') ,
136 'description' => 'The ID of the Job .',
138 'table_name' => 'civicrm_mailing_spool',
140 'bao' => 'CRM_Mailing_BAO_Spool',
141 'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
143 'recipient_email' => array(
144 'name' => 'recipient_email',
145 'type' => CRM_Utils_Type
::T_TEXT
,
146 'title' => ts('Recipient Email') ,
147 'description' => 'The email of the receipients this mail is to be sent.',
148 'table_name' => 'civicrm_mailing_spool',
150 'bao' => 'CRM_Mailing_BAO_Spool',
154 'type' => CRM_Utils_Type
::T_TEXT
,
155 'title' => ts('Headers') ,
156 'description' => 'The header information of this mailing .',
157 'table_name' => 'civicrm_mailing_spool',
159 'bao' => 'CRM_Mailing_BAO_Spool',
163 'type' => CRM_Utils_Type
::T_TEXT
,
164 'title' => ts('Body') ,
165 'description' => 'The body of this mailing.',
166 'table_name' => 'civicrm_mailing_spool',
168 'bao' => 'CRM_Mailing_BAO_Spool',
171 'name' => 'added_at',
172 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
173 'title' => ts('Added') ,
174 'description' => 'date on which this job was added.',
175 'table_name' => 'civicrm_mailing_spool',
177 'bao' => 'CRM_Mailing_BAO_Spool',
179 'removed_at' => array(
180 'name' => 'removed_at',
181 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
182 'title' => ts('Removed') ,
183 'description' => 'date on which this job was removed.',
184 'table_name' => 'civicrm_mailing_spool',
186 'bao' => 'CRM_Mailing_BAO_Spool',
189 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
191 return Civi
::$statics[__CLASS__
]['fields'];
194 * Return a mapping from field-name to the corresponding key (as used in fields()).
197 * Array(string $name => string $uniqueName).
199 static function &fieldKeys() {
200 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
201 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
203 return Civi
::$statics[__CLASS__
]['fieldKeys'];
206 * Returns the names of this table
210 static function getTableName() {
211 return self
::$_tableName;
214 * Returns if this table needs to be logged
222 * Returns the list of fields that can be imported
224 * @param bool $prefix
228 static function &import($prefix = false) {
229 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_spool', $prefix, array());
233 * Returns the list of fields that can be exported
235 * @param bool $prefix
239 static function &export($prefix = false) {
240 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_spool', $prefix, array());