ISearchOption¶

interface OCP\FullTextSearch\Model\ISearchOption¶

Implemented by:	`OC\FullTextSearch\Model\SearchOption`
Source:	lib/public/FullTextSearch/Model/ISearchOption.php#36

Constants¶

CHECKBOX = checkbox

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#42
Since:	16.0.0

INPUT = input

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#47
Since:	16.0.0

INPUT_SMALL = small

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#52
Since:	16.0.0

public OCP\FullTextSearch\Model\ISearchOption::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/public/FullTextSearch/Model/ISearchOption.php#68
Parameters:	$name (string)
See:	`\OCP\FullTextSearch\Model\ISearchRequest::getOption`
Since:	16.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OCP\FullTextSearch\Model\ISearchOption::getName()¶

Get the name/key of the option.

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#77
Since:	16.0.0
Returns:	string

public OCP\FullTextSearch\Model\ISearchOption::setTitle($title)¶

Set the title/display name of the option.

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#89
Parameters:	$title (string)
Since:	16.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OCP\FullTextSearch\Model\ISearchOption::getTitle()¶

Get the title of the option.

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#98
Since:	16.0.0
Returns:	string

public OCP\FullTextSearch\Model\ISearchOption::setType($type)¶

Set the type of the option.

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

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#111
Parameters:	$type (string)
Since:	16.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OCP\FullTextSearch\Model\ISearchOption::getType()¶

Get the type of the option.

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#120
Since:	16.0.0
Returns:	string

public OCP\FullTextSearch\Model\ISearchOption::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/public/FullTextSearch/Model/ISearchOption.php#133
Parameters:	$size (string)
Since:	16.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OCP\FullTextSearch\Model\ISearchOption::getSize()¶

Get the size of the INPUT.

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#142
Since:	16.0.0
Returns:	string

public OCP\FullTextSearch\Model\ISearchOption::setPlaceholder($placeholder)¶

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

field.

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#155
Parameters:	$placeholder (string)
Since:	16.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchOption`

public OCP\FullTextSearch\Model\ISearchOption::getPlaceholder()¶

Get the placeholder.

Source:	lib/public/FullTextSearch/Model/ISearchOption.php#164
Since:	16.0.0
Returns:	string