ISearchOption
Tags
Table of Contents
- CHECKBOX = 'checkbox'
- INPUT = 'input'
- INPUT_SMALL = 'small'
- getName() : string
- Get the name/key of the option.
- getPlaceholder() : string
- Get the placeholder.
- getSize() : string
- Get the size of the INPUT.
- getTitle() : string
- Get the title of the option.
- getType() : string
- Get the type of the option.
- setName() : ISearchOption
- Set the name/key of the option.
- setPlaceholder() : ISearchOption
- In case of Type is , set the placeholder to be displayed in the input field.
- setSize() : ISearchOption
- In case of Type is INPUT, set the size of the input field.
- setTitle() : ISearchOption
- Set the title/display name of the option.
- setType() : ISearchOption
- Set the type of the option.
Constants
CHECKBOX
public
mixed
CHECKBOX
= 'checkbox'
Tags
INPUT
public
mixed
INPUT
= 'input'
Tags
INPUT_SMALL
public
mixed
INPUT_SMALL
= 'small'
Tags
Methods
getName()
Get the name/key of the option.
public
getName() : string
Tags
Return values
string —getPlaceholder()
Get the placeholder.
public
getPlaceholder() : string
Tags
Return values
string —getSize()
Get the size of the INPUT.
public
getSize() : string
Tags
Return values
string —getTitle()
Get the title of the option.
public
getTitle() : string
Tags
Return values
string —getType()
Get the type of the option.
public
getType() : string
Tags
Return values
string —setName()
Set the name/key of the option.
public
setName(string $name) : ISearchOption
The string should only contains alphanumerical chars and underscore. The key can be retrieve when using ISearchRequest::getOption
Parameters
- $name : string
Tags
Return values
ISearchOption —setPlaceholder()
In case of Type is , set the placeholder to be displayed in the input field.
public
setPlaceholder(string $placeholder) : ISearchOption
Parameters
- $placeholder : string
Tags
Return values
ISearchOption —setSize()
In case of Type is INPUT, set the size of the input field.
public
setSize(string $size) : ISearchOption
Value can be ISearchOption::INPUT_SMALL or not defined.
Parameters
- $size : string
Tags
Return values
ISearchOption —setTitle()
Set the title/display name of the option.
public
setTitle(string $title) : ISearchOption
Parameters
- $title : string
Tags
Return values
ISearchOption —setType()
Set the type of the option.
public
setType(string $type) : ISearchOption
$type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
Parameters
- $type : string