CRM-20312 regenerated DAOS with indexes
[civicrm-core.git] / CRM / Batch / DAO / Batch.php
index 9f38f0a558a049dc35d65bffacd8913e1986356f..d3396caf92af02650e3804bd4544b280a28252fc 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/Batch/Batch.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:81081e8ad03b0097ba7949b4425b1ca8)
+ * (GenCodeChecksum:f1b35f9cc4e12f1d4c2b026aacca7e50)
  */
 require_once 'CRM/Core/DAO.php';
 require_once 'CRM/Utils/Type.php';
+/**
+ * CRM_Batch_DAO_Batch constructor.
+ */
 class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
   /**
-   * static instance to hold the table name
+   * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_batch';
   /**
-   * 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
    */
@@ -150,16 +152,14 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
    */
   public $data;
   /**
-   * class constructor
-   *
-   * @return civicrm_batch
+   * Class constructor.
    */
   function __construct() {
     $this->__table = 'civicrm_batch';
     parent::__construct();
   }
   /**
-   * Returns foreign keys and entity references
+   * Returns foreign keys and entity references.
    *
    * @return array
    *   [CRM_Core_Reference_Interface]
@@ -188,6 +188,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'title' => ts('Batch ID') ,
           'description' => 'Unique Address ID',
           'required' => true,
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
         ) ,
         'name' => array(
           'name' => 'name',
@@ -196,6 +200,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'description' => 'Variable name/programmatic handle for this batch.',
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'html' => array(
             'type' => 'Text',
           ) ,
@@ -207,6 +215,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'description' => 'Friendly Name.',
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 1,
           'html' => array(
             'type' => 'Text',
           ) ,
@@ -218,6 +230,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'description' => 'Description of this batch set.',
           'rows' => 4,
           'cols' => 80,
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 1,
           'html' => array(
             'type' => 'TextArea',
           ) ,
@@ -227,6 +243,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Batch Created By') ,
           'description' => 'FK to Contact ID',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'FKClassName' => 'CRM_Contact_DAO_Contact',
         ) ,
         'created_date' => array(
@@ -234,6 +254,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Batch Created Date') ,
           'description' => 'When was this item created',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'html' => array(
             'type' => 'Select Date',
           ) ,
@@ -243,6 +267,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Batch Modified By') ,
           'description' => 'FK to Contact ID',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'FKClassName' => 'CRM_Contact_DAO_Contact',
         ) ,
         'modified_date' => array(
@@ -250,12 +278,20 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Batch Modified Date') ,
           'description' => 'When was this item created',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
         ) ,
         'saved_search_id' => array(
           'name' => 'saved_search_id',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Batch Smart Group') ,
           'description' => 'FK to Saved Search ID',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'FKClassName' => 'CRM_Contact_DAO_SavedSearch',
           'html' => array(
             'type' => 'EntityRef',
@@ -267,6 +303,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'title' => ts('Batch Status') ,
           'description' => 'fk to Batch Status options in civicrm_option_values',
           'required' => true,
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'html' => array(
             'type' => 'Select',
           ) ,
@@ -280,6 +320,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Batch Type') ,
           'description' => 'fk to Batch Type options in civicrm_option_values',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'html' => array(
             'type' => 'Select',
           ) ,
@@ -293,6 +337,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Batch Mode') ,
           'description' => 'fk to Batch mode options in civicrm_option_values',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'html' => array(
             'type' => 'Select',
           ) ,
@@ -310,6 +358,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
             20,
             2
           ) ,
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'html' => array(
             'type' => 'Text',
           ) ,
@@ -319,6 +371,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Batch Number of Items') ,
           'description' => 'Number of items in a batch.',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'html' => array(
             'type' => 'Text',
           ) ,
@@ -328,6 +384,10 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Batch Payment Method') ,
           'description' => 'fk to Payment Instrument options in civicrm_option_values',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
           'html' => array(
             'type' => 'Select',
           ) ,
@@ -340,12 +400,20 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
           'name' => 'exported_date',
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Batch Exported Date') ,
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
         ) ,
         'data' => array(
           'name' => 'data',
           'type' => CRM_Utils_Type::T_LONGTEXT,
           'title' => ts('Batch Data') ,
           'description' => 'cache entered data',
+          'table_name' => 'civicrm_batch',
+          'entity' => 'Batch',
+          'bao' => 'CRM_Batch_BAO_Batch',
+          'localizable' => 0,
         ) ,
       );
       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
@@ -402,4 +470,21 @@ class CRM_Batch_DAO_Batch extends CRM_Core_DAO {
     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'batch', $prefix, array());
     return $r;
   }
+  /**
+   * Returns the list of indices
+   */
+  public static function indices($localize = TRUE) {
+    $indices = array(
+      'UI_name' => array(
+        'name' => 'UI_name',
+        'field' => array(
+          0 => 'name',
+        ) ,
+        'localizable' => false,
+        'unique' => true,
+        'sig' => 'civicrm_batch::1::name',
+      ) ,
+    );
+    return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
+  }
 }