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

Exibir arquivo Open project: pradosoft/prado

Public Methods

Method	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 )

Protected Methods

Method	Description
createSearchCondition ( ) : string
getFields ( ) : array
getListView ( ) : TScaffoldListView

Method Details

bubbleEvent() public method

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 method

protected createSearchCondition ( ) : string
return	string	the search criteria for the search terms in the search text box.

getFields() protected method

protected getFields ( ) : array
return	array	list of fields to be searched.

getListView() protected method

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

getListViewID() public method

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

getSearchButton() public method

public getSearchButton ( ) : TButton
return	TButton	button with default label "Search".

getSearchText() public method

public getSearchText ( ) : TTextBox
return	TTextBox	search text box.

getSearchableFields() public method

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

setListViewID() public method

public setListViewID ( $value )

setSearchableFields() public method

public setSearchableFields ( $value )