class.t3lib_search_livesearch_queryParser.php

Go to the documentation of this file.

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2009-2011 Michael Klapper <michael.klapper@aoemedia.de>
 *  (c) 2010-2011 Jeff Segars <jeff@webempoweredchurch.org>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
 *
 *  This script 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 General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 * Class for parsing query parameters in backend live search.
 *
 * @author Michael Klapper <michael.klapper@aoemedia.de>
 * @author Jeff Segars <jeff@webempoweredchurch.org>
 * @package TYPO3
 * @subpackage t3lib
 */
class t3lib_search_livesearch_queryParser {

    /**
     * @var string
     */
    protected $commandKey = '';

    /**
     * @var string
     */
    protected $tableName = '';

    /**
     * @var string
     */
    const COMMAND_KEY_INDICATOR = '#';

    /**
     * @var string
     */
    const COMMAND_SPLIT_INDICATOR = ':';

    /**
     * Retrive the validated command key
     *
     * @return string Command name
     */
    protected function extractKeyFromQuery($query) {
        $keyAndValue = substr($query, 1);
        $key = explode(':', $keyAndValue);
        $this->commandKey = $key[0];
    }

    /**
     * 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 registerd 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 (is_array($GLOBALS['TYPO3_CONF_VARS']['SYS']['livesearch']) && array_key_exists($this->commandKey, $GLOBALS['TYPO3_CONF_VARS']['SYS']['livesearch'])) {
            $tableName = $GLOBALS['TYPO3_CONF_VARS']['SYS']['livesearch'][$this->commandKey];
        }

        return $tableName;
    }

    /**
     * Verify if an given query contains a page jump command.
     *
     * @param string $query A valid value looks like '#14'
     * @return integer
     */
    public function getId($query) {
        return 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 boolean
     */
    public function isValidPageJump($query) {
        $isValid = FALSE;

        if (preg_match('~^#(\d)+$~', $query)) {
            $isValid = TRUE;
        }

        return $isValid;
    }

    /**
     * Verify if an given query contains an registered command key.
     *
     * @param string $query
     * @return boolean
     */
    public function isValidCommand($query) {
        $isValid = FALSE;
        if (strpos($query, self::COMMAND_KEY_INDICATOR) === 0 &&
            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);
        if (is_array($commandArray)) {
            $command = $commandArray[0];
        } else {
            $command = FALSE;
        }

        return $command;
    }

    /**
     * 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;
    }
}

?>