BaseSearchParameters
in package
AbstractYes
Base parameters for searches.
Tags
Table of Contents
Properties
- $page : int|null
- $perPage : int|null
- $slug : string
- $responseClass : TSearchResponse>
Methods
- __construct() : mixed
- getRequestParameters() : array<string, string>
- Gets the request parameters for the search request.
- getResponseClass() : TSearchResponse>
- Gets the response class associated with the parameters.
Properties
$page
public
int|null
$page
= null
$perPage
public
int|null
$perPage
= null
$slug
public
static string
$slug
Slug of the resource.
$responseClass
protected
static TSearchResponse>
$responseClass
Response class.
Methods
__construct()
public
__construct([int|null $page = null ][, int|null $perPage = null ]) : mixed
Parameters
- $page : int|null = null
-
1-based page index.
- $perPage : int|null = null
-
Number of items per page.
getRequestParameters()
Gets the request parameters for the search request.
public
getRequestParameters() : array<string, string>
Return values
array<string, string> —Query parameters.
getResponseClass()
Gets the response class associated with the parameters.
public
getResponseClass() : TSearchResponse>
Return values
TSearchResponse> —Response class.