RequestUtil  

class RequestUtil

Constants

INTERNAL_ATTRIBUTE

Attribute key marking a request as an internal API call (dispatched via {\Flarum\Api\Client}, e.g. when a frontend page preloads its API document) rather than a request from an external client.

Methods

static bool
isApiRequest(ServerRequestInterface $request)

Determine if the request is an API request. We do not manually set the `Accepts` header for API requests, so we need to check the priority list to determine whether it is or not.

static bool
isHtmlRequest(ServerRequestInterface $request)

No description

static ServerRequestInterface
withInternal(ServerRequestInterface $request)

No description

static bool
isInternal(ServerRequestInterface $request)

Whether this request was dispatched internally. Internal requests are not held to the JSON:API spec's strict query-parameter validation: a frontend page forwards the browser's query string (which may carry tracking params like `fbclid`) into the API client, and those must not 400 the page.

static string
getPreferredContentType(ServerRequestInterface $request, array $types)

Determine the client's preferred content type out of the given list.

static User
getActor(ServerRequestInterface $request)

No description

static ServerRequestInterface
withActor(ServerRequestInterface $request, User $actor)

No description

static array|null
extractSort(ServerRequestInterface $request, string|null $default, array $available = [])

No description

static int|null
extractLimit(ServerRequestInterface $request, int|null $defaultLimit = null, int|null $max = null)

No description

static int
extractOffsetFromNumber(ServerRequestInterface $request, int $limit)

No description

static int
extractOffset(ServerRequestInterface $request, int|null $limit = 0)

No description

static array
extractInclude(ServerRequestInterface $request, array|null $available)

No description

static array
extractFilter(ServerRequestInterface $request)

No description

static array
extractFields(ServerRequestInterface $request, array|null $available = null)

No description

Details

at line 24
static bool isApiRequest(ServerRequestInterface $request)

Determine if the request is an API request. We do not manually set the `Accepts` header for API requests, so we need to check the priority list to determine whether it is or not.

Normal browsing requests will have `text/html` as their preferred content type, while API will have `* / *`.

Parameters

ServerRequestInterface $request

Return Value

bool

at line 34
static bool isHtmlRequest(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

bool

at line 46
static ServerRequestInterface withInternal(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

ServerRequestInterface

at line 57
static bool isInternal(ServerRequestInterface $request)

Whether this request was dispatched internally. Internal requests are not held to the JSON:API spec's strict query-parameter validation: a frontend page forwards the browser's query string (which may carry tracking params like `fbclid`) into the API client, and those must not 400 the page.

Parameters

ServerRequestInterface $request

Return Value

bool

at line 69
static string getPreferredContentType(ServerRequestInterface $request, array $types)

Determine the client's preferred content type out of the given list.

Parameters

ServerRequestInterface $request
array $types The content types to check against, in order of priority. The best match will be returned.

Return Value

string The best matching type, or an empty string if none could be determined.

at line 91
static User getActor(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

User

at line 96
static ServerRequestInterface withActor(ServerRequestInterface $request, User $actor)

Parameters

ServerRequestInterface $request
User $actor

Return Value

ServerRequestInterface

at line 110
static array|null extractSort(ServerRequestInterface $request, string|null $default, array $available = [])

Parameters

ServerRequestInterface $request
string|null $default
array $available

Return Value

array|null

at line 150
static int|null extractLimit(ServerRequestInterface $request, int|null $defaultLimit = null, int|null $max = null)

Parameters

ServerRequestInterface $request
int|null $defaultLimit
int|null $max

Return Value

int|null

at line 173
static int extractOffsetFromNumber(ServerRequestInterface $request, int $limit)

Parameters

ServerRequestInterface $request
int $limit

Return Value

int

at line 184
static int extractOffset(ServerRequestInterface $request, int|null $limit = 0)

Parameters

ServerRequestInterface $request
int|null $limit

Return Value

int

at line 199
static array extractInclude(ServerRequestInterface $request, array|null $available)

Parameters

ServerRequestInterface $request
array|null $available

Return Value

array

at line 218
static array extractFilter(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array

at line 229
static array extractFields(ServerRequestInterface $request, array|null $available = null)

Parameters

ServerRequestInterface $request
array|null $available

Return Value

array