SearchForm
in package
This is the SearchForm class, a macro class for the utilViewHelper.
The purpose of this class is to encapsulate the logic that calculates the view parameters for the util's search form.
Tags
Table of Contents
| SEARCH_BY_CT_SEARCH_ALL | = 'searchAll' | |
|---|---|---|
| SEARCH_BY_CT_SEARCH_DEFAULT | = '' | |
| SEARCH_BY_CT_SHOW_CHECKS | = 'showChecks' | |
| SEARCH_BY_CT_SHOW_COMBO | = 'showCombo' | |
| SEARCH_BY_CT_SHOW_RADIOS | = 'showRadios' | |
| $form | : Form|null | |
| $minCharacters | : int | |
| $searchBlog | : bool | |
| $searchByCustomTags | : string | |
| $searchCategories | : bool | |
| $searchNews | : bool | |
| $searchPages | : bool | |
| $searchProducts | : bool | |
| $showLabel | : bool | |
| $showPlaceholder | : bool | |
| $useSuggest | : bool | |
| __construct() | Constructor method for SearchForm | : mixed |
| getViewParameters() | This method returns all calculated arguments and new parameters for UserViewHelper.php | : array<string|int, mixed> |
| getProperties() | Return macro use properties | : array<string|int, mixed> |
Constants
SEARCH_BY_CT_SEARCH_ALL
public
mixed
SEARCH_BY_CT_SEARCH_ALL
= 'searchAll'
SEARCH_BY_CT_SEARCH_DEFAULT
public
mixed
SEARCH_BY_CT_SEARCH_DEFAULT
= ''
SEARCH_BY_CT_SHOW_CHECKS
public
mixed
SEARCH_BY_CT_SHOW_CHECKS
= 'showChecks'
SEARCH_BY_CT_SHOW_COMBO
public
mixed
SEARCH_BY_CT_SHOW_COMBO
= 'showCombo'
SEARCH_BY_CT_SHOW_RADIOS
public
mixed
SEARCH_BY_CT_SHOW_RADIOS
= 'showRadios'
Properties
$form
public
Form|null
$form
= null
$minCharacters
public
int
$minCharacters
= 3
$searchBlog
public
bool
$searchBlog
= false
$searchByCustomTags
public
string
$searchByCustomTags
= self::SEARCH_BY_CT_SEARCH_DEFAULT
$searchCategories
public
bool
$searchCategories
= false
$searchNews
public
bool
$searchNews
= false
$searchPages
public
bool
$searchPages
= false
$searchProducts
public
bool
$searchProducts
= true
$showLabel
public
bool
$showLabel
= true
$showPlaceholder
public
bool
$showPlaceholder
= true
$useSuggest
public
bool
$useSuggest
= false
Methods
__construct()
Constructor method for SearchForm
public
__construct(array<string|int, mixed> $arguments) : mixed
Parameters
- $arguments : array<string|int, mixed>
Tags
Return values
mixed —getViewParameters()
This method returns all calculated arguments and new parameters for UserViewHelper.php
public
getViewParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getProperties()
Return macro use properties
protected
getProperties() : array<string|int, mixed>