FilteredRequest
in package
FinalYes
Table of Contents
Properties
- $fields : array<string|int, mixed>|null
- $includeFields : bool|null
Methods
- __construct() : mixed
- FilteredRequest constructor.
- build() : array<string|int, int|string>
- Return an array representing the field-filtered request.
- clearFields() : self
- Clear the `fields` for the filtered request.
- getFields() : null|array<string|int, string>
- Retrieve the `fields` for the filtered request.
- getIncludeFields() : bool|null
- Retrieve the `include_fields` for the filtered request.
- setFields() : self
- Set the `fields` for the filtered request.
- setIncludeFields() : self
- Set the `include_fields` for the paginated request.
Properties
$fields
private
array<string|int, mixed>|null
$fields
= null
$includeFields
private
bool|null
$includeFields
= null
Methods
__construct()
FilteredRequest constructor.
public
__construct([null|array<string|int, string> $fields = null ][, null|bool $includeFields = null ]) : mixed
Parameters
- $fields : null|array<string|int, string> = null
-
fields to include or exclude from API responses
- $includeFields : null|bool = null
-
true to include $fields, false to exclude $fields
build()
Return an array representing the field-filtered request.
public
build() : array<string|int, int|string>
Return values
array<string|int, int|string>clearFields()
Clear the `fields` for the filtered request.
public
clearFields() : self
Return values
selfgetFields()
Retrieve the `fields` for the filtered request.
public
getFields() : null|array<string|int, string>
Return values
null|array<string|int, string>getIncludeFields()
Retrieve the `include_fields` for the filtered request.
public
getIncludeFields() : bool|null
Return values
bool|nullsetFields()
Set the `fields` for the filtered request.
public
setFields(array<string|int, string> $fields) : self
Parameters
- $fields : array<string|int, string>
-
value of
fieldsparameter for the filtered request
Return values
selfsetIncludeFields()
Set the `include_fields` for the paginated request.
public
setIncludeFields(bool|null $includeFields) : self
Parameters
- $includeFields : bool|null
-
value of
include_fieldsparameter for the filtered request