Reformat DAO files to pass linting and use short array syntax
[civicrm-core.git] / CRM / Core / DAO / Phone.php
index 7c594b5d9cb1f659e0aa1c0b97b79565260ea5e6..28ab1b174ccd31c327b0a8d1872a3d64b9d23846 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:661faad4886dd1a40784d465b906f447)
  */
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
 /**
- * CRM_Core_DAO_Phone constructor.
+ * Database access object for the Phone entity.
  */
 class CRM_Core_DAO_Phone extends CRM_Core_DAO {
+
   /**
    * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_phone';
+
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
-   * @var boolean
+   * @var bool
    */
-  static $_log = true;
+  static $_log = TRUE;
+
   /**
    * Unique Phone ID
    *
    * @var int unsigned
    */
   public $id;
+
   /**
    * FK to Contact ID
    *
    * @var int unsigned
    */
   public $contact_id;
+
   /**
    * Which Location does this phone belong to.
    *
    * @var int unsigned
    */
   public $location_type_id;
+
   /**
    * Is this the primary phone for this contact and location.
    *
    * @var boolean
    */
   public $is_primary;
+
   /**
    * Is this the billing?
    *
    * @var boolean
    */
   public $is_billing;
+
   /**
    * Which Mobile Provider does this phone belong to.
    *
    * @var int unsigned
    */
   public $mobile_provider_id;
+
   /**
    * Complete phone number.
    *
    * @var string
    */
   public $phone;
+
   /**
    * Optional extension for a phone number.
    *
    * @var string
    */
   public $phone_ext;
+
   /**
    * Phone number stripped of all whitespace, letters, and punctuation.
    *
    * @var string
    */
   public $phone_numeric;
+
   /**
    * Which type of phone does this number belongs.
    *
    * @var int unsigned
    */
   public $phone_type_id;
+
   /**
    * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     $this->__table = 'civicrm_phone';
     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() , 'contact_id', 'civicrm_contact', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', '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('Phone ID') ,
+          'title' => ts('Phone ID'),
           'description' => 'Unique Phone ID',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-        ,
-        'contact_id' => array(
+        ],
+        'contact_id' => [
           'name' => 'contact_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Phone Contact') ,
+          'title' => ts('Phone Contact'),
           'description' => 'FK to Contact ID',
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
           'FKClassName' => 'CRM_Contact_DAO_Contact',
-        ,
-        'location_type_id' => array(
+        ],
+        'location_type_id' => [
           'name' => 'location_type_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Phone Location Type') ,
+          'title' => ts('Phone Location Type'),
           'description' => 'Which Location does this phone belong to.',
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Select',
-          ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'table' => 'civicrm_location_type',
             'keyColumn' => 'id',
             'labelColumn' => 'display_name',
-          )
-        ,
-        'is_primary' => array(
+          ]
+        ],
+        'is_primary' => [
           'name' => 'is_primary',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Is Phone Primary?') ,
+          'title' => ts('Is Phone Primary?'),
           'description' => 'Is this the primary phone for this contact and location.',
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-        ,
-        'is_billing' => array(
+        ],
+        'is_billing' => [
           'name' => 'is_billing',
           'type' => CRM_Utils_Type::T_BOOLEAN,
-          'title' => ts('Is Billing Phone') ,
+          'title' => ts('Is Billing Phone'),
           'description' => 'Is this the billing?',
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-        ,
-        'mobile_provider_id' => array(
+        ],
+        'mobile_provider_id' => [
           'name' => 'mobile_provider_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Mobile Provider') ,
+          'title' => ts('Mobile Provider'),
           'description' => 'Which Mobile Provider does this phone belong to.',
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-        ,
-        'phone' => array(
+        ],
+        'phone' => [
           'name' => 'phone',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Phone') ,
+          'title' => ts('Phone'),
           'description' => 'Complete phone number.',
           'maxlength' => 32,
           'size' => CRM_Utils_Type::MEDIUM,
-          'import' => true,
+          'import' => TRUE,
           'where' => 'civicrm_phone.phone',
           'headerPattern' => '/phone/i',
           'dataPattern' => '/^[\d\(\)\-\.\s]+$/',
-          'export' => true,
+          'export' => TRUE,
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Text',
-          ,
-        ,
-        'phone_ext' => array(
+          ],
+        ],
+        'phone_ext' => [
           'name' => 'phone_ext',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Phone Extension') ,
+          'title' => ts('Phone Extension'),
           'description' => 'Optional extension for a phone number.',
           'maxlength' => 16,
           'size' => 4,
-          'import' => true,
+          'import' => TRUE,
           'where' => 'civicrm_phone.phone_ext',
           'headerPattern' => '/extension/i',
           'dataPattern' => '/^\d+$/',
-          'export' => true,
+          'export' => TRUE,
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Text',
-          ,
-        ,
-        'phone_numeric' => array(
+          ],
+        ],
+        'phone_numeric' => [
           'name' => 'phone_numeric',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Phone Numeric') ,
+          'title' => ts('Phone Numeric'),
           'description' => 'Phone number stripped of all whitespace, letters, and punctuation.',
           'maxlength' => 32,
           'size' => CRM_Utils_Type::MEDIUM,
@@ -260,57 +250,61 @@ class CRM_Core_DAO_Phone extends CRM_Core_DAO {
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-        ,
-        'phone_type_id' => array(
+        ],
+        'phone_type_id' => [
           'name' => 'phone_type_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Phone Type') ,
+          'title' => ts('Phone Type'),
           'description' => 'Which type of phone does this number belongs.',
           'table_name' => 'civicrm_phone',
           'entity' => 'Phone',
           'bao' => 'CRM_Core_BAO_Phone',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Select',
-          ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'optionGroupName' => 'phone_type',
             'optionEditPath' => 'civicrm/admin/options/phone_type',
-          )
-        ,
-      );
+          ]
+        ],
+      ];
       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
    *
@@ -318,10 +312,11 @@ class CRM_Core_DAO_Phone extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &import($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'phone', $prefix, array());
+  public static function &import($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'phone', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of fields that can be exported
    *
@@ -329,56 +324,62 @@ class CRM_Core_DAO_Phone extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &export($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'phone', $prefix, array());
+  public static function &export($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'phone', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of indices
+   *
+   * @param bool $localize
+   *
+   * @return array
    */
   public static function indices($localize = TRUE) {
-    $indices = array(
-      'index_location_type' => array(
+    $indices = [
+      'index_location_type' => [
         'name' => 'index_location_type',
-        'field' => array(
+        'field' => [
           0 => 'location_type_id',
-        ,
-        'localizable' => false,
+        ],
+        'localizable' => FALSE,
         'sig' => 'civicrm_phone::0::location_type_id',
-      ,
-      'index_is_primary' => array(
+      ],
+      'index_is_primary' => [
         'name' => 'index_is_primary',
-        'field' => array(
+        'field' => [
           0 => 'is_primary',
-        ,
-        'localizable' => false,
+        ],
+        'localizable' => FALSE,
         'sig' => 'civicrm_phone::0::is_primary',
-      ,
-      'index_is_billing' => array(
+      ],
+      'index_is_billing' => [
         'name' => 'index_is_billing',
-        'field' => array(
+        'field' => [
           0 => 'is_billing',
-        ,
-        'localizable' => false,
+        ],
+        'localizable' => FALSE,
         'sig' => 'civicrm_phone::0::is_billing',
-      ,
-      'UI_mobile_provider_id' => array(
+      ],
+      'UI_mobile_provider_id' => [
         'name' => 'UI_mobile_provider_id',
-        'field' => array(
+        'field' => [
           0 => 'mobile_provider_id',
-        ,
-        'localizable' => false,
+        ],
+        'localizable' => FALSE,
         'sig' => 'civicrm_phone::0::mobile_provider_id',
-      ,
-      'index_phone_numeric' => array(
+      ],
+      'index_phone_numeric' => [
         'name' => 'index_phone_numeric',
-        'field' => array(
+        'field' => [
           0 => 'phone_numeric',
-        ,
-        'localizable' => false,
+        ],
+        'localizable' => FALSE,
         'sig' => 'civicrm_phone::0::phone_numeric',
-      ,
-    );
+      ],
+    ];
     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
   }
+
 }