Merge pull request #11304 from JMAConsulting/CRM-21461
[civicrm-core.git] / CRM / Core / DAO / MappingField.php
index 7b22b73f40852c55b590fe3f29a4f1489059a715..6216bb9398d7f052a10a60f28dfab270c893fad1 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:6e729c48a9732fd57132ddfe6f9d02b9)
  */
-require_once 'CRM/Core/DAO.php';
-require_once 'CRM/Utils/Type.php';
+
 /**
- * CRM_Core_DAO_MappingField constructor.
+ * Database access object for the MappingField entity.
  */
 class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
+
   /**
    * Static instance to hold the table name.
    *
    * @var string
    */
   static $_tableName = 'civicrm_mapping_field';
+
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
-   * @var boolean
+   * @var bool
    */
-  static $_log = false;
+  static $_log = FALSE;
+
   /**
    * Mapping Field ID
    *
    * @var int unsigned
    */
   public $id;
+
   /**
    * Mapping to which this field belongs
    *
    * @var int unsigned
    */
   public $mapping_id;
+
   /**
    * Mapping field key
    *
    * @var string
    */
   public $name;
+
   /**
    * Contact Type in mapping
    *
    * @var string
    */
   public $contact_type;
+
   /**
    * Column number for mapping set
    *
    * @var int unsigned
    */
   public $column_number;
+
   /**
    * Location type of this mapping, if required
    *
    * @var int unsigned
    */
   public $location_type_id;
+
   /**
    * Which type of phone does this number belongs.
    *
    * @var int unsigned
    */
   public $phone_type_id;
+
   /**
    * Which type of IM Provider does this name belong.
    *
    * @var int unsigned
    */
   public $im_provider_id;
+
   /**
    * Which type of website does this site belong
    *
    * @var int unsigned
    */
   public $website_type_id;
+
   /**
    * Relationship type, if required
    *
    * @var int unsigned
    */
   public $relationship_type_id;
+
   /**
-   *
    * @var string
    */
   public $relationship_direction;
+
   /**
    * Used to group mapping_field records into related sets (e.g. for criteria sets in search builder
    mappings).
@@ -122,76 +110,81 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
    * @var int unsigned
    */
   public $grouping;
+
   /**
    * SQL WHERE operator for search-builder mapping fields (search criteria).
    *
    * @var string
    */
   public $operator;
+
   /**
    * SQL WHERE value for search-builder mapping fields.
    *
    * @var string
    */
   public $value;
+
   /**
    * Class constructor.
    */
-  function __construct() {
+  public function __construct() {
     $this->__table = 'civicrm_mapping_field';
     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() , 'mapping_id', 'civicrm_mapping', 'id');
-      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'location_type_id', 'civicrm_location_type', 'id');
-      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'relationship_type_id', 'civicrm_relationship_type', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'mapping_id', 'civicrm_mapping', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'location_type_id', 'civicrm_location_type', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'relationship_type_id', 'civicrm_relationship_type', '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('Mapping Field ID') ,
+          'title' => ts('Mapping Field ID'),
           'description' => 'Mapping Field ID',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-        ,
-        'mapping_id' => array(
+        ],
+        'mapping_id' => [
           'name' => 'mapping_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Mapping ID') ,
+          'title' => ts('Mapping ID'),
           'description' => 'Mapping to which this field belongs',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
           'FKClassName' => 'CRM_Core_DAO_Mapping',
-        ,
-        'name' => array(
+        ],
+        'name' => [
           'name' => 'name',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Name') ,
+          'title' => ts('Name'),
           'description' => 'Mapping field key',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -199,11 +192,11 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-        ,
-        'contact_type' => array(
+        ],
+        'contact_type' => [
           'name' => 'contact_type',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Contact Type') ,
+          'title' => ts('Contact Type'),
           'description' => 'Contact Type in mapping',
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
@@ -211,102 +204,102 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Select',
-          ,
-        ,
-        'column_number' => array(
+          ],
+        ],
+        'column_number' => [
           'name' => 'column_number',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Column Number') ,
+          'title' => ts('Column Number'),
           'description' => 'Column number for mapping set',
-          'required' => true,
+          'required' => TRUE,
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-        ,
-        'location_type_id' => array(
+        ],
+        'location_type_id' => [
           'name' => 'location_type_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Location type ID') ,
+          'title' => ts('Location type ID'),
           'description' => 'Location type of this mapping, if required',
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
           'FKClassName' => 'CRM_Core_DAO_LocationType',
-        ,
-        'phone_type_id' => array(
+        ],
+        'phone_type_id' => [
           'name' => 'phone_type_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Phone type ID') ,
+          'title' => ts('Phone type ID'),
           'description' => 'Which type of phone does this number belongs.',
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-        ,
-        'im_provider_id' => array(
+        ],
+        'im_provider_id' => [
           'name' => 'im_provider_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('IM provider ID') ,
+          'title' => ts('IM provider ID'),
           'description' => 'Which type of IM Provider does this name belong.',
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Select',
-          ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'optionGroupName' => 'instant_messenger_service',
             'optionEditPath' => 'civicrm/admin/options/instant_messenger_service',
-          )
-        ,
-        'website_type_id' => array(
+          ]
+        ],
+        'website_type_id' => [
           'name' => 'website_type_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Website type ID') ,
+          'title' => ts('Website type ID'),
           'description' => 'Which type of website does this site belong',
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Select',
-          ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'optionGroupName' => 'website_type',
             'optionEditPath' => 'civicrm/admin/options/website_type',
-          )
-        ,
-        'relationship_type_id' => array(
+          ]
+        ],
+        'relationship_type_id' => [
           'name' => 'relationship_type_id',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Relationship type ID') ,
+          'title' => ts('Relationship type ID'),
           'description' => 'Relationship type, if required',
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
           'FKClassName' => 'CRM_Contact_DAO_RelationshipType',
-        ,
-        'relationship_direction' => array(
+        ],
+        'relationship_direction' => [
           'name' => 'relationship_direction',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Relationship Direction') ,
+          'title' => ts('Relationship Direction'),
           'maxlength' => 6,
           'size' => CRM_Utils_Type::SIX,
           'table_name' => 'civicrm_mapping_field',
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-        ,
-        'grouping' => array(
+        ],
+        'grouping' => [
           'name' => 'grouping',
           'type' => CRM_Utils_Type::T_INT,
-          'title' => ts('Grouping') ,
+          'title' => ts('Grouping'),
           'description' => 'Used to group mapping_field records into related sets (e.g. for criteria sets in search builder
       mappings).
     ',
@@ -315,11 +308,11 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-        ,
-        'operator' => array(
+        ],
+        'operator' => [
           'name' => 'operator',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Operator') ,
+          'title' => ts('Operator'),
           'description' => 'SQL WHERE operator for search-builder mapping fields (search criteria).',
           'maxlength' => 16,
           'size' => CRM_Utils_Type::TWELVE,
@@ -327,17 +320,17 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           'localizable' => 0,
-          'html' => array(
+          'html' => [
             'type' => 'Select',
-          ,
-          'pseudoconstant' => array(
+          ],
+          'pseudoconstant' => [
             'callback' => 'CRM_Core_SelectValues::getSearchBuilderOperators',
-          )
-        ,
-        'value' => array(
+          ]
+        ],
+        'value' => [
           'name' => 'value',
           'type' => CRM_Utils_Type::T_STRING,
-          'title' => ts('Value') ,
+          'title' => ts('Value'),
           'description' => 'SQL WHERE value for search-builder mapping fields.',
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -345,40 +338,44 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
           'entity' => 'MappingField',
           'bao' => 'CRM_Core_DAO_MappingField',
           '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
    *
@@ -386,10 +383,11 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &import($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mapping_field', $prefix, array());
+  public static function &import($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mapping_field', $prefix, []);
     return $r;
   }
+
   /**
    * Returns the list of fields that can be exported
    *
@@ -397,15 +395,21 @@ class CRM_Core_DAO_MappingField extends CRM_Core_DAO {
    *
    * @return array
    */
-  static function &export($prefix = false) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mapping_field', $prefix, array());
+  public static function &export($prefix = FALSE) {
+    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mapping_field', $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;
   }
+
 }