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/Core/JobLog.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:8bf259a1e340e91eb72255dd7cdba531)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Core_DAO_JobLog constructor.
40 class CRM_Core_DAO_JobLog
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_job_log';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
60 * Which Domain is this scheduled job for
72 * Pointer to job id - not a FK though, just for logging purposes
84 * Full path to file containing job script
90 * Title line of log entry
96 * Potential extended data for specific job run (e.g. tracebacks).
104 function __construct() {
105 $this->__table
= 'civicrm_job_log';
106 parent
::__construct();
109 * Returns foreign keys and entity references.
112 * [CRM_Core_Reference_Interface]
114 static function getReferenceColumns() {
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']);
120 return Civi
::$statics[__CLASS__
]['links'];
123 * Returns all the column names of this table
127 static function &fields() {
128 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
129 Civi
::$statics[__CLASS__
]['fields'] = array(
132 'type' => CRM_Utils_Type
::T_INT
,
133 'title' => ts('Job Log ID') ,
134 'description' => 'Job log entry Id',
136 'table_name' => 'civicrm_job_log',
137 'entity' => 'JobLog',
138 'bao' => 'CRM_Core_DAO_JobLog',
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',
147 'table_name' => 'civicrm_job_log',
148 'entity' => 'JobLog',
149 'bao' => 'CRM_Core_DAO_JobLog',
151 'FKClassName' => 'CRM_Core_DAO_Domain',
152 'pseudoconstant' => array(
153 'table' => 'civicrm_domain',
155 'labelColumn' => 'name',
159 'name' => 'run_time',
160 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
161 'title' => ts('Timestamp') ,
162 'description' => 'Log entry date',
163 'table_name' => 'civicrm_job_log',
164 'entity' => 'JobLog',
165 'bao' => 'CRM_Core_DAO_JobLog',
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',
173 'table_name' => 'civicrm_job_log',
174 'entity' => 'JobLog',
175 'bao' => 'CRM_Core_DAO_JobLog',
180 'type' => CRM_Utils_Type
::T_STRING
,
181 'title' => ts('Job Name') ,
182 'description' => 'Title of the job',
184 'size' => CRM_Utils_Type
::HUGE
,
185 'table_name' => 'civicrm_job_log',
186 'entity' => 'JobLog',
187 'bao' => 'CRM_Core_DAO_JobLog',
192 'type' => CRM_Utils_Type
::T_STRING
,
193 'title' => ts('Command') ,
194 'description' => 'Full path to file containing job script',
196 'size' => CRM_Utils_Type
::HUGE
,
197 'table_name' => 'civicrm_job_log',
198 'entity' => 'JobLog',
199 'bao' => 'CRM_Core_DAO_JobLog',
202 'description' => array(
203 'name' => 'description',
204 'type' => CRM_Utils_Type
::T_STRING
,
205 'title' => ts('Description') ,
206 'description' => 'Title line of log entry',
208 'size' => CRM_Utils_Type
::HUGE
,
209 'table_name' => 'civicrm_job_log',
210 'entity' => 'JobLog',
211 'bao' => 'CRM_Core_DAO_JobLog',
216 'type' => CRM_Utils_Type
::T_TEXT
,
217 'title' => ts('Extended Data') ,
218 'description' => 'Potential extended data for specific job run (e.g. tracebacks).',
219 'table_name' => 'civicrm_job_log',
220 'entity' => 'JobLog',
221 'bao' => 'CRM_Core_DAO_JobLog',
225 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
227 return Civi
::$statics[__CLASS__
]['fields'];
230 * Return a mapping from field-name to the corresponding key (as used in fields()).
233 * Array(string $name => string $uniqueName).
235 static function &fieldKeys() {
236 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
237 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
239 return Civi
::$statics[__CLASS__
]['fieldKeys'];
242 * Returns the names of this table
246 static function getTableName() {
247 return self
::$_tableName;
250 * Returns if this table needs to be logged
258 * Returns the list of fields that can be imported
260 * @param bool $prefix
264 static function &import($prefix = false) {
265 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'job_log', $prefix, array());
269 * Returns the list of fields that can be exported
271 * @param bool $prefix
275 static function &export($prefix = false) {
276 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'job_log', $prefix, array());