CRM-19925 Updated DAO files
[civicrm-core.git] / CRM / Mailing / DAO / MailingJob.php
index fa13a364631089f9abd556656368da698f39aca0..899e0f5f4bea1b7611b01b600b45431632a7422b 100644 (file)
@@ -3,7 +3,7 @@
 +--------------------------------------------------------------------+
 | CiviCRM version 4.7                                                |
 +--------------------------------------------------------------------+
-| Copyright CiviCRM LLC (c) 2004-2016                                |
+| Copyright CiviCRM LLC (c) 2004-2017                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 */
 /**
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2016
+ * @copyright CiviCRM LLC (c) 2004-2017
  *
  * Generated from xml/schema/CRM/Mailing/MailingJob.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:b41e4d5e6541acff6328ece968e45b2d)
+ * (GenCodeChecksum:0d980fe5408cdcfa95a640da20a9f2f2)
  */
 require_once 'CRM/Core/DAO.php';
 require_once 'CRM/Utils/Type.php';
+/**
+ * CRM_Mailing_DAO_MailingJob constructor.
+ */
 class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
   /**
-   * static instance to hold the table name
+   * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_mailing_job';
   /**
-   * static instance to hold the field values
-   *
-   * @var array
-   */
-  static $_fields = null;
-  /**
-   * static instance to hold the keys used in $_fields for each field.
-   *
-   * @var array
-   */
-  static $_fieldKeys = null;
-  /**
-   * static instance to hold the FK relationships
-   *
-   * @var string
-   */
-  static $_links = null;
-  /**
-   * static instance to hold the values that can
-   * be imported
-   *
-   * @var array
-   */
-  static $_import = null;
-  /**
-   * static instance to hold the values that can
-   * be exported
-   *
-   * @var array
-   */
-  static $_export = null;
-  /**
-   * static value to see if we should log any modifications to
-   * this table in the civicrm_log table
+   * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
    * @var boolean
    */
@@ -146,27 +116,26 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
    */
   public $job_limit;
   /**
-   * class constructor
-   *
-   * @return civicrm_mailing_job
+   * Class constructor.
    */
   function __construct() {
     $this->__table = 'civicrm_mailing_job';
     parent::__construct();
   }
   /**
-   * Returns foreign keys and entity references
+   * Returns foreign keys and entity references.
    *
    * @return array
    *   [CRM_Core_Reference_Interface]
    */
   static function getReferenceColumns() {
-    if (!self::$_links) {
-      self::$_links = static ::createReferenceColumns(__CLASS__);
-      self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'mailing_id', 'civicrm_mailing', 'id');
-      self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'parent_id', 'civicrm_mailing_job', 'id');
+    if (!isset(Civi::$statics[__CLASS__]['links'])) {
+      Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'mailing_id', 'civicrm_mailing', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'parent_id', 'civicrm_mailing_job', 'id');
+      CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
     }
-    return self::$_links;
+    return Civi::$statics[__CLASS__]['links'];
   }
   /**
    * Returns all the column names of this table
@@ -174,13 +143,16 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
    * @return array
    */
   static function &fields() {
-    if (!(self::$_fields)) {
-      self::$_fields = array(
+    if (!isset(Civi::$statics[__CLASS__]['fields'])) {
+      Civi::$statics[__CLASS__]['fields'] = array(
         'id' => array(
           'name' => 'id',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Mailing Job ID') ,
           'required' => true,
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
         ) ,
         'mailing_id' => array(
           'name' => 'mailing_id',
@@ -188,6 +160,9 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
           'title' => ts('Mailing') ,
           'description' => 'The ID of the mailing this Job will send.',
           'required' => true,
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
           'FKClassName' => 'CRM_Mailing_DAO_Mailing',
         ) ,
         'scheduled_date' => array(
@@ -195,18 +170,27 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Mailing Scheduled Date') ,
           'description' => 'date on which this job was scheduled.',
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
         ) ,
         'start_date' => array(
           'name' => 'start_date',
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Mailing Job Start Date') ,
           'description' => 'date on which this job was started.',
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
         ) ,
         'end_date' => array(
           'name' => 'end_date',
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Mailing Job End Date') ,
           'description' => 'date on which this job ended.',
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
         ) ,
         'status' => array(
           'name' => 'status',
@@ -215,6 +199,9 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
           'description' => 'The state of this job',
           'maxlength' => 12,
           'size' => CRM_Utils_Type::TWELVE,
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
           'html' => array(
             'type' => 'Select',
           ) ,
@@ -227,6 +214,9 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_BOOLEAN,
           'title' => ts('Mailing Job Is Test?') ,
           'description' => 'Is this job for a test mail?',
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
         ) ,
         'job_type' => array(
           'name' => 'job_type',
@@ -235,6 +225,9 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
           'description' => 'Type of mailling job: null | child ',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
         ) ,
         'parent_id' => array(
           'name' => 'parent_id',
@@ -242,6 +235,9 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
           'title' => ts('Mailing Job Parent') ,
           'description' => 'Parent job id',
           'default' => 'NULL',
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
           'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
         ) ,
         'job_offset' => array(
@@ -249,40 +245,35 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Mailing Job Offset') ,
           'description' => 'Offset of the child job',
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
         ) ,
         'job_limit' => array(
           'name' => 'job_limit',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Mailing Job Limit') ,
           'description' => 'Queue size limit for each child job',
+          'table_name' => 'civicrm_mailing_job',
+          'entity' => 'MailingJob',
+          'bao' => 'CRM_Mailing_BAO_MailingJob',
         ) ,
       );
+      CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
     }
-    return self::$_fields;
+    return Civi::$statics[__CLASS__]['fields'];
   }
   /**
-   * Returns an array containing, for each field, the arary key used for that
-   * field in self::$_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() {
-    if (!(self::$_fieldKeys)) {
-      self::$_fieldKeys = array(
-        'id' => 'id',
-        'mailing_id' => 'mailing_id',
-        'scheduled_date' => 'scheduled_date',
-        'start_date' => 'start_date',
-        'end_date' => 'end_date',
-        'status' => 'status',
-        'is_test' => 'is_test',
-        'job_type' => 'job_type',
-        'parent_id' => 'parent_id',
-        'job_offset' => 'job_offset',
-        'job_limit' => 'job_limit',
-      );
+    if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
+      Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
     }
-    return self::$_fieldKeys;
+    return Civi::$statics[__CLASS__]['fieldKeys'];
   }
   /**
    * Returns the names of this table
@@ -308,20 +299,8 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
    * @return array
    */
   static function &import($prefix = false) {
-    if (!(self::$_import)) {
-      self::$_import = array();
-      $fields = self::fields();
-      foreach($fields as $name => $field) {
-        if (CRM_Utils_Array::value('import', $field)) {
-          if ($prefix) {
-            self::$_import['mailing_job'] = & $fields[$name];
-          } else {
-            self::$_import[$name] = & $fields[$name];
-          }
-        }
-      }
-    }
-    return self::$_import;
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_job', $prefix, array());
+    return $r;
   }
   /**
    * Returns the list of fields that can be exported
@@ -331,19 +310,7 @@ class CRM_Mailing_DAO_MailingJob extends CRM_Core_DAO {
    * @return array
    */
   static function &export($prefix = false) {
-    if (!(self::$_export)) {
-      self::$_export = array();
-      $fields = self::fields();
-      foreach($fields as $name => $field) {
-        if (CRM_Utils_Array::value('export', $field)) {
-          if ($prefix) {
-            self::$_export['mailing_job'] = & $fields[$name];
-          } else {
-            self::$_export[$name] = & $fields[$name];
-          }
-        }
-      }
-    }
-    return self::$_export;
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_job', $prefix, array());
+    return $r;
   }
 }