PHP Class QuickSearch, atk4

.. Reference: http://agiletoolkit.org/doc/ref *ATK4***************************************************** This file is part of Agile Toolkit 4 http://agiletoolkit.org (c) 2008-2011 Agile Technologies Ireland Limited Distributed under Affero General Public License v3 If you are using this file in YOUR web software, you must make your make source code for YOUR web software public. See LICENSE.txt for more information You can obtain non-public copy of Agile Toolkit 4 at http://agiletoolkit.org/commercial ****************************************************ATK4*
Inheritance: extends Filter
Show file Open project: atk4/atk4 Class Usage Examples

Public Properties

Property Type Description
$bset_class Button set class name
$bset_position Button set positioning
$cancel_icon Cancel button icon
$fields array
$search_field Form_Field
$show_cancel Shoud we add Cancel button or not
$submit_icon Submit button icon

Protected Properties

Property Type Description
$bset object iteself

Public Methods

Method Description
defaultTemplate ( ) : array | string Default template
init ( ) Initialization.
postInit ( ) : Model | void Process received filtering parameters after init phase.
useFields ( string | array $fields ) : QuickSearch Set fields on which filtering will be done.

Method Details

defaultTemplate() public method

Default template
public defaultTemplate ( ) : array | string
return array | string

init() public method

Initialization.
public init ( )

postInit() public method

Process received filtering parameters after init phase.
public postInit ( ) : Model | void
return Model | void

useFields() public method

Set fields on which filtering will be done.
public useFields ( string | array $fields ) : QuickSearch
$fields string | array
return QuickSearch $this

Property Details

$bset protected property

object iteself
protected $bset

$bset_class public property

Button set class name
public $bset_class

$bset_position public property

Button set positioning
public $bset_position

$cancel_icon public property

Cancel button icon
public $cancel_icon

$fields public property

public array $fields
return array

$search_field public property

public Form_Field $search_field
return Form_Field

$show_cancel public property

Shoud we add Cancel button or not
public $show_cancel

$submit_icon public property

Submit button icon
public $submit_icon