\Osiset\BasicShopifyAPI\MiddlewareRateLimiting

Handle basic request rate limiting for REST and GraphQL.

Summary

Methods

Properties

Constants

__construct()
__invoke()

No public properties found

No constants found

isGraphRequest()
isRestRequest()
handleRest()
handleGraph()

$api

N/A

No private methods found

No private properties found

N/A

File: Middleware/RateLimiting.php
Package: Default
Class hierarchy: \Osiset\BasicShopifyAPI\Middleware\AbstractMiddleware

\Osiset\BasicShopifyAPI\Middleware\RateLimiting
Uses traits: \Osiset\BasicShopifyAPI\Traits\IsRequestType

Properties

$api

$api : \Osiset\BasicShopifyAPI\BasicShopifyAPI

The API instance.

Type

\Osiset\BasicShopifyAPI\BasicShopifyAPI

Methods

__construct()

__construct(\Osiset\BasicShopifyAPI\BasicShopifyAPI  $api) : self

Setup.

Parameters

\Osiset\BasicShopifyAPI\BasicShopifyAPI

$api

The API instance.

Returns

self

__invoke()

__invoke(callable  $handler) : callable

Run.

Parameters

callable

$handler

Returns

callable

isGraphRequest()

isGraphRequest(string  $uri) : boolean

Determines if the request is to Graph API.

Parameters

string

$uri

The request URI.

Returns

boolean

isRestRequest()

isRestRequest(string  $uri) : boolean

Determines if the request is to REST API.

Parameters

string

$uri

The request URI.

Returns

boolean

handleRest()

handleRest(\Osiset\BasicShopifyAPI\BasicShopifyAPI  $api) : boolean

Handle REST checks.

Parameters

\Osiset\BasicShopifyAPI\BasicShopifyAPI

$api

Returns

boolean

handleGraph()

handleGraph(\Osiset\BasicShopifyAPI\BasicShopifyAPI  $api) : boolean

Handle GraphQL checks.

Parameters

\Osiset\BasicShopifyAPI\BasicShopifyAPI

$api

Returns

boolean