SearchOption¶

class OC\FullTextSearch\Model\SearchOption¶

Source:	lib/private/FullTextSearch/Model/SearchOption.php#39
Implements:	`OCP\FullTextSearch\Model\ISearchOption` `JsonSerializable`

Properties¶

public OC\FullTextSearch\Model\SearchOption::__construct($name="", $title="", $type="", $size="", $placeholder="")¶

ISearchOption constructor.

Some value can be setduring the creation of the object.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#120
Parameters:	$name (string) $title (string) $type (string) $size (string) $placeholder (string)
Since:	15.0.0

public OC\FullTextSearch\Model\SearchOption::setName($name)¶

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

Source:	lib/private/FullTextSearch/Model/SearchOption.php#142
Parameters:	$name (string)
See:	`\OC\FullTextSearch\Model\ISearchRequest::getOption`
Since:	15.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OC\FullTextSearch\Model\SearchOption::getName()¶

Get the name/key of the option.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#155
Since:	15.0.0
Returns:	string

public OC\FullTextSearch\Model\SearchOption::setTitle($title)¶

Set the title/display name of the option.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#169
Parameters:	$title (string)
Since:	15.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OC\FullTextSearch\Model\SearchOption::getTitle()¶

Get the title of the option.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#182
Since:	15.0.0
Returns:	string

public OC\FullTextSearch\Model\SearchOption::setType($type)¶

Set the type of the option.

$type can be ISearchOption::CHECKBOX or ISearchOption::INPUT

Source:	lib/private/FullTextSearch/Model/SearchOption.php#197
Parameters:	$type (string)
Since:	15.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OC\FullTextSearch\Model\SearchOption::getType()¶

Get the type of the option.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#210
Since:	15.0.0
Returns:	string

public OC\FullTextSearch\Model\SearchOption::setSize($size)¶

In case of Type is INPUT, set the size of the input field.

Value can be ISearchOption::INPUT_SMALL or not defined.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#225
Parameters:	$size (string)
Since:	15.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OC\FullTextSearch\Model\SearchOption::getSize()¶

Get the size of the INPUT.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#238
Since:	15.0.0
Returns:	string

public OC\FullTextSearch\Model\SearchOption::setPlaceholder($placeholder)¶

In case of Type is , set the placeholder to be displayed in the input

field.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#253
Parameters:	$placeholder (string)
Since:	15.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OC\FullTextSearch\Model\SearchOption::getPlaceholder()¶

Get the placeholder.

Source:	lib/private/FullTextSearch/Model/SearchOption.php#266
Since:	15.0.0
Returns:	string

public OC\FullTextSearch\Model\SearchOption::jsonSerialize()¶

Source:	lib/private/FullTextSearch/Model/SearchOption.php#276
Since:	15.0.0
Returns:	array