RequestOptions
in package
FinalYes
Table of Contents
Properties
- $fields : FilteredRequest|null
- $pagination : PaginatedRequest|null
Methods
- __construct() : mixed
- RequestOptions constructor.
- build() : array<string|int, int|string>
- Return an array representing the field-filtered request.
- getFields() : FilteredRequest|null
- Retrieve a FilteredRequest object, defining field filtering conditions for the API response.
- getPagination() : PaginatedRequest|null
- Retrieve a PaginatedRequest object, defining paginated conditions for the API response.
- setFields() : self
- Assign a PaginatedRequest object, defining field filtering conditions for the API response.
- setPagination() : self
- Assign a PaginatedRequest object, defining paginated conditions for the API response.
Properties
$fields
private
FilteredRequest|null
$fields
= null
$pagination
private
PaginatedRequest|null
$pagination
= null
Methods
__construct()
RequestOptions constructor.
public
__construct([null|FilteredRequest $fields = null ][, null|PaginatedRequest $pagination = null ]) : mixed
Parameters
- $fields : null|FilteredRequest = null
-
an instance of FilteredRequest, for managing field-filtered requests
- $pagination : null|PaginatedRequest = null
-
an instance of PaginatedRequest, for managing paginated requests
build()
Return an array representing the field-filtered request.
public
build() : array<string|int, int|string>
Return values
array<string|int, int|string>getFields()
Retrieve a FilteredRequest object, defining field filtering conditions for the API response.
public
getFields() : FilteredRequest|null
Return values
FilteredRequest|nullgetPagination()
Retrieve a PaginatedRequest object, defining paginated conditions for the API response.
public
getPagination() : PaginatedRequest|null
Return values
PaginatedRequest|nullsetFields()
Assign a PaginatedRequest object, defining field filtering conditions for the API response.
public
setFields(null|FilteredRequest $fields) : self
Parameters
- $fields : null|FilteredRequest
-
request fields be included or excluded from the API response using a FilteredRequest object
Return values
selfsetPagination()
Assign a PaginatedRequest object, defining paginated conditions for the API response.
public
setPagination(null|PaginatedRequest $pagination) : self
Parameters
- $pagination : null|PaginatedRequest
-
request paged results using a PaginatedRequest object