CRM/Core/DAO/JobLog.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  30  *
  31  * Generated from xml/schema/CRM/Core/JobLog.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:4b0845059b2070b57b02b8b1c6c9df50)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_JobLog constructor.
  39  */
  40 class CRM_Core_DAO_JobLog extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_job_log';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  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   /**
 102    * Class constructor.
 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() {
 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']);
 119     }
 120     return Civi::$statics[__CLASS__]['links'];
 121   }
 122   /**
 123    * Returns all the column names of this table
 124    *
 125    * @return array
 126    */
 127   static function &fields() {
 128     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 129       Civi::$statics[__CLASS__]['fields'] = array(
 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       );
 193       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 194     }
 195     return Civi::$statics[__CLASS__]['fields'];
 196   }
 197   /**
 198    * Return a mapping from field-name to the corresponding key (as used in fields()).
 199    *
 200    * @return array
 201    *   Array(string $name => string $uniqueName).
 202    */
 203   static function &fieldKeys() {
 204     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 205       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 206     }
 207     return Civi::$statics[__CLASS__]['fieldKeys'];
 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) {
 233     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'job_log', $prefix, array());
 234     return $r;
 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) {
 244     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'job_log', $prefix, array());
 245     return $r;
 246   }
 247 }