PHP Class Prado\Data\ActiveRecord\Scaffold\TScaffoldSearch

The {@link getSearchText SearchText} property is a TTextBox and the {@link getSearchButton SearchButton} property is a TButton with label value "Search". Searchable fields of the Active Record can be restricted by specifying a comma delimited string of allowable fields in the {@link setSearchableFields SearchableFields} property. The default is null, meaning that most text type fields are searched (the default searchable fields are database dependent).
Since: 3.1
Inheritance: extends TScaffoldBase
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode Description
bubbleEvent ( $sender, $param ) Sets the SearchCondition of the TScaffoldListView as the search terms given by the text of the search text box.
getListViewID ( ) : string
getSearchButton ( ) : TButton
getSearchText ( ) : TTextBox
getSearchableFields ( ) : string
setListViewID ( $value )
setSearchableFields ( $value )

Méthodes protégées

Méthode Description
createSearchCondition ( ) : string
getFields ( ) : array
getListView ( ) : TScaffoldListView

Method Details

bubbleEvent() public méthode

Sets the SearchCondition of the TScaffoldListView as the search terms given by the text of the search text box.
public bubbleEvent ( $sender, $param )

createSearchCondition() protected méthode

protected createSearchCondition ( ) : string
Résultat string the search criteria for the search terms in the search text box.

getFields() protected méthode

protected getFields ( ) : array
Résultat array list of fields to be searched.

getListView() protected méthode

protected getListView ( ) : TScaffoldListView
Résultat TScaffoldListView the scaffold list view this search box belongs to.

getListViewID() public méthode

public getListViewID ( ) : string
Résultat string ID of the TScaffoldListView this search control belongs to.

getSearchButton() public méthode

public getSearchButton ( ) : TButton
Résultat TButton button with default label "Search".

getSearchText() public méthode

public getSearchText ( ) : TTextBox
Résultat TTextBox search text box.

getSearchableFields() public méthode

public getSearchableFields ( ) : string
Résultat string comma delimited list of fields that may be searched.

setListViewID() public méthode

public setListViewID ( $value )

setSearchableFields() public méthode

public setSearchableFields ( $value )