mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-13 07:24:13 +01:00
130 lines
3.2 KiB
PHP
130 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* Copyright (C) 2013-2020 Combodo SARL
|
|
*
|
|
* This file is part of iTop.
|
|
*
|
|
* iTop is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* iTop 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
|
|
*/
|
|
|
|
namespace Combodo\iTop\Application\UI\Component\GlobalSearch;
|
|
|
|
|
|
use Combodo\iTop\Application\UI\UIBlock;
|
|
use MetaModel;
|
|
use utils;
|
|
|
|
/**
|
|
* Class GlobalSearch
|
|
*
|
|
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
|
|
* @package Combodo\iTop\Application\UI\Component\GlobalSearch
|
|
* @internal
|
|
* @since 3.0.0
|
|
*/
|
|
class GlobalSearch extends UIBlock
|
|
{
|
|
// Overloaded constants
|
|
public const BLOCK_CODE = 'ibo-global-search';
|
|
public const HTML_TEMPLATE_REL_PATH = 'components/global-search/layout';
|
|
public const JS_TEMPLATE_REL_PATH = 'components/global-search/layout';
|
|
public const JS_FILES_REL_PATH = [
|
|
'js/components/global-search.js',
|
|
];
|
|
|
|
public const DEFAULT_ENDPOINT_REL_URL = 'pages/UI.php?operation=full_text';
|
|
|
|
/** @var string $sEndpoint Absolute endpoint URL of the search form */
|
|
protected $sEndpoint;
|
|
/** @var array $aLastQueries */
|
|
protected $aLastQueries;
|
|
/** @var int $iMaxHistoryResults Max. number of elements in the history */
|
|
protected $iMaxHistoryResults;
|
|
|
|
/**
|
|
* GlobalSearch constructor.
|
|
*
|
|
* @param array $aLastQueries
|
|
* @param string|null $sId
|
|
*
|
|
* @throws \Exception
|
|
*/
|
|
public function __construct(array $aLastQueries = [], ?string $sId = null)
|
|
{
|
|
parent::__construct($sId);
|
|
$this->SetEndpoint(static::DEFAULT_ENDPOINT_REL_URL);
|
|
$this->SetLastQueries($aLastQueries);
|
|
$this->iMaxHistoryResults = (int) MetaModel::GetConfig()->Get('quick_create.max_history_results');
|
|
}
|
|
|
|
/**
|
|
* Set the search form endpoint URL.
|
|
* If $bRelativeUrl is true, then $sEndpoint will be complete with the app_root_url
|
|
*
|
|
* @param string $sEndpoint URL to the endpoint
|
|
* @param bool $bRelativeUrl Whether or not the $sEndpoint parameter is a relative URL
|
|
*
|
|
* @return $this
|
|
* @throws \Exception
|
|
*/
|
|
public function SetEndpoint(string $sEndpoint, bool $bRelativeUrl = true)
|
|
{
|
|
$this->sEndpoint = (($bRelativeUrl) ? utils::GetAbsoluteUrlAppRoot() : '').$sEndpoint;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Return the absolute URL of the search form
|
|
*
|
|
* @return string
|
|
* @throws \Exception
|
|
*/
|
|
public function GetEndpoint()
|
|
{
|
|
return $this->sEndpoint;
|
|
}
|
|
|
|
/**
|
|
* Set all the last queries at once
|
|
*
|
|
* @param array $aLastQueries
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function SetLastQueries(array $aLastQueries)
|
|
{
|
|
$this->aLastQueries = $aLastQueries;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Return the last queries (query itself, label as HTML)
|
|
*
|
|
* @return array
|
|
*/
|
|
public function GetLastQueries()
|
|
{
|
|
return $this->aLastQueries;
|
|
}
|
|
|
|
/**
|
|
* @see $iMaxHistoryResults
|
|
* @return int
|
|
*/
|
|
public function GetMaxHistoryResults(): int
|
|
{
|
|
return $this->iMaxHistoryResults;
|
|
}
|
|
} |