SitesApi
extends ResourceApi
in package
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Tags
Table of Contents
- __construct() : mixed
- create() : ResponseInterface
- delete() : ResponseInterface
- get() : SiteResponse
- getAll() : SitesResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- route() : SiteRoutesApi
- routes() : SiteRoutesApi
- singleResourceUrl() : string
- update() : ResponseInterface
Methods
__construct()
public
__construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : Client
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Tags
Return values
mixed —create()
public
create(Site $site) : ResponseInterface
Parameters
- $site : Site
Tags
Return values
ResponseInterface —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : SiteResponse
Tags
Return values
SiteResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : SitesResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
SitesResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —route()
public
route(int $id) : SiteRoutesApi
Parameters
- $id : int
Tags
Return values
SiteRoutesApi —routes()
public
routes() : SiteRoutesApi
Tags
Return values
SiteRoutesApi —singleResourceUrl()
public
abstract singleResourceUrl() : string
Tags
Return values
string —update()
public
update(Site $site) : ResponseInterface
Parameters
- $site : Site