Merge pull request #15800 from eileenmcnaughton/anet_valid
[civicrm-core.git] / CRM / Core / InnoDBIndexer.php
index 123792a656b1bba446b42c2dc71989afb889fc2d..fdd401eb8da980dc5c0859645f477b1e0efda5e8 100644 (file)
@@ -1,27 +1,11 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 5                                                  |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019                                |
- +--------------------------------------------------------------------+
- | 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.   |
+ | Copyright CiviCRM LLC. All rights reserved.                        |
  |                                                                    |
- | 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        |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
 
@@ -101,9 +85,13 @@ class CRM_Core_InnoDBIndexer {
   }
 
   /**
-   * @var array (string $table => array $indices)
+   * Indices.
+   *
+   * (string $table => array $indices)
    *
    * ex: $indices['civicrm_contact'][0] = array('first_name', 'last_name');
+   *
+   * @var array
    */
   protected $indices;
 
@@ -115,8 +103,8 @@ class CRM_Core_InnoDBIndexer {
   /**
    * Class constructor.
    *
-   * @param $isActive
-   * @param $indices
+   * @param bool $isActive
+   * @param array $indices
    */
   public function __construct($isActive, $indices) {
     $this->isActive = $isActive;
@@ -206,7 +194,8 @@ class CRM_Core_InnoDBIndexer {
    *   (string $indexName => string $sql)
    */
   public function buildIndexSql($table) {
-    $sqls = []; // array (string $idxName => string $sql)
+    // array (string $idxName => string $sql)
+    $sqls = [];
     if ($this->isActive && isset($this->indices[$table])) {
       foreach ($this->indices[$table] as $fields) {
         $name = self::IDX_PREFIX . md5($table . '::' . implode(',', $fields));