Merge pull request #12018 from civicrm/5.1
[civicrm-core.git] / CRM / Case / DAO / CaseType.php
index ac84133ab94ce4de801b0a79356484c462445510..b55d114318aa244099da48c5e2b6be3695b378bc 100644 (file)
 <?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-2018
  *
  * Generated from xml/schema/CRM/Case/CaseType.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  * (GenCodeChecksum:a9a547708dfca9da8c4421dd5edac6ac)
  */
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
 /**
- * CRM_Case_DAO_CaseType constructor.
+ * Database access object for the CaseType entity.
  */
 class CRM_Case_DAO_CaseType extends CRM_Core_DAO {
+
   /**
    * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_case_type';
+
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
-   * @var boolean
+   * @var bool
    */
-  static $_log = true;
+  static $_log = TRUE;
+
   /**
    * Autoincremented type id
    *
    * @var int unsigned
    */
   public $id;
+
   /**
    * Machine name for Case Type
    *
    * @var string
    */
   public $name;
+
   /**
    * Natural language name for Case Type
    *
    * @var string
    */
   public $title;
+
   /**
    * Description of the Case Type
    *
    * @var string
    */
   public $description;
+
   /**
    * Is this entry active?
    *
    * @var boolean
    */
   public $is_active;
+
   /**
    * Is this case type a predefined system type?
    *
    * @var boolean
    */
   public $is_reserved;
+
   /**
    * Ordering of the case types
    *
    * @var int
    */
   public $weight;
+
   /**
    * xml definition of case type
    *
    * @var blob
    */
   public $definition;
+
   /**
    * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     $this->__table = 'civicrm_case_type';
     parent::__construct();
   }
+
   /**
    * 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('Case Type ID') ,
+          'title' => ts('Case Type ID'),
           'description' => 'Autoincremented type id',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_case_type',
           'entity' => 'CaseType',
           'bao' => 'CRM_Case_BAO_CaseType',
           'localizable' => 0,
-        ,
-        'name' => array(
+        ],
+        'name' => [
           'name' => 'name',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Case Type Name') ,
+          'title' => ts('Case Type Name'),
           'description' => 'Machine name for Case Type',
-          'required' => true,
+          'required' => TRUE,
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
           'table_name' => 'civicrm_case_type',
           'entity' => 'CaseType',
           'bao' => 'CRM_Case_BAO_CaseType',
           'localizable' => 0,
-        ,
-        'title' => array(
+        ],
+        'title' => [
           'name' => 'title',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Case Type Title') ,
+          'title' => ts('Case Type Title'),
           'description' => 'Natural language name for Case Type',
-          'required' => true,
+          'required' => TRUE,
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
           'table_name' => 'civicrm_case_type',
           'entity' => 'CaseType',
           'bao' => 'CRM_Case_BAO_CaseType',
           'localizable' => 1,
-        ,
-        'description' => array(
+        ],
+        'description' => [
           'name' => 'description',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Case Type Description') ,
+          'title' => ts('Case Type Description'),
           'description' => 'Description of the Case Type',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -161,82 +148,86 @@ class CRM_Case_DAO_CaseType extends CRM_Core_DAO {
           'entity' => 'CaseType',
           'bao' => 'CRM_Case_BAO_CaseType',
           'localizable' => 1,
-        ,
-        'is_active' => array(
+        ],
+        'is_active' => [
           'name' => 'is_active',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Case Type Is Active') ,
+          'title' => ts('Case Type Is Active'),
           'description' => 'Is this entry active?',
           'table_name' => 'civicrm_case_type',
           'entity' => 'CaseType',
           'bao' => 'CRM_Case_BAO_CaseType',
           'localizable' => 0,
-        ,
-        'is_reserved' => array(
+        ],
+        'is_reserved' => [
           'name' => 'is_reserved',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Case Type Is Reserved') ,
+          'title' => ts('Case Type Is Reserved'),
           'description' => 'Is this case type a predefined system type?',
           'table_name' => 'civicrm_case_type',
           'entity' => 'CaseType',
           'bao' => 'CRM_Case_BAO_CaseType',
           'localizable' => 0,
-        ,
-        'weight' => array(
+        ],
+        'weight' => [
           'name' => 'weight',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Order') ,
+          'title' => ts('Order'),
           'description' => 'Ordering of the case types',
-          'required' => true,
+          'required' => TRUE,
           'default' => '1',
           'table_name' => 'civicrm_case_type',
           'entity' => 'CaseType',
           'bao' => 'CRM_Case_BAO_CaseType',
           'localizable' => 0,
-        ,
-        'definition' => array(
+        ],
+        'definition' => [
           'name' => 'definition',
           'type' => CRM_Utils_Type::T_BLOB,
-          'title' => ts('Case Type Definition') ,
+          'title' => ts('Case Type Definition'),
           'description' => 'xml definition of case type',
           'table_name' => 'civicrm_case_type',
           'entity' => 'CaseType',
           'bao' => 'CRM_Case_BAO_CaseType',
           '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 CRM_Core_DAO::getLocaleTableName(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
    *
@@ -244,10 +235,11 @@ class CRM_Case_DAO_CaseType extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &import($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'case_type', $prefix, array());
+  public static function &import($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'case_type', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of fields that can be exported
    *
@@ -255,25 +247,31 @@ class CRM_Case_DAO_CaseType extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &export($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'case_type', $prefix, array());
+  public static function &export($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'case_type', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of indices
+   *
+   * @param bool $localize
+   *
+   * @return array
    */
   public static function indices($localize = TRUE) {
-    $indices = array(
-      'case_type_name' => array(
+    $indices = [
+      'case_type_name' => [
         'name' => 'case_type_name',
-        'field' => array(
+        'field' => [
           0 => 'name',
-        ,
-        'localizable' => false,
-        'unique' => true,
+        ],
+        'localizable' => FALSE,
+        'unique' => TRUE,
         'sig' => 'civicrm_case_type::1::name',
-      ,
-    );
+      ],
+    ];
     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
   }
+
 }