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/Core/JobLog.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
022785d8 | 33 | * (GenCodeChecksum:8bf259a1e340e91eb72255dd7cdba531) |
e501603b TO |
34 | */ |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
f41f0342 | 37 | /** |
38 | * CRM_Core_DAO_JobLog constructor. | |
39 | */ | |
e501603b TO |
40 | class CRM_Core_DAO_JobLog 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_job_log'; | |
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 | * Job log entry Id | |
55 | * | |
56 | * @var int unsigned | |
57 | */ | |
58 | public $id; | |
59 | /** | |
60 | * Which Domain is this scheduled job for | |
61 | * | |
62 | * @var int unsigned | |
63 | */ | |
64 | public $domain_id; | |
65 | /** | |
66 | * Log entry date | |
67 | * | |
68 | * @var timestamp | |
69 | */ | |
70 | public $run_time; | |
71 | /** | |
72 | * Pointer to job id - not a FK though, just for logging purposes | |
73 | * | |
74 | * @var int unsigned | |
75 | */ | |
76 | public $job_id; | |
77 | /** | |
78 | * Title of the job | |
79 | * | |
80 | * @var string | |
81 | */ | |
82 | public $name; | |
83 | /** | |
84 | * Full path to file containing job script | |
85 | * | |
86 | * @var string | |
87 | */ | |
88 | public $command; | |
89 | /** | |
90 | * Title line of log entry | |
91 | * | |
92 | * @var string | |
93 | */ | |
94 | public $description; | |
95 | /** | |
96 | * Potential extended data for specific job run (e.g. tracebacks). | |
97 | * | |
98 | * @var text | |
99 | */ | |
100 | public $data; | |
101 | /** | |
f41f0342 | 102 | * Class constructor. |
e501603b TO |
103 | */ |
104 | function __construct() { | |
105 | $this->__table = 'civicrm_job_log'; | |
106 | parent::__construct(); | |
107 | } | |
108 | /** | |
f41f0342 | 109 | * Returns foreign keys and entity references. |
e501603b TO |
110 | * |
111 | * @return array | |
112 | * [CRM_Core_Reference_Interface] | |
113 | */ | |
114 | static function getReferenceColumns() { | |
346aaaba TO |
115 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
116 | Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__); | |
117 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'domain_id', 'civicrm_domain', 'id'); | |
118 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); | |
e501603b | 119 | } |
346aaaba | 120 | return Civi::$statics[__CLASS__]['links']; |
e501603b TO |
121 | } |
122 | /** | |
123 | * Returns all the column names of this table | |
124 | * | |
125 | * @return array | |
126 | */ | |
127 | static function &fields() { | |
346aaaba TO |
128 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
129 | Civi::$statics[__CLASS__]['fields'] = array( | |
e501603b TO |
130 | 'id' => array( |
131 | 'name' => 'id', | |
132 | 'type' => CRM_Utils_Type::T_INT, | |
133 | 'title' => ts('Job Log ID') , | |
134 | 'description' => 'Job log entry Id', | |
135 | 'required' => true, | |
522a26c9 | 136 | 'table_name' => 'civicrm_job_log', |
137 | 'entity' => 'JobLog', | |
138 | 'bao' => 'CRM_Core_DAO_JobLog', | |
6a7e5e5d | 139 | 'localizable' => 0, |
e501603b TO |
140 | ) , |
141 | 'domain_id' => array( | |
142 | 'name' => 'domain_id', | |
143 | 'type' => CRM_Utils_Type::T_INT, | |
144 | 'title' => ts('Domain ID') , | |
145 | 'description' => 'Which Domain is this scheduled job for', | |
146 | 'required' => true, | |
522a26c9 | 147 | 'table_name' => 'civicrm_job_log', |
148 | 'entity' => 'JobLog', | |
149 | 'bao' => 'CRM_Core_DAO_JobLog', | |
6a7e5e5d | 150 | 'localizable' => 0, |
e501603b TO |
151 | 'FKClassName' => 'CRM_Core_DAO_Domain', |
152 | 'pseudoconstant' => array( | |
153 | 'table' => 'civicrm_domain', | |
154 | 'keyColumn' => 'id', | |
155 | 'labelColumn' => 'name', | |
156 | ) | |
157 | ) , | |
158 | 'run_time' => array( | |
159 | 'name' => 'run_time', | |
160 | 'type' => CRM_Utils_Type::T_TIMESTAMP, | |
161 | 'title' => ts('Timestamp') , | |
162 | 'description' => 'Log entry date', | |
522a26c9 | 163 | 'table_name' => 'civicrm_job_log', |
164 | 'entity' => 'JobLog', | |
165 | 'bao' => 'CRM_Core_DAO_JobLog', | |
6a7e5e5d | 166 | 'localizable' => 0, |
e501603b TO |
167 | ) , |
168 | 'job_id' => array( | |
169 | 'name' => 'job_id', | |
170 | 'type' => CRM_Utils_Type::T_INT, | |
171 | 'title' => ts('Job ID') , | |
172 | 'description' => 'Pointer to job id - not a FK though, just for logging purposes', | |
522a26c9 | 173 | 'table_name' => 'civicrm_job_log', |
174 | 'entity' => 'JobLog', | |
175 | 'bao' => 'CRM_Core_DAO_JobLog', | |
6a7e5e5d | 176 | 'localizable' => 0, |
e501603b TO |
177 | ) , |
178 | 'name' => array( | |
179 | 'name' => 'name', | |
180 | 'type' => CRM_Utils_Type::T_STRING, | |
181 | 'title' => ts('Job Name') , | |
182 | 'description' => 'Title of the job', | |
183 | 'maxlength' => 255, | |
184 | 'size' => CRM_Utils_Type::HUGE, | |
522a26c9 | 185 | 'table_name' => 'civicrm_job_log', |
186 | 'entity' => 'JobLog', | |
187 | 'bao' => 'CRM_Core_DAO_JobLog', | |
6a7e5e5d | 188 | 'localizable' => 0, |
e501603b TO |
189 | ) , |
190 | 'command' => array( | |
191 | 'name' => 'command', | |
192 | 'type' => CRM_Utils_Type::T_STRING, | |
193 | 'title' => ts('Command') , | |
194 | 'description' => 'Full path to file containing job script', | |
195 | 'maxlength' => 255, | |
196 | 'size' => CRM_Utils_Type::HUGE, | |
522a26c9 | 197 | 'table_name' => 'civicrm_job_log', |
198 | 'entity' => 'JobLog', | |
199 | 'bao' => 'CRM_Core_DAO_JobLog', | |
6a7e5e5d | 200 | 'localizable' => 0, |
e501603b TO |
201 | ) , |
202 | 'description' => array( | |
203 | 'name' => 'description', | |
204 | 'type' => CRM_Utils_Type::T_STRING, | |
205 | 'title' => ts('Description') , | |
206 | 'description' => 'Title line of log entry', | |
207 | 'maxlength' => 255, | |
208 | 'size' => CRM_Utils_Type::HUGE, | |
522a26c9 | 209 | 'table_name' => 'civicrm_job_log', |
210 | 'entity' => 'JobLog', | |
211 | 'bao' => 'CRM_Core_DAO_JobLog', | |
6a7e5e5d | 212 | 'localizable' => 0, |
e501603b TO |
213 | ) , |
214 | 'data' => array( | |
215 | 'name' => 'data', | |
216 | 'type' => CRM_Utils_Type::T_TEXT, | |
217 | 'title' => ts('Extended Data') , | |
218 | 'description' => 'Potential extended data for specific job run (e.g. tracebacks).', | |
522a26c9 | 219 | 'table_name' => 'civicrm_job_log', |
220 | 'entity' => 'JobLog', | |
221 | 'bao' => 'CRM_Core_DAO_JobLog', | |
6a7e5e5d | 222 | 'localizable' => 0, |
e501603b TO |
223 | ) , |
224 | ); | |
346aaaba | 225 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 226 | } |
346aaaba | 227 | return Civi::$statics[__CLASS__]['fields']; |
e501603b TO |
228 | } |
229 | /** | |
bd8e0b14 | 230 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
231 | * |
232 | * @return array | |
bd8e0b14 | 233 | * Array(string $name => string $uniqueName). |
e501603b TO |
234 | */ |
235 | static function &fieldKeys() { | |
bd8e0b14 TO |
236 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
237 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 238 | } |
bd8e0b14 | 239 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b TO |
240 | } |
241 | /** | |
242 | * Returns the names of this table | |
243 | * | |
244 | * @return string | |
245 | */ | |
246 | static function getTableName() { | |
247 | return self::$_tableName; | |
248 | } | |
249 | /** | |
250 | * Returns if this table needs to be logged | |
251 | * | |
252 | * @return boolean | |
253 | */ | |
254 | function getLog() { | |
255 | return self::$_log; | |
256 | } | |
257 | /** | |
258 | * Returns the list of fields that can be imported | |
259 | * | |
260 | * @param bool $prefix | |
261 | * | |
262 | * @return array | |
263 | */ | |
264 | static function &import($prefix = false) { | |
60808919 TO |
265 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'job_log', $prefix, array()); |
266 | return $r; | |
e501603b TO |
267 | } |
268 | /** | |
269 | * Returns the list of fields that can be exported | |
270 | * | |
271 | * @param bool $prefix | |
272 | * | |
273 | * @return array | |
274 | */ | |
275 | static function &export($prefix = false) { | |
60808919 TO |
276 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'job_log', $prefix, array()); |
277 | return $r; | |
e501603b | 278 | } |
e7a6b91a AS |
279 | /** |
280 | * Returns the list of indices | |
281 | */ | |
282 | public static function indices($localize = TRUE) { | |
283 | $indices = array(); | |
284 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; | |
285 | } | |
e501603b | 286 | } |