PHP 클래스 OpenSkill\Datatable\Providers\CollectionProvider

상속: implements OpenSkill\Datatable\Providers\Provider

파일 보기 프로젝트 열기: openskill/datatable 1 사용 예제들

공개 메소드들

메소드	설명
__construct ( Collection $collection )	CollectionProvider constructor.
order ( callable $orderFunction )	Will accept a global search function for all columns.
prepareForProcessing ( OpenSkill\Datatable\Queries\QueryConfiguration $queryConfiguration, array $columnConfiguration ) : mixed	Here the DTQueryConfiguration is passed to prepare the provider for the processing of the request.
process ( ) : ResponseData	This method should process all configurations and prepare the underlying data for the view. It will arrange the data and provide the results in a DTData object.
search ( callable $searchFunction )	Will accept a global search function for all columns.
searchColumn ( string $columnName, callable $searchFunction )	Will accept a search function that should be called for the column with the given name.
setupOrder ( )
setupSearch ( )

비공개 메소드들

메소드	설명
compileCollection ( array $columnConfiguration )	Will compile the collection into the final collection where operations like search and order can be applied.
removeEmptyRowsFromCollection ( )	Remove the empty rows from the collection
sortCollection ( )	Will sort the internal collection based on the given query configuration.
transformCollectionData ( OpenSkill\Datatable\Columns\ColumnConfiguration[] $columnConfiguration, $searchFunc )	Transform collection data. Used for searches.

메소드 상세

__construct() 공개 메소드

CollectionProvider constructor.

public __construct ( Collection $collection )
$collection	Illuminate\Support\Collection	The collection with the initial data

order() 공개 메소드

Will accept a global search function for all columns.

public order ( callable $orderFunction )
$orderFunction	callable	the order function to determine the order of the table

prepareForProcessing() 공개 메소드

This will only be called when the DTProvider needs to handle the request. It will never be called when the DTProvider does not need to handle the request.

public prepareForProcessing ( OpenSkill\Datatable\Queries\QueryConfiguration $queryConfiguration, array $columnConfiguration ) : mixed
$queryConfiguration	OpenSkill\Datatable\Queries\QueryConfiguration
$columnConfiguration	array
리턴	mixed

process() 공개 메소드

It will be called after {@link #prepareForProcessing} has been called and needs to return the processed data in a DTData object so the Composer can further handle the data.

public process ( ) : ResponseData
리턴	OpenSkill\Datatable\Data\ResponseData	The processed data

search() 공개 메소드

Will accept a global search function for all columns.

public search ( callable $searchFunction )
$searchFunction	callable	the search function to determine if a row should be included

searchColumn() 공개 메소드

If the function returns true, it will be accepted as search matching

public searchColumn ( string $columnName, callable $searchFunction )
$columnName	string	the name of the column to pass this function to
$searchFunction	callable	the function for the searching

setupOrder() 공개 메소드

public setupOrder ( )

setupSearch() 공개 메소드

public setupSearch ( )