X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FDAO%2FJobLog.php;h=f441f19c34b31a8fdb0fb33b4fd9f31e2f999cb7;hb=39c3fbcda92848d435b973f403d041fff51e4d4e;hp=492425bfd907a225af1eca5fecec8b5f03b56050;hpb=c18732cfc95d18d3bec0759542376f3f4a44d07f;p=civicrm-core.git

diff --git a/CRM/Core/DAO/JobLog.php b/CRM/Core/DAO/JobLog.php
index 492425bfd9..a731638894 100644
--- a/CRM/Core/DAO/JobLog.php
+++ b/CRM/Core/DAO/JobLog.php
@@ -1,251 +1,251 @@
 <?php
-/*
-+--------------------------------------------------------------------+
-| CiviCRM version 4.7                                                |
-+--------------------------------------------------------------------+
-| Copyright CiviCRM LLC (c) 2004-2017                                |
-+--------------------------------------------------------------------+
-| This file is a part of CiviCRM.                                    |
-|                                                                    |
-| CiviCRM is free software; you can copy, modify, and distribute it  |
-| under the terms of the GNU Affero General Public License           |
-| Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
-|                                                                    |
-| CiviCRM is distributed in the hope that it will be useful, but     |
-| WITHOUT ANY WARRANTY; without even the implied warranty of         |
-| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
-| See the GNU Affero General Public License for more details.        |
-|                                                                    |
-| You should have received a copy of the GNU Affero General Public   |
-| License and the CiviCRM Licensing Exception along                  |
-| with this program; if not, contact CiviCRM LLC                     |
-| at info[AT]civicrm[DOT]org. If you have questions about the        |
-| GNU Affero General Public License or the licensing of CiviCRM,     |
-| see the CiviCRM license FAQ at http://civicrm.org/licensing        |
-+--------------------------------------------------------------------+
-*/
+
 /**
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2017
+ * @copyright CiviCRM LLC (c) 2004-2019
  *
  * Generated from xml/schema/CRM/Core/JobLog.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:8bf259a1e340e91eb72255dd7cdba531)
+ * (GenCodeChecksum:68e8b90d050e64feef2b1868d83a7923)
  */
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
 /**
- * CRM_Core_DAO_JobLog constructor.
+ * Database access object for the JobLog entity.
  */
 class CRM_Core_DAO_JobLog extends CRM_Core_DAO {
+
   /**
    * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_job_log';
+
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
-   * @var boolean
+   * @var bool
    */
-  static $_log = false;
+  static $_log = FALSE;
+
   /**
    * Job log entry Id
    *
    * @var int unsigned
    */
   public $id;
+
   /**
    * Which Domain is this scheduled job for
    *
    * @var int unsigned
    */
   public $domain_id;
+
   /**
    * Log entry date
    *
    * @var timestamp
    */
   public $run_time;
+
   /**
    * Pointer to job id - not a FK though, just for logging purposes
    *
    * @var int unsigned
    */
   public $job_id;
+
   /**
    * Title of the job
    *
    * @var string
    */
   public $name;
+
   /**
    * Full path to file containing job script
    *
    * @var string
    */
   public $command;
+
   /**
    * Title line of log entry
    *
    * @var string
    */
   public $description;
+
   /**
    * Potential extended data for specific job run (e.g. tracebacks).
    *
    * @var text
    */
   public $data;
+
   /**
    * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     $this->__table = 'civicrm_job_log';
     parent::__construct();
   }
+
   /**
    * Returns foreign keys and entity references.
    *
    * @return array
    *   [CRM_Core_Reference_Interface]
    */
-  static function getReferenceColumns() {
+  public static function getReferenceColumns() {
     if (!isset(Civi::$statics[__CLASS__]['links'])) {
       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
-      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'domain_id', 'civicrm_domain', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'domain_id', 'civicrm_domain', 'id');
       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
     }
     return Civi::$statics[__CLASS__]['links'];
   }
+
   /**
    * Returns all the column names of this table
    *
    * @return array
    */
-  static function &fields() {
+  public static function &fields() {
     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
-      Civi::$statics[__CLASS__]['fields'] = array(
-        'id' => array(
+      Civi::$statics[__CLASS__]['fields'] = [
+        'id' => [
           'name' => 'id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Job Log ID') ,
-          'description' => 'Job log entry Id',
-          'required' => true,
+          'title' => ts('Job Log ID'),
+          'description' => ts('Job log entry Id'),
+          'required' => TRUE,
           'table_name' => 'civicrm_job_log',
           'entity' => 'JobLog',
           'bao' => 'CRM_Core_DAO_JobLog',
-        ) ,
-        'domain_id' => array(
+          'localizable' => 0,
+        ],
+        'domain_id' => [
           'name' => 'domain_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Domain ID') ,
-          'description' => 'Which Domain is this scheduled job for',
-          'required' => true,
+          'title' => ts('Domain ID'),
+          'description' => ts('Which Domain is this scheduled job for'),
+          'required' => TRUE,
           'table_name' => 'civicrm_job_log',
           'entity' => 'JobLog',
           'bao' => 'CRM_Core_DAO_JobLog',
+          'localizable' => 0,
           'FKClassName' => 'CRM_Core_DAO_Domain',
-          'pseudoconstant' => array(
+          'pseudoconstant' => [
             'table' => 'civicrm_domain',
             'keyColumn' => 'id',
             'labelColumn' => 'name',
-          )
-        ) ,
-        'run_time' => array(
+          ]
+        ],
+        'run_time' => [
           'name' => 'run_time',
           'type' => CRM_Utils_Type::T_TIMESTAMP,
-          'title' => ts('Timestamp') ,
-          'description' => 'Log entry date',
+          'title' => ts('Timestamp'),
+          'description' => ts('Log entry date'),
           'table_name' => 'civicrm_job_log',
           'entity' => 'JobLog',
           'bao' => 'CRM_Core_DAO_JobLog',
-        ) ,
-        'job_id' => array(
+          'localizable' => 0,
+        ],
+        'job_id' => [
           'name' => 'job_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Job ID') ,
-          'description' => 'Pointer to job id - not a FK though, just for logging purposes',
+          'title' => ts('Job ID'),
+          'description' => ts('Pointer to job id - not a FK though, just for logging purposes'),
           'table_name' => 'civicrm_job_log',
           'entity' => 'JobLog',
           'bao' => 'CRM_Core_DAO_JobLog',
-        ) ,
-        'name' => array(
+          'localizable' => 0,
+        ],
+        'name' => [
           'name' => 'name',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Job Name') ,
-          'description' => 'Title of the job',
+          'title' => ts('Job Name'),
+          'description' => ts('Title of the job'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_job_log',
           'entity' => 'JobLog',
           'bao' => 'CRM_Core_DAO_JobLog',
-        ) ,
-        'command' => array(
+          'localizable' => 0,
+        ],
+        'command' => [
           'name' => 'command',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Command') ,
-          'description' => 'Full path to file containing job script',
+          'title' => ts('Command'),
+          'description' => ts('Full path to file containing job script'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_job_log',
           'entity' => 'JobLog',
           'bao' => 'CRM_Core_DAO_JobLog',
-        ) ,
-        'description' => array(
+          'localizable' => 0,
+        ],
+        'description' => [
           'name' => 'description',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Description') ,
-          'description' => 'Title line of log entry',
+          'title' => ts('Description'),
+          'description' => ts('Title line of log entry'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_job_log',
           'entity' => 'JobLog',
           'bao' => 'CRM_Core_DAO_JobLog',
-        ) ,
-        'data' => array(
+          'localizable' => 0,
+        ],
+        'data' => [
           'name' => 'data',
           'type' => CRM_Utils_Type::T_TEXT,
-          'title' => ts('Extended Data') ,
-          'description' => 'Potential extended data for specific job run (e.g. tracebacks).',
+          'title' => ts('Extended Data'),
+          'description' => ts('Potential extended data for specific job run (e.g. tracebacks).'),
           'table_name' => 'civicrm_job_log',
           'entity' => 'JobLog',
           'bao' => 'CRM_Core_DAO_JobLog',
-        ) ,
-      );
+          'localizable' => 0,
+        ],
+      ];
       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
     }
     return Civi::$statics[__CLASS__]['fields'];
   }
+
   /**
    * Return a mapping from field-name to the corresponding key (as used in fields()).
    *
    * @return array
    *   Array(string $name => string $uniqueName).
    */
-  static function &fieldKeys() {
+  public static function &fieldKeys() {
     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
     }
     return Civi::$statics[__CLASS__]['fieldKeys'];
   }
+
   /**
    * Returns the names of this table
    *
    * @return string
    */
-  static function getTableName() {
+  public static function getTableName() {
     return self::$_tableName;
   }
+
   /**
    * Returns if this table needs to be logged
    *
-   * @return boolean
+   * @return bool
    */
-  function getLog() {
+  public function getLog() {
     return self::$_log;
   }
+
   /**
    * Returns the list of fields that can be imported
    *
@@ -253,10 +253,11 @@ class CRM_Core_DAO_JobLog extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &import($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'job_log', $prefix, array());
+  public static function &import($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'job_log', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of fields that can be exported
    *
@@ -264,8 +265,21 @@ class CRM_Core_DAO_JobLog extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &export($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'job_log', $prefix, array());
+  public static function &export($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'job_log', $prefix, []);
     return $r;
   }
+
+  /**
+   * Returns the list of indices
+   *
+   * @param bool $localize
+   *
+   * @return array
+   */
+  public static function indices($localize = TRUE) {
+    $indices = [];
+    return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
+  }
+
 }