Merge pull request #15854 from eileenmcnaughton/test_fix

[civicrm-core.git] / CRM / Utils / QueryFormatter.php

diff --git a/CRM/Utils/QueryFormatter.php b/CRM/Utils/QueryFormatter.php
index d45bad66034be5967d56774f5511de72c23b3955..d54cc0e78236cd8aa4617354e3fbe422092837a1 100644 (file)
--- a/CRM/Utils/QueryFormatter.php
+++ b/CRM/Utils/QueryFormatter.php
@@ -1,33 +1,17 @@
 <?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       |
  +--------------------------------------------------------------------+
  */
 
  /**
   * @package CRM
-  * @copyright CiviCRM LLC (c) 2004-2019
+  * @copyright CiviCRM LLC https://civicrm.org/licensing
   */
 
 /**
@@ -88,6 +72,11 @@ class CRM_Utils_QueryFormatter {
    */
   const MODE_WILDWORDS_SUFFIX = 'wildwords-suffix';
 
+  /**
+   * Singleton object.
+   *
+   * @var \CRM_Utils_QueryFormatter|null
+   */
   static protected $singleton;
 
   /**
@@ -192,16 +181,16 @@ class CRM_Utils_QueryFormatter {
       list ($tableName, $tableAlias) = explode(' ', $table);
     }
     if (is_scalar($columns)) {
-      $columns = array($columns);
+      $columns = [$columns];
     }
 
-    $clauses = array();
+    $clauses = [];
     if (CRM_Core_InnoDBIndexer::singleton()
       ->hasDeclaredIndex($tableName, $columns)
     ) {
       $formattedQuery = $this->format($queryText, CRM_Utils_QueryFormatter::LANG_SQL_FTSBOOL);
 
-      $prefixedFieldNames = array();
+      $prefixedFieldNames = [];
       foreach ($columns as $fieldName) {
         $prefixedFieldNames[] = "$tableAlias.$fieldName";
       }
@@ -287,8 +276,8 @@ class CRM_Utils_QueryFormatter {
    */
   protected function _formatFtsBool($text, $mode) {
     $result = NULL;
-    $operators = array('+', '-', '~', '(', ')');
-    $wildCards = array('@', '%', '*');
+    $operators = ['+', '-', '~', '(', ')'];
+    $wildCards = ['@', '%', '*'];
     $expression = preg_quote(implode('', array_merge($operators, $wildCards)), '/');
 
     //Return if searched string ends with an unsupported operator.
@@ -399,7 +388,7 @@ class CRM_Utils_QueryFormatter {
    * @return string
    */
   protected function mapWords($text, $template, $quotes = FALSE) {
-    $result = array();
+    $result = [];
     foreach ($this->parseWords($text, $quotes) as $word) {
       $result[] = str_replace('word', $word, $template);
     }
@@ -407,8 +396,8 @@ class CRM_Utils_QueryFormatter {
   }
 
   /**
-   * @param $text
-   * @bool $quotes
+   * @param string $text
+   * @param bool $quotes
    * @return array
    */
   protected function parseWords($text, $quotes) {
@@ -458,13 +447,13 @@ class CRM_Utils_QueryFormatter {
    * @return array
    */
   public static function getModes() {
-    return array(
+    return [
       self::MODE_NONE,
       self::MODE_PHRASE,
       self::MODE_WILDPHRASE,
       self::MODE_WILDWORDS,
       self::MODE_WILDWORDS_SUFFIX,
-    );
+    ];
   }
 
   /**
@@ -473,12 +462,12 @@ class CRM_Utils_QueryFormatter {
    * @return array
    */
   public static function getLanguages() {
-    return array(
+    return [
       self::LANG_SOLR,
       self::LANG_SQL_FTS,
       self::LANG_SQL_FTSBOOL,
       self::LANG_SQL_LIKE,
-    );
+    ];
   }
 
   /**