nextcloud/lib/private/FullTextSearch/Model/SearchOption.php

292 lines
5.9 KiB
PHP

<?php
declare(strict_types=1);
/**
* FullTextSearch - Full text search framework for Nextcloud
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2018
* @license GNU AGPL version 3 or any later version
*
* This program 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.
*
* This program 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\FullTextSearch\Model;
use JsonSerializable;
use OCP\FullTextSearch\Model\ISearchOption;
/**
* @since 15.0.0
*
* Class ISearchOption
*
* @package OC\FullTextSearch\Model
*/
final class SearchOption implements ISearchOption, JsonSerializable {
/** @var string */
private $name = '';
/** @var string */
private $title = '';
/** @var string */
private $type = '';
/** @var string */
private $size = '';
/** @var string */
private $placeholder = '';
/**
* *
*
* The array can be empty in case no search options are available.
* The format of the array must be like this:
*
* [
* 'panel' => [
* 'options' => [
* OPTION1,
* OPTION2,
* OPTION3
* ]
* ],
* 'navigation' => [
* 'icon' => 'css-class-of-the-icon',
* 'options' => [
* OPTION1,
* OPTION2,
* OPTION3
* ]
* ]
* ]
*
* - PANEL contains entries that will be displayed in the app itself, when
* a search is initiated.
* - NAVIGATION contains entries that will be available when using the
* FullTextSearch navigation page
* - OPTION is an element that define each option available to the user.
*
* The format for the options must be like this:
*
* [
* 'name' => 'name_of_the_option',
* 'title' => 'Name displayed in the panel',
* 'type' => '',
* 'size' => '' (optional),
* 'placeholder' => '' (optional)
* ]
*
* - NAME is the variable name that is sent to the IFullTextSearchProvider
* when a ISearchRequest is requested. (keys in the array returned by the
* ISearchRequest->getOptions())
* - TYPE can be 'input' or 'checkbox'
* - SIZE is only used in case TYPE='input', default is 'large' but can be
* 'small'
* - PLACEHOLDER is only used in case TYPE='input', default is empty.
*/
/**
* ISearchOption constructor.
*
* Some value can be setduring the creation of the object.
*
* @since 15.0.0
*
* @param string $name
* @param string $title
* @param string $type
* @param string $size
* @param string $placeholder
*/
public function __construct(string $name = '', string $title = '', string $type = '', string $size = '', string $placeholder = '') {
$this->name = $name;
$this->title = $title;
$this->type = $type;
$this->size = $size;
$this->placeholder = $placeholder;
}
/**
* Set the name/key of the option.
* The string should only contains alphanumerical chars and underscore.
* The key can be retrieve when using ISearchRequest::getOption
*
* @see ISearchRequest::getOption
*
* @since 15.0.0
*
* @param string $name
*
* @return ISearchOption
*/
public function setName(string $name): ISearchOption {
$this->name = $name;
return $this;
}
/**
* Get the name/key of the option.
*
* @since 15.0.0
*
* @return string
*/
public function getName(): string {
return $this->name;
}
/**
* Set the title/display name of the option.
*
* @since 15.0.0
*
* @param string $title
*
* @return ISearchOption
*/
public function setTitle(string $title): ISearchOption {
$this->title = $title;
return $this;
}
/**
* Get the title of the option.
*
* @since 15.0.0
*
* @return string
*/
public function getTitle(): string {
return $this->title;
}
/**
* Set the type of the option.
* $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
*
* @since 15.0.0
*
* @param string $type
*
* @return ISearchOption
*/
public function setType(string $type): ISearchOption {
$this->type = $type;
return $this;
}
/**
* Get the type of the option.
*
* @since 15.0.0
*
* @return string
*/
public function getType(): string {
return $this->type;
}
/**
* In case of Type is INPUT, set the size of the input field.
* Value can be ISearchOption::INPUT_SMALL or not defined.
*
* @since 15.0.0
*
* @param string $size
*
* @return ISearchOption
*/
public function setSize(string $size): ISearchOption {
$this->size = $size;
return $this;
}
/**
* Get the size of the INPUT.
*
* @since 15.0.0
*
* @return string
*/
public function getSize(): string {
return $this->size;
}
/**
* In case of Type is , set the placeholder to be displayed in the input
* field.
*
* @since 15.0.0
*
* @param string $placeholder
*
* @return ISearchOption
*/
public function setPlaceholder(string $placeholder): ISearchOption {
$this->placeholder = $placeholder;
return $this;
}
/**
* Get the placeholder.
*
* @since 15.0.0
*
* @return string
*/
public function getPlaceholder(): string {
return $this->placeholder;
}
/**
* @since 15.0.0
*
* @return array
*/
public function jsonSerialize(): array {
return [
'name' => $this->getName(),
'title' => $this->getTitle(),
'type' => $this->getType(),
'size' => $this->getSize(),
'placeholder' => $this->getPlaceholder()
];
}
}