PHP 클래스 Msieprawski\ResourceTable\Generators\Collection

파일 보기 프로젝트 열기: msieprawski/resource-table 1 사용 예제들

공개 메소드들

메소드 설명
__construct ( Builder $builder ) Sets builder object
addColumn ( array $data ) Adds column to resource table
customView ( string $name ) Sets custom view name for further rendering
filter ( boolean $enabled ) Sets true if filter should be rendered
getSort ( ) : array Returns $_sort variable
make ( ) : string Returns HTML with resource table
page ( integer $page ) Sets $_page variable
paginate ( boolean $paginate ) Sets $_paginate variable
perPage ( integer $perPage ) Sets $_perPage variable
renderFilterForm ( ) : boolean Checks if filter form should be generated
rendererNamespace ( ) : string Returns renderer default namespace
resetFormUrl ( ) : string Returns URL to reset search form
setExtraViewData ( array $data ) Sets extra (custom) view data
setPaginationPresenter ( string $presenter ) Sets $_paginationPresenter object name
setRendererNamespace ( string $namespace ) Set renderer default namespace to prevent long class names
sort ( string $index, string $direction ) Sets sort configuration
view ( string $name ) Sets package view name for further rendering

비공개 메소드들

메소드 설명
_addQueryCondition ( Builder $builder, string $type, string $columnName, string $operator, string $value ) : Builder Adds condition to the query builder
_getCountForPagination ( Builder $builder ) : integer Returns total results for given query
_getPaginatorPresenter ( array $items ) : mixed Returns Paginator Presenter object if pagination is enabled
_prepareBuilder ( ) Prepares builder object before calling get method on it
_prepareFilterValue ( array $column, mixed $value ) : mixed Basing on column configuration prepares given field value If column configuration has filter function - use it to prepare value
_setView ( string $name, boolean $custom = false ) Sets view name for further rendering
_validSort ( array $params ) : boolean Checks if provided order configuration (from GET) is valid
_validateColumn ( array $data ) : boolean | string Checks if provided column data is valid Returns bool if it's valid Returns string it it's not valid

메소드 상세

__construct() 공개 메소드

Sets builder object
public __construct ( Builder $builder )
$builder Illuminate\Database\Query\Builder

addColumn() 공개 메소드

Adds column to resource table
public addColumn ( array $data )
$data array

customView() 공개 메소드

Sets custom view name for further rendering
public customView ( string $name )
$name string

filter() 공개 메소드

Sets true if filter should be rendered
public filter ( boolean $enabled )
$enabled boolean

getSort() 공개 메소드

Returns $_sort variable
public getSort ( ) : array
리턴 array

make() 공개 메소드

Returns HTML with resource table
public make ( ) : string
리턴 string

page() 공개 메소드

Sets $_page variable
public page ( integer $page )
$page integer

paginate() 공개 메소드

Sets $_paginate variable
public paginate ( boolean $paginate )
$paginate boolean

perPage() 공개 메소드

Sets $_perPage variable
public perPage ( integer $perPage )
$perPage integer

renderFilterForm() 공개 메소드

Checks if filter form should be generated
public renderFilterForm ( ) : boolean
리턴 boolean

rendererNamespace() 공개 메소드

Returns renderer default namespace
public rendererNamespace ( ) : string
리턴 string

resetFormUrl() 공개 메소드

Returns URL to reset search form
public resetFormUrl ( ) : string
리턴 string

setExtraViewData() 공개 메소드

Sets extra (custom) view data
public setExtraViewData ( array $data )
$data array

setPaginationPresenter() 공개 메소드

Sets $_paginationPresenter object name
public setPaginationPresenter ( string $presenter )
$presenter string

setRendererNamespace() 공개 메소드

Set renderer default namespace to prevent long class names
public setRendererNamespace ( string $namespace )
$namespace string

sort() 공개 메소드

Sets sort configuration
public sort ( string $index, string $direction )
$index string
$direction string

view() 공개 메소드

Sets package view name for further rendering
public view ( string $name )
$name string