Commit | Line | Data |
---|---|---|
e501603b TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2016 | | |
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 | |
29 | * @copyright CiviCRM LLC (c) 2004-2016 | |
30 | * | |
31 | * Generated from xml/schema/CRM/Core/JobLog.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
437fafcf | 33 | * (GenCodeChecksum:4b0845059b2070b57b02b8b1c6c9df50) |
e501603b TO |
34 | */ |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
37 | class CRM_Core_DAO_JobLog extends CRM_Core_DAO { | |
38 | /** | |
39 | * static instance to hold the table name | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | static $_tableName = 'civicrm_job_log'; | |
e501603b TO |
44 | /** |
45 | * static value to see if we should log any modifications to | |
46 | * this table in the civicrm_log table | |
47 | * | |
48 | * @var boolean | |
49 | */ | |
50 | static $_log = false; | |
51 | /** | |
52 | * Job log entry Id | |
53 | * | |
54 | * @var int unsigned | |
55 | */ | |
56 | public $id; | |
57 | /** | |
58 | * Which Domain is this scheduled job for | |
59 | * | |
60 | * @var int unsigned | |
61 | */ | |
62 | public $domain_id; | |
63 | /** | |
64 | * Log entry date | |
65 | * | |
66 | * @var timestamp | |
67 | */ | |
68 | public $run_time; | |
69 | /** | |
70 | * Pointer to job id - not a FK though, just for logging purposes | |
71 | * | |
72 | * @var int unsigned | |
73 | */ | |
74 | public $job_id; | |
75 | /** | |
76 | * Title of the job | |
77 | * | |
78 | * @var string | |
79 | */ | |
80 | public $name; | |
81 | /** | |
82 | * Full path to file containing job script | |
83 | * | |
84 | * @var string | |
85 | */ | |
86 | public $command; | |
87 | /** | |
88 | * Title line of log entry | |
89 | * | |
90 | * @var string | |
91 | */ | |
92 | public $description; | |
93 | /** | |
94 | * Potential extended data for specific job run (e.g. tracebacks). | |
95 | * | |
96 | * @var text | |
97 | */ | |
98 | public $data; | |
99 | /** | |
100 | * class constructor | |
101 | * | |
102 | * @return civicrm_job_log | |
103 | */ | |
104 | function __construct() { | |
105 | $this->__table = 'civicrm_job_log'; | |
106 | parent::__construct(); | |
107 | } | |
108 | /** | |
109 | * Returns foreign keys and entity references | |
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, | |
136 | ) , | |
137 | 'domain_id' => array( | |
138 | 'name' => 'domain_id', | |
139 | 'type' => CRM_Utils_Type::T_INT, | |
140 | 'title' => ts('Domain ID') , | |
141 | 'description' => 'Which Domain is this scheduled job for', | |
142 | 'required' => true, | |
143 | 'FKClassName' => 'CRM_Core_DAO_Domain', | |
144 | 'pseudoconstant' => array( | |
145 | 'table' => 'civicrm_domain', | |
146 | 'keyColumn' => 'id', | |
147 | 'labelColumn' => 'name', | |
148 | ) | |
149 | ) , | |
150 | 'run_time' => array( | |
151 | 'name' => 'run_time', | |
152 | 'type' => CRM_Utils_Type::T_TIMESTAMP, | |
153 | 'title' => ts('Timestamp') , | |
154 | 'description' => 'Log entry date', | |
155 | ) , | |
156 | 'job_id' => array( | |
157 | 'name' => 'job_id', | |
158 | 'type' => CRM_Utils_Type::T_INT, | |
159 | 'title' => ts('Job ID') , | |
160 | 'description' => 'Pointer to job id - not a FK though, just for logging purposes', | |
161 | ) , | |
162 | 'name' => array( | |
163 | 'name' => 'name', | |
164 | 'type' => CRM_Utils_Type::T_STRING, | |
165 | 'title' => ts('Job Name') , | |
166 | 'description' => 'Title of the job', | |
167 | 'maxlength' => 255, | |
168 | 'size' => CRM_Utils_Type::HUGE, | |
169 | ) , | |
170 | 'command' => array( | |
171 | 'name' => 'command', | |
172 | 'type' => CRM_Utils_Type::T_STRING, | |
173 | 'title' => ts('Command') , | |
174 | 'description' => 'Full path to file containing job script', | |
175 | 'maxlength' => 255, | |
176 | 'size' => CRM_Utils_Type::HUGE, | |
177 | ) , | |
178 | 'description' => array( | |
179 | 'name' => 'description', | |
180 | 'type' => CRM_Utils_Type::T_STRING, | |
181 | 'title' => ts('Description') , | |
182 | 'description' => 'Title line of log entry', | |
183 | 'maxlength' => 255, | |
184 | 'size' => CRM_Utils_Type::HUGE, | |
185 | ) , | |
186 | 'data' => array( | |
187 | 'name' => 'data', | |
188 | 'type' => CRM_Utils_Type::T_TEXT, | |
189 | 'title' => ts('Extended Data') , | |
190 | 'description' => 'Potential extended data for specific job run (e.g. tracebacks).', | |
191 | ) , | |
192 | ); | |
346aaaba | 193 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 194 | } |
346aaaba | 195 | return Civi::$statics[__CLASS__]['fields']; |
e501603b TO |
196 | } |
197 | /** | |
bd8e0b14 | 198 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
199 | * |
200 | * @return array | |
bd8e0b14 | 201 | * Array(string $name => string $uniqueName). |
e501603b TO |
202 | */ |
203 | static function &fieldKeys() { | |
bd8e0b14 TO |
204 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
205 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 206 | } |
bd8e0b14 | 207 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b TO |
208 | } |
209 | /** | |
210 | * Returns the names of this table | |
211 | * | |
212 | * @return string | |
213 | */ | |
214 | static function getTableName() { | |
215 | return self::$_tableName; | |
216 | } | |
217 | /** | |
218 | * Returns if this table needs to be logged | |
219 | * | |
220 | * @return boolean | |
221 | */ | |
222 | function getLog() { | |
223 | return self::$_log; | |
224 | } | |
225 | /** | |
226 | * Returns the list of fields that can be imported | |
227 | * | |
228 | * @param bool $prefix | |
229 | * | |
230 | * @return array | |
231 | */ | |
232 | static function &import($prefix = false) { | |
60808919 TO |
233 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'job_log', $prefix, array()); |
234 | return $r; | |
e501603b TO |
235 | } |
236 | /** | |
237 | * Returns the list of fields that can be exported | |
238 | * | |
239 | * @param bool $prefix | |
240 | * | |
241 | * @return array | |
242 | */ | |
243 | static function &export($prefix = false) { | |
60808919 TO |
244 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'job_log', $prefix, array()); |
245 | return $r; | |
e501603b TO |
246 | } |
247 | } |