PHP 클래스 Grido\Grid

저자: Petr Bugyík
상속: extends Grido\Components\Container
파일 보기 프로젝트 열기: o5/grido 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$filter array @persistent
$onFetchData event for modifying data
$onRegistered event on all grid's components registered
$onRender event on render
$page integer @persistent
$perPage integer @persistent
$sort array @persistent

보호된 프로퍼티들

프로퍼티 타입 설명
$count total count of items
$customization grido\Customization
$data mixed
$defaultFilter array
$defaultPerPage integer
$defaultSort array
$filterRenderType string
$model Grido\DataSources\IDataSource
$options array
$paginator Grido\Components\Paginator
$perPageList array
$primaryKey string
$propertyAccessor Symfony\Component\PropertyAccess\PropertyAccessor
$rememberState boolean
$rememberStateSectionName string
$rowCallback returns tr html element; function($row, Html $tr)
$strictMode boolean
$tablePrototype Nette\Utils\Html
$translator Nette\Localization\ITranslator

공개 메소드들

메소드 설명
__getConditions ( array $filter ) : array
__triggerUserNotice ( string $message )
createTemplate ( ) : Nette\Templating\FileTemplate
getActualFilter ( string $key = NULL ) : mixed Returns actual filter values.
getClientSideOptions ( ) : array Returns client-side options.
getCount ( ) : integer Returns total count of data.
getCustomization ( ) : grido\Customization
getData ( boolean $applyPaging = TRUE, boolean $useCache = TRUE, boolean $fetch = TRUE ) : array | Grido\DataSources\IDataSource | Selection Returns fetched data.
getDefaultFilter ( ) : array Returns default filter.
getDefaultPerPage ( ) : integer Returns default per page.
getDefaultSort ( ) : array Returns default sort.
getFilterRenderType ( ) : string
getModel ( ) : Grido\DataSources\IDataSource
getPaginator ( ) : Grido\Components\Paginator
getPerPage ( ) : integer Returns items per page.
getPerPageList ( ) : array Returns list of possible items per page.
getPrimaryKey ( ) : string Returns primary key.
getProperty ( array | object $object, string $name ) : mixed A simple wrapper around symfony/property-access with Nette Database dot notation support.
getPropertyAccessor ( ) : PropertyAccessor
getRememberSession ( boolean $forceStart = FALSE ) : SessionSection | null Returns remember session for set expiration, etc.
getRememberState ( ) : boolean Returns remember state.
getRowCallback ( ) : callback Returns row callback.
getRowPrototype ( mixed $row ) : Nette\Utils\Html
getTablePrototype ( ) : Nette\Utils\Html Returns table html element of grid.
getTranslator ( ) : Grido\Translations\FileTranslator Returns translator.
handleFilter ( Nette\Forms\Controls\SubmitButton $button )
handlePage ( integer $page )
handlePerPage ( Nette\Forms\Controls\SubmitButton $button )
handleRefresh ( ) Ajax method.
handleReset ( Nette\Forms\Controls\SubmitButton $button )
handleSort ( array $sort )
isStrictMode ( ) : boolean
loadState ( array $params ) Loads state informations.
reload ( ) : void Refresh wrapper.
render ( )
saveState ( array &$params, Nette\Application\UI\PresenterComponentReflection $reflection = NULL ) Saves state informations for next request.
setClientSideOptions ( array $options ) : Grid Sets client-side options.
setCustomization ( grido\Customization $customization )
setDefaultFilter ( array $filter ) : Grid Sets default filtering.
setDefaultPerPage ( integer $perPage ) : Grid Sets the default number of items per page.
setDefaultSort ( array $sort ) : Grid Sets default sorting.
setFilterRenderType ( string $type ) : Grid Sets type of filter rendering.
setModel ( mixed $model, boolean $forceWrapper = FALSE ) : Grid Sets a model that implements the interface Grido\DataSources\IDataSource or data-source object.
setPaginator ( Grido\Components\Paginator $paginator ) : Grid Sets custom paginator.
setPerPageList ( array $perPageList ) : Grid Sets items to per-page select.
setPrimaryKey ( string $key ) : Grid Sets grid primary key.
setRememberState ( boolean $state = TRUE, string $sectionName = NULL ) : Grid Sets saving state to session.
setRowCallback ( $callback ) : Grid Sets callback for customizing tr html object.
setStrictMode ( boolean $mode ) : Grid Determines whether any user error will cause a notice.
setTemplateFile ( string $file ) : Grid Sets file name of custom template.
setTranslator ( Nette\Localization\ITranslator $translator ) : Grid Sets translator.

보호된 메소드들

메소드 설명
applyFiltering ( )
applyPaging ( )
applySorting ( )
createComponentForm ( $name )
getItemsForCountSelect ( ) : array
saveRememberState ( )

메소드 상세

__getConditions() 공개 메소드

public __getConditions ( array $filter ) : array
$filter array
리턴 array

__triggerUserNotice() 공개 메소드

public __triggerUserNotice ( string $message )
$message string

applyFiltering() 보호된 메소드

protected applyFiltering ( )

applyPaging() 보호된 메소드

protected applyPaging ( )

applySorting() 보호된 메소드

protected applySorting ( )

createComponentForm() 보호된 메소드

protected createComponentForm ( $name )

createTemplate() 공개 메소드

public createTemplate ( ) : Nette\Templating\FileTemplate
리턴 Nette\Templating\FileTemplate

getActualFilter() 공개 메소드

Returns actual filter values.
public getActualFilter ( string $key = NULL ) : mixed
$key string
리턴 mixed

getClientSideOptions() 공개 메소드

Returns client-side options.
public getClientSideOptions ( ) : array
리턴 array

getCount() 공개 메소드

Returns total count of data.
public getCount ( ) : integer
리턴 integer

getCustomization() 공개 메소드

public getCustomization ( ) : grido\Customization
리턴 grido\Customization

getData() 공개 메소드

Returns fetched data.
public getData ( boolean $applyPaging = TRUE, boolean $useCache = TRUE, boolean $fetch = TRUE ) : array | Grido\DataSources\IDataSource | Selection
$applyPaging boolean
$useCache boolean
$fetch boolean
리턴 array | Grido\DataSources\IDataSource | Nette\Database\Table\Selection

getDefaultFilter() 공개 메소드

Returns default filter.
public getDefaultFilter ( ) : array
리턴 array

getDefaultPerPage() 공개 메소드

Returns default per page.
public getDefaultPerPage ( ) : integer
리턴 integer

getDefaultSort() 공개 메소드

Returns default sort.
public getDefaultSort ( ) : array
리턴 array

getFilterRenderType() 공개 메소드

public getFilterRenderType ( ) : string
리턴 string

getItemsForCountSelect() 보호된 메소드

protected getItemsForCountSelect ( ) : array
리턴 array

getModel() 공개 메소드

public getModel ( ) : Grido\DataSources\IDataSource
리턴 Grido\DataSources\IDataSource

getPaginator() 공개 메소드

public getPaginator ( ) : Grido\Components\Paginator
리턴 Grido\Components\Paginator

getPerPage() 공개 메소드

Returns items per page.
public getPerPage ( ) : integer
리턴 integer

getPerPageList() 공개 메소드

Returns list of possible items per page.
public getPerPageList ( ) : array
리턴 array

getPrimaryKey() 공개 메소드

Returns primary key.
public getPrimaryKey ( ) : string
리턴 string

getProperty() 공개 메소드

A simple wrapper around symfony/property-access with Nette Database dot notation support.
public getProperty ( array | object $object, string $name ) : mixed
$object array | object
$name string
리턴 mixed

getPropertyAccessor() 공개 메소드

public getPropertyAccessor ( ) : PropertyAccessor
리턴 Symfony\Component\PropertyAccess\PropertyAccessor

getRememberSession() 공개 메소드

Returns remember session for set expiration, etc.
public getRememberSession ( boolean $forceStart = FALSE ) : SessionSection | null
$forceStart boolean - if TRUE, session will be started if not
리턴 Nette\Http\SessionSection | null

getRememberState() 공개 메소드

Returns remember state.
public getRememberState ( ) : boolean
리턴 boolean

getRowCallback() 공개 메소드

Returns row callback.
public getRowCallback ( ) : callback
리턴 callback

getRowPrototype() 공개 메소드

public getRowPrototype ( mixed $row ) : Nette\Utils\Html
$row mixed item from db
리턴 Nette\Utils\Html

getTablePrototype() 공개 메소드

Returns table html element of grid.
public getTablePrototype ( ) : Nette\Utils\Html
리턴 Nette\Utils\Html

getTranslator() 공개 메소드

Returns translator.
public getTranslator ( ) : Grido\Translations\FileTranslator
리턴 Grido\Translations\FileTranslator

handleFilter() 공개 메소드

public handleFilter ( Nette\Forms\Controls\SubmitButton $button )
$button Nette\Forms\Controls\SubmitButton

handlePage() 공개 메소드

public handlePage ( integer $page )
$page integer

handlePerPage() 공개 메소드

public handlePerPage ( Nette\Forms\Controls\SubmitButton $button )
$button Nette\Forms\Controls\SubmitButton

handleRefresh() 공개 메소드

Ajax method.
public handleRefresh ( )

handleReset() 공개 메소드

public handleReset ( Nette\Forms\Controls\SubmitButton $button )
$button Nette\Forms\Controls\SubmitButton

handleSort() 공개 메소드

public handleSort ( array $sort )
$sort array

isStrictMode() 공개 메소드

public isStrictMode ( ) : boolean
리턴 boolean

loadState() 공개 메소드

Loads state informations.
public loadState ( array $params )
$params array

reload() 공개 메소드

Refresh wrapper.
public reload ( ) : void
리턴 void

render() 공개 메소드

public render ( )

saveRememberState() 보호된 메소드

protected saveRememberState ( )

saveState() 공개 메소드

Saves state informations for next request.
public saveState ( array &$params, Nette\Application\UI\PresenterComponentReflection $reflection = NULL )
$params array
$reflection Nette\Application\UI\PresenterComponentReflection (internal, used by Presenter)

setClientSideOptions() 공개 메소드

Sets client-side options.
public setClientSideOptions ( array $options ) : Grid
$options array
리턴 Grid

setCustomization() 공개 메소드

public setCustomization ( grido\Customization $customization )
$customization grido\Customization

setDefaultFilter() 공개 메소드

Sets default filtering.
public setDefaultFilter ( array $filter ) : Grid
$filter array
리턴 Grid

setDefaultPerPage() 공개 메소드

Sets the default number of items per page.
public setDefaultPerPage ( integer $perPage ) : Grid
$perPage integer
리턴 Grid

setDefaultSort() 공개 메소드

Sets default sorting.
public setDefaultSort ( array $sort ) : Grid
$sort array
리턴 Grid

setFilterRenderType() 공개 메소드

Defaults inner (Filter::RENDER_INNER) if column does not exist then outer filter (Filter::RENDER_OUTER).
public setFilterRenderType ( string $type ) : Grid
$type string
리턴 Grid

setModel() 공개 메소드

Sets a model that implements the interface Grido\DataSources\IDataSource or data-source object.
public setModel ( mixed $model, boolean $forceWrapper = FALSE ) : Grid
$model mixed
$forceWrapper boolean
리턴 Grid

setPaginator() 공개 메소드

Sets custom paginator.
public setPaginator ( Grido\Components\Paginator $paginator ) : Grid
$paginator Grido\Components\Paginator
리턴 Grid

setPerPageList() 공개 메소드

Sets items to per-page select.
public setPerPageList ( array $perPageList ) : Grid
$perPageList array
리턴 Grid

setPrimaryKey() 공개 메소드

Defaults is "id".
public setPrimaryKey ( string $key ) : Grid
$key string
리턴 Grid

setRememberState() 공개 메소드

Sets saving state to session.
public setRememberState ( boolean $state = TRUE, string $sectionName = NULL ) : Grid
$state boolean
$sectionName string
리턴 Grid

setRowCallback() 공개 메소드

Callback returns tr html element; function($row, Html $tr).
public setRowCallback ( $callback ) : Grid
$callback
리턴 Grid

setStrictMode() 공개 메소드

Determines whether any user error will cause a notice.
public setStrictMode ( boolean $mode ) : Grid
$mode boolean
리턴 Grid

setTemplateFile() 공개 메소드

Sets file name of custom template.
public setTemplateFile ( string $file ) : Grid
$file string
리턴 Grid

setTranslator() 공개 메소드

Sets translator.
public setTranslator ( Nette\Localization\ITranslator $translator ) : Grid
$translator Nette\Localization\ITranslator
리턴 Grid

프로퍼티 상세

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

total count of items
protected $count

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

protected Customization,grido $customization
리턴 grido\Customization

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

protected mixed $data
리턴 mixed

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

protected array $defaultFilter
리턴 array

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

protected int $defaultPerPage
리턴 integer

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

protected array $defaultSort
리턴 array

$filter 공개적으로 프로퍼티

@persistent
public array $filter
리턴 array

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

protected string $filterRenderType
리턴 string

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

protected IDataSource,Grido\DataSources $model
리턴 Grido\DataSources\IDataSource

$onFetchData 공개적으로 프로퍼티

event for modifying data
public $onFetchData

$onRegistered 공개적으로 프로퍼티

event on all grid's components registered
public $onRegistered

$onRender 공개적으로 프로퍼티

event on render
public $onRender

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

protected array $options
리턴 array

$page 공개적으로 프로퍼티

@persistent
public int $page
리턴 integer

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

protected Paginator,Grido\Components $paginator
리턴 Grido\Components\Paginator

$perPage 공개적으로 프로퍼티

@persistent
public int $perPage
리턴 integer

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

protected array $perPageList
리턴 array

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

protected string $primaryKey
리턴 string

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

protected PropertyAccessor,Symfony\Component\PropertyAccess $propertyAccessor
리턴 Symfony\Component\PropertyAccess\PropertyAccessor

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

protected bool $rememberState
리턴 boolean

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

protected string $rememberStateSectionName
리턴 string

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

returns tr html element; function($row, Html $tr)
protected $rowCallback

$sort 공개적으로 프로퍼티

@persistent
public array $sort
리턴 array

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

protected bool $strictMode
리턴 boolean

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

protected Html,Nette\Utils $tablePrototype
리턴 Nette\Utils\Html

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

protected ITranslator,Nette\Localization $translator
리턴 Nette\Localization\ITranslator