QueryParser.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Backend\Search\LiveSearch;
 
class ‪QueryParser
{
    protected ‪$commandKey = '';
 
    protected ‪$tableName = '';
 
    public const ‪COMMAND_KEY_INDICATOR = '#';
 
    public const ‪COMMAND_SPLIT_INDICATOR = ':';
 
    protected function ‪extractKeyFromQuery($query)
    {
        [‪$this->commandKey] = explode(':', substr($query, 1));
    }
 
    public function ‪getSearchQueryValue($query)
    {
        $this->‪extractKeyFromQuery($query);
        return str_replace(self::COMMAND_KEY_INDICATOR . $this->commandKey . self::COMMAND_SPLIT_INDICATOR, '', $query);
    }
 
    public function ‪getTableNameFromCommand($query)
    {
        ‪$tableName = '';
        $this->‪extractKeyFromQuery($query);
        if (array_key_exists($this->commandKey, ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['livesearch'])) {
            ‪$tableName = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['livesearch'][‪$this->commandKey];
        }
        return ‪$tableName;
    }
 
    public function ‪getId($query)
    {
        return (int)str_replace(self::COMMAND_KEY_INDICATOR, '', $query);
    }
 
    public function ‪isValidPageJump($query)
    {
        $isValid = false;
        if (preg_match('~^#(\\d)+$~', $query)) {
            $isValid = true;
        }
        return $isValid;
    }
 
    public function ‪isValidCommand($query)
    {
        $isValid = false;
        if (str_starts_with($query, self::COMMAND_KEY_INDICATOR) && strpos($query, self::COMMAND_SPLIT_INDICATOR) > 1 && $this->‪getTableNameFromCommand($query)) {
            $isValid = true;
        }
        return $isValid;
    }
 
    public function ‪getCommandForTable(‪$tableName)
    {
        $commandArray = array_keys(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['livesearch'], ‪$tableName);
        return $commandArray[0] ?? '';
    }
 
    public function ‪getCommandForPageJump($query)
    {
        if ($this->‪isValidPageJump($query)) {
            $command = $this->‪getCommandForTable('pages');
            $id = $this->‪getId($query);
            $resultQuery = self::COMMAND_KEY_INDICATOR . $command . self::COMMAND_SPLIT_INDICATOR . $id;
        } else {
            $resultQuery = false;
        }
        return $resultQuery;
    }
}