PHP Trait EloquentFilter\Filterable

Afficher le fichier Open project: tucker-eric/eloquentfilter

Protected Properties

Свойство Type Description
$filter
$filtered array Array of input used to filter the query.

Méthodes publiques

Méthode Description
getModelFilterClass ( ) : ModelFilter Returns the ModelFilter for the current model.
provideFilter ( null | string $filter = null ) : ModelFilter Returns ModelFilter class to be instantiated.
scopeFilter ( $query, array $input = [], null | string | ModelFilter $filter = null ) : Builder Creates local scope to run the filter.
scopePaginateFilter ( $query, integer $perPage = null, array $columns = ['*'], string $pageName = 'page', integer | null $page = null ) : Illuminate\Contracts\Pagination\LengthAwarePaginator Paginate the given query with url query params appended.
scopeSimplePaginateFilter ( $query, integer $perPage = null, array $columns = ['*'], string $pageName = 'page' ) : Illuminate\Contracts\Pagination\LengthAwarePaginator Paginate the given query with url query params appended.
scopeWhereBeginsWith ( $query, $column, $value, string $boolean = 'and' ) : mixed WHERE $column LIKE $value% query.
scopeWhereEndsWith ( $query, $column, $value, string $boolean = 'and' ) : mixed WHERE $column LIKE %$value query.
scopeWhereLike ( $query, $column, $value, string $boolean = 'and' ) : mixed WHERE $column LIKE %$value% query.

Method Details

getModelFilterClass() public méthode

Returns the ModelFilter for the current model.
public getModelFilterClass ( ) : ModelFilter
Résultat ModelFilter

provideFilter() public méthode

Returns ModelFilter class to be instantiated.
public provideFilter ( null | string $filter = null ) : ModelFilter
$filter null | string
Résultat ModelFilter

scopeFilter() public méthode

Creates local scope to run the filter.
public scopeFilter ( $query, array $input = [], null | string | ModelFilter $filter = null ) : Builder
$query
$input array
$filter null | string | ModelFilter
Résultat Illuminate\Database\Eloquent\Builder

scopePaginateFilter() public méthode

Paginate the given query with url query params appended.
public scopePaginateFilter ( $query, integer $perPage = null, array $columns = ['*'], string $pageName = 'page', integer | null $page = null ) : Illuminate\Contracts\Pagination\LengthAwarePaginator
$perPage integer
$columns array
$pageName string
$page integer | null
Résultat Illuminate\Contracts\Pagination\LengthAwarePaginator

scopeSimplePaginateFilter() public méthode

Paginate the given query with url query params appended.
public scopeSimplePaginateFilter ( $query, integer $perPage = null, array $columns = ['*'], string $pageName = 'page' ) : Illuminate\Contracts\Pagination\LengthAwarePaginator
$perPage integer
$columns array
$pageName string
Résultat Illuminate\Contracts\Pagination\LengthAwarePaginator

scopeWhereBeginsWith() public méthode

WHERE $column LIKE $value% query.
public scopeWhereBeginsWith ( $query, $column, $value, string $boolean = 'and' ) : mixed
$query
$column
$value
$boolean string
Résultat mixed

scopeWhereEndsWith() public méthode

WHERE $column LIKE %$value query.
public scopeWhereEndsWith ( $query, $column, $value, string $boolean = 'and' ) : mixed
$query
$column
$value
$boolean string
Résultat mixed

scopeWhereLike() public méthode

WHERE $column LIKE %$value% query.
public scopeWhereLike ( $query, $column, $value, string $boolean = 'and' ) : mixed
$query
$column
$value
$boolean string
Résultat mixed

Property Details

$filter protected_oe property

protected $filter

$filtered protected_oe property

Array of input used to filter the query.
protected array $filtered
Résultat array