X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FDAO%2FJob.php;h=2a3abb54f68a9457bf3d5b71a9652781dc734959;hb=c3fc2621677b114dd8b622ef88a3ceec0ffbcf59;hp=81fe117fbf9e36f77035bce8c041b637c15eaf11;hpb=c0b7357c175880a35b5237a92119c3a368be1ac6;p=civicrm-core.git

diff --git a/CRM/Core/DAO/Job.php b/CRM/Core/DAO/Job.php
index 81fe117fbf..2a3abb54f6 100644
--- a/CRM/Core/DAO/Job.php
+++ b/CRM/Core/DAO/Job.php
@@ -1,180 +1,173 @@
 <?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
  *
  * Generated from xml/schema/CRM/Core/Job.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:c3340527b2d2cb17211eba848371b469)
+ * (GenCodeChecksum:ec2775b0ba09eb61d32f1565ebbaf4f8)
  */
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
 /**
- * CRM_Core_DAO_Job constructor.
+ * Database access object for the Job entity.
  */
 class CRM_Core_DAO_Job extends CRM_Core_DAO {
+
   /**
    * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_job';
+
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
-   * @var boolean
+   * @var bool
    */
-  static $_log = false;
+  static $_log = FALSE;
+
   /**
    * Job Id
    *
    * @var int unsigned
    */
   public $id;
+
   /**
    * Which Domain is this scheduled job for
    *
    * @var int unsigned
    */
   public $domain_id;
+
   /**
    * Scheduled job run frequency.
    *
    * @var string
    */
   public $run_frequency;
+
   /**
    * When was this cron entry last run
    *
-   * @var datetime
+   * @var timestamp
    */
   public $last_run;
+
   /**
    * When is this cron entry scheduled to run
    *
    * @var timestamp
    */
   public $scheduled_run_date;
+
   /**
    * Title of the job
    *
    * @var string
    */
   public $name;
+
   /**
    * Description of the job
    *
    * @var string
    */
   public $description;
+
   /**
    * Entity of the job api call
    *
    * @var string
    */
   public $api_entity;
+
   /**
    * Action of the job api call
    *
    * @var string
    */
   public $api_action;
+
   /**
    * List of parameters to the command.
    *
    * @var text
    */
   public $parameters;
+
   /**
    * Is this job active?
    *
    * @var boolean
    */
   public $is_active;
+
   /**
    * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     $this->__table = 'civicrm_job';
     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 ID') ,
+          'title' => ts('Job ID'),
           'description' => 'Job Id',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-        ) ,
-        'domain_id' => array(
+          'localizable' => 0,
+        ],
+        'domain_id' => [
           'name' => 'domain_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Job Domain') ,
+          'title' => ts('Job Domain'),
           'description' => 'Which Domain is this scheduled job for',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
+          'localizable' => 0,
           'FKClassName' => 'CRM_Core_DAO_Domain',
-          'pseudoconstant' => array(
+          'pseudoconstant' => [
             'table' => 'civicrm_domain',
             'keyColumn' => 'id',
             'labelColumn' => 'name',
-          )
-        ) ,
-        'run_frequency' => array(
+          ]
+        ],
+        'run_frequency' => [
           'name' => 'run_frequency',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Job Frequency') ,
+          'title' => ts('Job Frequency'),
           'description' => 'Scheduled job run frequency.',
           'maxlength' => 8,
           'size' => CRM_Utils_Type::EIGHT,
@@ -182,134 +175,148 @@ class CRM_Core_DAO_Job extends CRM_Core_DAO {
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-          'html' => array(
+          'localizable' => 0,
+          'html' => [
             'type' => 'Select',
-          ) ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'callback' => 'CRM_Core_SelectValues::getJobFrequency',
-          )
-        ) ,
-        'last_run' => array(
+          ]
+        ],
+        'last_run' => [
           'name' => 'last_run',
-          'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
-          'title' => ts('Last Run') ,
+          'type' => CRM_Utils_Type::T_TIMESTAMP,
+          'title' => ts('Last Run'),
           'description' => 'When was this cron entry last run',
+          'required' => FALSE,
           'default' => 'NULL',
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-        ) ,
-        'scheduled_run_date' => array(
+          'localizable' => 0,
+        ],
+        'scheduled_run_date' => [
           'name' => 'scheduled_run_date',
           'type' => CRM_Utils_Type::T_TIMESTAMP,
-          'title' => ts('Scheduled Run Date') ,
+          'title' => ts('Scheduled Run Date'),
           'description' => 'When is this cron entry scheduled to run',
-          'required' => false,
+          'required' => FALSE,
           'default' => 'NULL',
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-        ) ,
-        'name' => array(
+          'localizable' => 0,
+        ],
+        'name' => [
           'name' => 'name',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Job Name') ,
+          'title' => ts('Job Name'),
           'description' => 'Title of the job',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-        ) ,
-        'description' => array(
+          'localizable' => 0,
+        ],
+        'description' => [
           'name' => 'description',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Job Description') ,
+          'title' => ts('Job Description'),
           'description' => 'Description of the job',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-        ) ,
-        'api_entity' => array(
+          'localizable' => 0,
+        ],
+        'api_entity' => [
           'name' => 'api_entity',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('API Entity') ,
+          'title' => ts('API Entity'),
           'description' => 'Entity of the job api call',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-        ) ,
-        'api_action' => array(
+          'localizable' => 0,
+        ],
+        'api_action' => [
           'name' => 'api_action',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('API Action') ,
+          'title' => ts('API Action'),
           'description' => 'Action of the job api call',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-        ) ,
-        'parameters' => array(
+          'localizable' => 0,
+        ],
+        'parameters' => [
           'name' => 'parameters',
           'type' => CRM_Utils_Type::T_TEXT,
-          'title' => ts('API Parameters') ,
+          'title' => ts('API Parameters'),
           'description' => 'List of parameters to the command.',
           'rows' => 4,
           'cols' => 60,
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-          'html' => array(
+          'localizable' => 0,
+          'html' => [
             'type' => 'TextArea',
-          ) ,
-        ) ,
-        'is_active' => array(
+          ],
+        ],
+        'is_active' => [
           'name' => 'is_active',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Job Is Active?') ,
+          'title' => ts('Job Is Active?'),
           'description' => 'Is this job active?',
           'table_name' => 'civicrm_job',
           'entity' => 'Job',
           'bao' => 'CRM_Core_BAO_Job',
-        ) ,
-      );
+          '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
    *
@@ -317,10 +324,11 @@ class CRM_Core_DAO_Job extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &import($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'job', $prefix, array());
+  public static function &import($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'job', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of fields that can be exported
    *
@@ -328,8 +336,21 @@ class CRM_Core_DAO_Job extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &export($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'job', $prefix, array());
+  public static function &export($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'job', $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;
+  }
+
 }