Documentation

SearchDto
in package

FinalYes
Tags
author

Javier Eguiluz javier.eguiluz@gmail.com

Table of Contents

Properties

$appliedFilters  : array<string|int, string>|null
$customSort  : array<string|int, mixed>
$defaultSort  : array<string|int, mixed>
$query  : string
$request  : Request
$searchableProperties  : array<string|int, string>|null

Methods

__construct()  : mixed
getAppliedFilters()  : array<string|int, mixed>|null
getQuery()  : string
getRequest()  : Request
getSearchableProperties()  : array<string|int, string>|null
getSort()  : array<string|int, mixed>
getSortDirection()  : string
isSortingField()  : bool

Properties

$appliedFilters

private array<string|int, string>|null $appliedFilters

$customSort

private array<string|int, mixed> $customSort

$defaultSort

private array<string|int, mixed> $defaultSort

$searchableProperties

private array<string|int, string>|null $searchableProperties

Methods

__construct()

public __construct(Request $request, array<string|int, mixed>|null $searchableProperties, string|null $query, array<string|int, mixed> $defaultSort, array<string|int, mixed> $customSort, array<string|int, mixed>|null $appliedFilters) : mixed
Parameters
$request : Request
$searchableProperties : array<string|int, mixed>|null
$query : string|null
$defaultSort : array<string|int, mixed>
$customSort : array<string|int, mixed>
$appliedFilters : array<string|int, mixed>|null

getAppliedFilters()

public getAppliedFilters() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getQuery()

public getQuery() : string
Return values
string

getSearchableProperties()

public getSearchableProperties() : array<string|int, string>|null
Return values
array<string|int, string>|null

getSort()

public getSort() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSortDirection()

public getSortDirection(string $fieldProperty) : string
Parameters
$fieldProperty : string
Return values
string

isSortingField()

public isSortingField(string $fieldProperty) : bool
Parameters
$fieldProperty : string
Return values
bool

        
On this page

Search results