PHP 클래스 TbExtendedFilter

This widget displays an extra row to the grid is attached to and renders a visual feedback of the filter values used plus an option to save them for later use.
상속: extends CWidget
파일 보기 프로젝트 열기: yinhe/yincart

공개 프로퍼티들

프로퍼티 타입 설명
$filteredBy the cleaned filter attributes
$grid the grid view the widget is going to be used with
$model the model that works as a filter to the grid
$redirectRoute the route to redirect when saving/removing a filter
$removeFilterVar the ajax variable that is used to check whether to delete a filter from the registry
$saveFilterVar the ajax variable that is used to check whether a filter is to be saved

보호된 프로퍼티들

프로퍼티 타입 설명
$jsonStorage Component
$registry the name of the json registry to save the value

공개 메소드들

메소드 설명
init ( ) ### .init()
registerClientScript ( ) ### .registerClientScript()
run ( ) ### .run()

보호된 메소드들

메소드 설명
checkRequestFilters ( ) : boolean ### .checkRequestFilters()
checkRequestRemovalFilter ( ) ### .checkRequestRemovalFilter()
displayExtendedFilterValues ( array $filteredBy ) : string ### .displayExtendedFilterValues()
displaySaveButton ( string $registryKey ) : boolean ### .displaySaveButton()
displaySavedFilters ( string $registryKey ) ### .displaySavedFilters()
generateRegistryItemKey ( ) : null | string ### .generateRegistryItemKey()

메소드 상세

checkRequestFilters() 보호된 메소드

Checkes whether there has been send the command to save a filter to the registry and redirects to specified route
protected checkRequestFilters ( ) : boolean
리턴 boolean

checkRequestRemovalFilter() 보호된 메소드

Checks whether there has been send the command to remove a filter from the registry and redirects to specified route

displayExtendedFilterValues() 보호된 메소드

Displays the filtered options
protected displayExtendedFilterValues ( array $filteredBy ) : string
$filteredBy array
리턴 string

displaySaveButton() 보호된 메소드

Displays the save filter button
protected displaySaveButton ( string $registryKey ) : boolean
$registryKey string
리턴 boolean

displaySavedFilters() 보호된 메소드

displays the saved filters as a dropdown list
protected displaySavedFilters ( string $registryKey )
$registryKey string

generateRegistryItemKey() 보호된 메소드

Generates a registry item key with the filtered attributes + the grid id
protected generateRegistryItemKey ( ) : null | string
리턴 null | string

init() 공개 메소드

Widget initialization
public init ( )

registerClientScript() 공개 메소드

Registers the required

run() 공개 메소드

Widget's run method
public run ( )

프로퍼티 상세

$filteredBy 공개적으로 프로퍼티

the cleaned filter attributes
public $filteredBy

$grid 공개적으로 프로퍼티

the grid view the widget is going to be used with
public $grid

$jsonStorage 보호되어 있는 프로퍼티

Component
protected $jsonStorage

$model 공개적으로 프로퍼티

the model that works as a filter to the grid
public $model

$redirectRoute 공개적으로 프로퍼티

the route to redirect when saving/removing a filter
public $redirectRoute

$registry 보호되어 있는 프로퍼티

the name of the json registry to save the value
protected $registry

$removeFilterVar 공개적으로 프로퍼티

the ajax variable that is used to check whether to delete a filter from the registry
public $removeFilterVar

$saveFilterVar 공개적으로 프로퍼티

the ajax variable that is used to check whether a filter is to be saved
public $saveFilterVar