Commit | Line | Data |
---|---|---|
e501603b TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
e501603b TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | /** | |
28 | * @package CRM | |
0f03f337 | 29 | * @copyright CiviCRM LLC (c) 2004-2017 |
e501603b TO |
30 | * |
31 | * Generated from xml/schema/CRM/Mailing/Spool.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
6c2b97b7 | 33 | * (GenCodeChecksum:8cdc46330195fed32b15c2560dee858d) |
e501603b TO |
34 | */ |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
f41f0342 | 37 | /** |
38 | * CRM_Mailing_DAO_Spool constructor. | |
39 | */ | |
e501603b TO |
40 | class CRM_Mailing_DAO_Spool extends CRM_Core_DAO { |
41 | /** | |
f41f0342 | 42 | * Static instance to hold the table name. |
e501603b TO |
43 | * |
44 | * @var string | |
45 | */ | |
46 | static $_tableName = 'civicrm_mailing_spool'; | |
e501603b | 47 | /** |
f41f0342 | 48 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b TO |
49 | * |
50 | * @var boolean | |
51 | */ | |
52 | static $_log = false; | |
53 | /** | |
54 | * | |
55 | * @var int unsigned | |
56 | */ | |
57 | public $id; | |
58 | /** | |
59 | * The ID of the Job . | |
60 | * | |
61 | * @var int unsigned | |
62 | */ | |
63 | public $job_id; | |
64 | /** | |
65 | * The email of the receipients this mail is to be sent. | |
66 | * | |
67 | * @var text | |
68 | */ | |
69 | public $recipient_email; | |
70 | /** | |
71 | * The header information of this mailing . | |
72 | * | |
73 | * @var text | |
74 | */ | |
75 | public $headers; | |
76 | /** | |
77 | * The body of this mailing. | |
78 | * | |
79 | * @var text | |
80 | */ | |
81 | public $body; | |
82 | /** | |
83 | * date on which this job was added. | |
84 | * | |
6c2b97b7 | 85 | * @var timestamp |
e501603b TO |
86 | */ |
87 | public $added_at; | |
88 | /** | |
89 | * date on which this job was removed. | |
90 | * | |
6c2b97b7 | 91 | * @var timestamp |
e501603b TO |
92 | */ |
93 | public $removed_at; | |
94 | /** | |
f41f0342 | 95 | * Class constructor. |
e501603b TO |
96 | */ |
97 | function __construct() { | |
98 | $this->__table = 'civicrm_mailing_spool'; | |
99 | parent::__construct(); | |
100 | } | |
101 | /** | |
f41f0342 | 102 | * Returns foreign keys and entity references. |
e501603b TO |
103 | * |
104 | * @return array | |
105 | * [CRM_Core_Reference_Interface] | |
106 | */ | |
107 | static function getReferenceColumns() { | |
346aaaba TO |
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']); | |
e501603b | 112 | } |
346aaaba | 113 | return Civi::$statics[__CLASS__]['links']; |
e501603b TO |
114 | } |
115 | /** | |
116 | * Returns all the column names of this table | |
117 | * | |
118 | * @return array | |
119 | */ | |
120 | static function &fields() { | |
346aaaba TO |
121 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
122 | Civi::$statics[__CLASS__]['fields'] = array( | |
e501603b TO |
123 | 'id' => array( |
124 | 'name' => 'id', | |
125 | 'type' => CRM_Utils_Type::T_INT, | |
126 | 'title' => ts('Spool ID') , | |
127 | 'required' => true, | |
522a26c9 | 128 | 'table_name' => 'civicrm_mailing_spool', |
129 | 'entity' => 'Spool', | |
130 | 'bao' => 'CRM_Mailing_BAO_Spool', | |
6a7e5e5d | 131 | 'localizable' => 0, |
e501603b TO |
132 | ) , |
133 | 'job_id' => array( | |
134 | 'name' => 'job_id', | |
135 | 'type' => CRM_Utils_Type::T_INT, | |
136 | 'title' => ts('Mailing Job') , | |
137 | 'description' => 'The ID of the Job .', | |
138 | 'required' => true, | |
522a26c9 | 139 | 'table_name' => 'civicrm_mailing_spool', |
140 | 'entity' => 'Spool', | |
141 | 'bao' => 'CRM_Mailing_BAO_Spool', | |
6a7e5e5d | 142 | 'localizable' => 0, |
e501603b TO |
143 | 'FKClassName' => 'CRM_Mailing_DAO_MailingJob', |
144 | ) , | |
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.', | |
522a26c9 | 150 | 'table_name' => 'civicrm_mailing_spool', |
151 | 'entity' => 'Spool', | |
152 | 'bao' => 'CRM_Mailing_BAO_Spool', | |
6a7e5e5d | 153 | 'localizable' => 0, |
e501603b TO |
154 | ) , |
155 | 'headers' => array( | |
156 | 'name' => 'headers', | |
157 | 'type' => CRM_Utils_Type::T_TEXT, | |
158 | 'title' => ts('Headers') , | |
159 | 'description' => 'The header information of this mailing .', | |
522a26c9 | 160 | 'table_name' => 'civicrm_mailing_spool', |
161 | 'entity' => 'Spool', | |
162 | 'bao' => 'CRM_Mailing_BAO_Spool', | |
6a7e5e5d | 163 | 'localizable' => 0, |
e501603b TO |
164 | ) , |
165 | 'body' => array( | |
166 | 'name' => 'body', | |
167 | 'type' => CRM_Utils_Type::T_TEXT, | |
168 | 'title' => ts('Body') , | |
169 | 'description' => 'The body of this mailing.', | |
522a26c9 | 170 | 'table_name' => 'civicrm_mailing_spool', |
171 | 'entity' => 'Spool', | |
172 | 'bao' => 'CRM_Mailing_BAO_Spool', | |
6a7e5e5d | 173 | 'localizable' => 0, |
e501603b TO |
174 | ) , |
175 | 'added_at' => array( | |
176 | 'name' => 'added_at', | |
6c2b97b7 | 177 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
e501603b TO |
178 | 'title' => ts('Added') , |
179 | 'description' => 'date on which this job was added.', | |
6c2b97b7 | 180 | 'required' => false, |
181 | 'default' => 'NULL', | |
522a26c9 | 182 | 'table_name' => 'civicrm_mailing_spool', |
183 | 'entity' => 'Spool', | |
184 | 'bao' => 'CRM_Mailing_BAO_Spool', | |
6a7e5e5d | 185 | 'localizable' => 0, |
e501603b TO |
186 | ) , |
187 | 'removed_at' => array( | |
188 | 'name' => 'removed_at', | |
6c2b97b7 | 189 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
e501603b TO |
190 | 'title' => ts('Removed') , |
191 | 'description' => 'date on which this job was removed.', | |
6c2b97b7 | 192 | 'required' => false, |
193 | 'default' => 'NULL', | |
522a26c9 | 194 | 'table_name' => 'civicrm_mailing_spool', |
195 | 'entity' => 'Spool', | |
196 | 'bao' => 'CRM_Mailing_BAO_Spool', | |
6a7e5e5d | 197 | 'localizable' => 0, |
e501603b TO |
198 | ) , |
199 | ); | |
346aaaba | 200 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 201 | } |
346aaaba | 202 | return Civi::$statics[__CLASS__]['fields']; |
e501603b TO |
203 | } |
204 | /** | |
bd8e0b14 | 205 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
206 | * |
207 | * @return array | |
bd8e0b14 | 208 | * Array(string $name => string $uniqueName). |
e501603b TO |
209 | */ |
210 | static function &fieldKeys() { | |
bd8e0b14 TO |
211 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
212 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 213 | } |
bd8e0b14 | 214 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b TO |
215 | } |
216 | /** | |
217 | * Returns the names of this table | |
218 | * | |
219 | * @return string | |
220 | */ | |
221 | static function getTableName() { | |
222 | return self::$_tableName; | |
223 | } | |
224 | /** | |
225 | * Returns if this table needs to be logged | |
226 | * | |
227 | * @return boolean | |
228 | */ | |
229 | function getLog() { | |
230 | return self::$_log; | |
231 | } | |
232 | /** | |
233 | * Returns the list of fields that can be imported | |
234 | * | |
235 | * @param bool $prefix | |
236 | * | |
237 | * @return array | |
238 | */ | |
239 | static function &import($prefix = false) { | |
60808919 TO |
240 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_spool', $prefix, array()); |
241 | return $r; | |
e501603b TO |
242 | } |
243 | /** | |
244 | * Returns the list of fields that can be exported | |
245 | * | |
246 | * @param bool $prefix | |
247 | * | |
248 | * @return array | |
249 | */ | |
250 | static function &export($prefix = false) { | |
60808919 TO |
251 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_spool', $prefix, array()); |
252 | return $r; | |
e501603b | 253 | } |
e7a6b91a AS |
254 | /** |
255 | * Returns the list of indices | |
256 | */ | |
257 | public static function indices($localize = TRUE) { | |
258 | $indices = array(); | |
259 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; | |
260 | } | |
e501603b | 261 | } |