DataTables
DataScout Class Reference
Inheritance diagram for DataScout:
Collaboration diagram for DataScout:

Public Member Functions

 __construct (array $searchableFields=[], $remember=false)
 
 _shapeData ()
 
 addQuery (string $value)
 
 buttonText (string $text)
 
 placeholder (string $text)
 
 makeSearchable (string $field)
 
 render ()
 
- Public Member Functions inherited from DataComponent
 init (DataTable $dataTable)
 
 remember ()
 
 forget ()
 
 transformData ()
 
 getName ()
 
 render ()
 

Protected Member Functions

 _afterInit ()
 
- Protected Member Functions inherited from DataComponent
 _readFromSession ()
 
 _afterInit ()
 
 _storeInSession ()
 
 _shapeData ()
 

Additional Inherited Members

- Protected Attributes inherited from DataComponent
 $_rememberState = false
 
 $_rememberKey = 'global'
 
 $_dataTable
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( array  $searchableFields = [],
  $remember = false 
)

DataScout constructor.

Parameters
array$searchableFields
bool$remember

Member Function Documentation

◆ _shapeData()

_shapeData ( )
Returns
Builder

◆ addQuery()

addQuery ( string  $value)

Add a query programmatically.

Parameters
string$value
Returns
DataScout

◆ buttonText()

buttonText ( string  $text)

Set the text for the search button.

Parameters
string$text
Returns
DataScout

◆ makeSearchable()

makeSearchable ( string  $field)

Make the field searchable.

Parameters
string$field
Returns
DataScout

◆ placeholder()

placeholder ( string  $text)

Set the placeholder for the input.

Parameters
string$text
Returns
DataScout

◆ render()

render ( )
Returns
string

The documentation for this class was generated from the following file: