Your IP : 216.73.217.13
<?php
/*
* 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 for parsing query parameters in backend live search.
* Detects searches for #pages:23 or #content:mycontent
*
* @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
*/
class QueryParser
{
/**
* @var string
*/
protected $commandKey = '';
/**
* @var string
*/
protected $tableName = '';
/**
* @var string
*/
public const COMMAND_KEY_INDICATOR = '#';
/**
* @var string
*/
public const COMMAND_SPLIT_INDICATOR = ':';
/**
* Retrieve the validated command key
*
* @param string $query
*/
protected function extractKeyFromQuery($query)
{
[$this->commandKey] = explode(':', substr($query, 1));
}
/**
* Extract the search value from the full search query which contains also the command part.
*
* @param string $query For example #news:weather
* @return string The extracted search value
*/
public function getSearchQueryValue($query)
{
$this->extractKeyFromQuery($query);
return str_replace(self::COMMAND_KEY_INDICATOR . $this->commandKey . self::COMMAND_SPLIT_INDICATOR, '', $query);
}
/**
* Find the registered table command and retrieve the matching table name.
*
* @param string $query
* @return string Database Table name
*/
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;
}
/**
* Verify if a given query contains a page jump command.
*
* @param string $query A valid value looks like '#14'
* @return int
*/
public function getId($query)
{
return (int)str_replace(self::COMMAND_KEY_INDICATOR, '', $query);
}
/**
* Verify if a given query contains a page jump command.
*
* @param string $query A valid value looks like '#14'
* @return bool
*/
public function isValidPageJump($query)
{
$isValid = false;
if (preg_match('~^#(\\d)+$~', $query)) {
$isValid = true;
}
return $isValid;
}
/**
* Verify if a given query contains a registered command key.
*
* @param string $query
* @return bool
*/
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;
}
/**
* Gets the command for the given table.
*
* @param string $tableName The table to find a command for.
* @return string
*/
public function getCommandForTable($tableName)
{
$commandArray = array_keys($GLOBALS['TYPO3_CONF_VARS']['SYS']['livesearch'], $tableName);
return $commandArray[0] ?? '';
}
/**
* Gets the page jump command for a given query.
*
* @param string $query
* @return string
*/
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;
}
}