Class Endpoints

GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided

Catapult\GenericResource

Extended by

Catapult\Endpoints

Final
Namespace: Catapult
Located at models/Endpoints.php

Methods summary

`public`	# `__construct( )` construct the endpoint as initiated or a new one. endpoints take domains as a dependancy so we need one on init construct the endpoint as initiated or a new one. endpoints take domains as a dependancy so we need one on init init forms GET: Endpoints('domain-id', 'endpoints-id') Endpoints() POST: Endpoints('domain-id', array) Endpoints(array)
`public`	# `load( )` Endpoints overloads the load/1 function we need to rebuild its path resource we need: domains/{domain-id}/endpoints/{endpoint-id} Endpoints overloads the load/1 function we need to rebuild its path resource we need: domains/{domain-id}/endpoints/{endpoint-id} Implementors note: this was added to get around CollectionObject's listAll function which will need to set up this without having to do another RESTful get Overrides `Catapult\GenericResource::load`
`public`	# `create( )` Create musn't preserve the domainId as this will be our path. We will pass it in the parameter, use PathResource then remove it Create musn't preserve the domainId as this will be our path. We will pass it in the parameter, use PathResource then remove it Param: args Endpoint create data Overrides `Catapult\GenericResource::create`
`public`	# `getCredentials( )` get the credentials as a EndpointsCredentials object more on this in types get the credentials as a EndpointsCredentials object more on this in types Returns EndpointsCredentials
`public`	# `createAuthToken( )` create an auth token and return it as a EndpointsToken object more on this in types create an auth token and return it as a EndpointsToken object more on this in types Returns EndpointsToken
`public`	# `deleteAuthToken( Catapult\EndpointsToken $Token )` delete an auth token given as a EndpointsToken object more on this in types delete an auth token given as a EndpointsToken object more on this in types Returns boolean

Methods inherited from Catapult\GenericResource

__call(), __toString(), _init(), _list(), check(), delete(), get(), getAudioUrl(), getObjClass(), getPath(), getSchemaString(), get_sub_function(), reload(), toArray(), update()

Properties summary

Properties inherited from Catapult\GenericResource

$lastUpdate, $paths