Reformat DAO files to pass linting and use short array syntax
[civicrm-core.git] / CRM / Core / DAO / RecurringEntity.php
index 81504b5909ba4af932616b7029c1b5ea37b7c413..9452995999c8100fbbb587dc6e22e44023bd8cc7 100644 (file)
@@ -1,29 +1,5 @@
 <?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
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  * (GenCodeChecksum:926c9bc8d5175511764721bc9dc8562a)
  */
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
 /**
- * CRM_Core_DAO_RecurringEntity constructor.
+ * Database access object for the RecurringEntity entity.
  */
 class CRM_Core_DAO_RecurringEntity extends CRM_Core_DAO {
+
   /**
    * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_recurring_entity';
+
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
-   * @var boolean
+   * @var bool
    */
-  static $_log = true;
+  static $_log = TRUE;
+
   /**
-   *
    * @var int unsigned
    */
   public $id;
+
   /**
    * Recurring Entity Parent ID
    *
    * @var int unsigned
    */
   public $parent_id;
+
   /**
    * Recurring Entity Child ID
    *
    * @var int unsigned
    */
   public $entity_id;
+
   /**
    * Physical tablename for entity, e.g. civicrm_event
    *
    * @var string
    */
   public $entity_table;
+
   /**
    * 1-this entity, 2-this and the following entities, 3-all the entities
    *
    * @var boolean
    */
   public $mode;
+
   /**
    * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     $this->__table = 'civicrm_recurring_entity';
     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('ID') ,
-          'required' => true,
+          'title' => ts('ID'),
+          'required' => TRUE,
           'table_name' => 'civicrm_recurring_entity',
           'entity' => 'RecurringEntity',
           'bao' => 'CRM_Core_BAO_RecurringEntity',
           'localizable' => 0,
-        ,
-        'parent_id' => array(
+        ],
+        'parent_id' => [
           'name' => 'parent_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Parent ID') ,
+          'title' => ts('Parent ID'),
           'description' => 'Recurring Entity Parent ID',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_recurring_entity',
           'entity' => 'RecurringEntity',
           'bao' => 'CRM_Core_BAO_RecurringEntity',
           'localizable' => 0,
-        ,
-        'entity_id' => array(
+        ],
+        'entity_id' => [
           'name' => 'entity_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Entity ID') ,
+          'title' => ts('Entity ID'),
           'description' => 'Recurring Entity Child ID',
           'table_name' => 'civicrm_recurring_entity',
           'entity' => 'RecurringEntity',
           'bao' => 'CRM_Core_BAO_RecurringEntity',
           'localizable' => 0,
-        ,
-        'entity_table' => array(
+        ],
+        'entity_table' => [
           'name' => 'entity_table',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Entity Table') ,
+          'title' => ts('Entity Table'),
           'description' => 'Physical tablename for entity, e.g. civicrm_event',
-          'required' => true,
+          'required' => TRUE,
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
           'table_name' => 'civicrm_recurring_entity',
           'entity' => 'RecurringEntity',
           'bao' => 'CRM_Core_BAO_RecurringEntity',
           'localizable' => 0,
-        ,
-        'mode' => array(
+        ],
+        'mode' => [
           'name' => 'mode',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Cascade Type') ,
+          'title' => ts('Cascade Type'),
           'description' => '1-this entity, 2-this and the following entities, 3-all the entities',
-          'required' => true,
+          'required' => TRUE,
           'default' => '1',
           'table_name' => 'civicrm_recurring_entity',
           'entity' => 'RecurringEntity',
           'bao' => 'CRM_Core_BAO_RecurringEntity',
           '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
    *
@@ -190,10 +177,11 @@ class CRM_Core_DAO_RecurringEntity extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &import($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'recurring_entity', $prefix, array());
+  public static function &import($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'recurring_entity', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of fields that can be exported
    *
@@ -201,15 +189,21 @@ class CRM_Core_DAO_RecurringEntity extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &export($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'recurring_entity', $prefix, array());
+  public static function &export($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'recurring_entity', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of indices
+   *
+   * @param bool $localize
+   *
+   * @return array
    */
   public static function indices($localize = TRUE) {
-    $indices = array();
+    $indices = [];
     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
   }
+
 }