Auth0-PHP

FilteredRequest
in package

Class FilteredRequest.

Table of Contents

$fields  : array<string|int, mixed>|null
$includeFields  : bool|null
__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()  : array<string|int, string>|null
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

Methods

__construct()

FilteredRequest constructor.

public __construct([array<string|int, string>|null $fields = null ][, bool|null $includeFields = null ]) : mixed
Parameters
$fields : array<string|int, string>|null = null

fields to include or exclude from API responses

$includeFields : bool|null = null

true to include $fields, false to exclude $fields

Return values
mixed —

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
self —

getFields()

Retrieve the `fields` for the filtered request.

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

getIncludeFields()

Retrieve the `include_fields` for the filtered request.

public getIncludeFields() : bool|null
Return values
bool|null —

setFields()

Set the `fields` for the filtered request.

public setFields(array<string|int, string> $fields) : self
Parameters
$fields : array<string|int, string>

value of fields parameter for the filtered request

Return values
self —

setIncludeFields()

Set the `include_fields` for the paginated request.

public setIncludeFields(bool|null $includeFields) : self
Parameters
$includeFields : bool|null

value of include_fields parameter for the filtered request

Return values
self —

Search results