\VivialConnect\ResourcesAccount

__construct()

__construct(  $data = null) 

Parameters

getId()

getId() : mixed|null

Get the ID of the resource

Returns

getIdentifierName()

getIdentifierName() : string

Get the identifier property name (defaults to "id")

Returns

getResourceName()

getResourceName() : null|string

Get VivialConnect resource name.

Returns

getResourceUri()

getResourceUri() : string

Get the full resource URI

Returns

getResponse()

getResponse() : \VivialConnect\Resources\Response|null

Get the Response object

Returns

getError()

getError() : \VivialConnect\Resources\Error|null

Get the error object

Returns

save()

save(array  $queryParams = array(), array  $headers = array(),   $isSubresource = False) : boolean

Save the entity

Parameters

Returns

destroy()

destroy(array  $queryParams = array(), array  $headers = array(),   $isSubresrouce = False) : boolean

Destroy (delete) the resource

Parameters

Returns

fill()

fill(array  $data) 

Mass assign properties with an array of key/value pairs

Parameters

includesMany()

includesMany(string  $model, array  $data) : \VivialConnect\Resources\Collection

Build a Collection of included resources in response payload.

Parameters

Returns

includesOne()

includesOne(string  $model,   $data) : Resource

Build a single instance of an included resource in response payload.

Parameters

Returns

through()

through(Resource|string  $resource) 

Set dependent resources to prepend to URI. You can call this method multiple times to prepend additional dependent resources.

For example, if the API only allows you create a new comment on a post through the post's URI: POST /posts/1234/comment

$comment = new Comment; $comment->through('posts/1234'); $comment->body = "This is a comment"; $comment->save();

OR

$post = Post::find(1234); $comment = new Comment; $comment->through($post); $comment->body = "This is a comment"; $comment->save();

Parameters

__get()

__get(  $property) : mixed|null

Magic getter

Parameters

Returns

__set()

__set(  $property,   $value) 

Magic setter

Parameters

original()

original(  $property) : mixed|null

Get the original value of a property (before it was modified).

Parameters

Returns

reset()

reset() : void

Reset all modified properties, reset response, reset error

toArray()

toArray() : array

Returns

toJson()

toJson() : string

Returns

getConnection()

getConnection() : \VivialConnect\Transport\Connection

Get the connection for the model

Returns

find()

find(integer|string|null  $id = null, array  $queryParams = array(), array  $headers = array()) : Resource|boolean

Find (GET) a specific resource by its ID (optional)

This method assumes the payload contains a SINGLE resource instance. This method will call the parseFind method on the Resource instance to know where to look in the payload to get the resource data.

Parameters

Throws

\VivialConnect\Common\ResponseException

Returns

all()

all(array  $queryParams = array(), array  $headers = array()) : \VivialConnect\Resources\Collection|boolean

Get ALL resources

This method assumes the payload contains an ARRAY of resource instances. This method will call the parseAll method on the Resource instance to know where to look in the payload to get the array of resource data.

Parameters

Throws

\VivialConnect\Common\ResponseException

Returns

delete()

delete(  $id, array  $queryParams = array(), array  $headers = array()) : boolean

Delete a resource

Parameters

Throws

\VivialConnect\Common\ResponseException

Returns

findThrough()

findThrough(Resource|string  $resource, integer|string|null  $id = null, array  $queryParams = array(), array  $headers = array()) : Resource|boolean

Find a single instance *through* a dependent resource. It prepends the resource URI with the given dependent resource URI. For example: API URI: [GET] /posts/1234/comments/5678

$comment = Comment::findThrough('posts/1234', 5678);

OR

$post = Post::find(1234); $comment = Comment::findThrough($post, 5678);

Parameters

Throws

\VivialConnect\Common\ResponseException

Returns

allThrough()

allThrough(Resource|string  $resource, array  $queryParams = array(), array  $headers = array()) : \VivialConnect\Resources\Collection|boolean

Find all instances *through* a dependent resource. It prepends the resource URI with the given dependent resource URI. For example:

API URI: [GET] /posts/1234/comments

$comments = Comment::allThrough('posts/1234');

OR

$post = Post::find(1234); $comments = Comment::allThrough($post);

Parameters

Throws

\VivialConnect\Common\ResponseException

Returns

connection()

connection() : \VivialConnect\Transport\Connection

Get the connection

Returns

setCredentialToken()

setCredentialToken(  $name,   $value) 

Set credentials token.

Parameters

getCredentialToken()

getCredentialToken(  $name) : string

Gets credentials token.

Parameters

Returns

init()

init(array  $options = array(),   $connectionName = 'default',   $client = null) 

Initilize HTTP connection object.

Parameters

getConnectionByName()

getConnectionByName(  $connectionName = 'default') 

Gets a connection by its name.

Parameters

billingStatus()

billingStatus(  $accountId = null, array  $queryParams = array(), array  $headers = array()) 

Parameters

isDirty()

isDirty() : integer

Is this entity dirty?

Returns

getDependencies()

getDependencies() : string

Get any resource dependencies

Returns

parseFind()

parseFind(  $payload) : mixed

Where to find the single resource data from the response payload.

You should overwrite this method in your model class to suite your needs.

Parameters

Returns

parseAll()

parseAll(  $payload) : mixed

Where to find the array of data from the response payload.

You should overwrite this method in your model class to suit your needs.

Parameters

Returns

wrapAttributes()

wrapAttributes(  $attributes = array(),   $root = 'object') : array

Wraps attributes into VivialConnect compatible payload.

Parameters

Returns

hydrate()

hydrate(  $data) : boolean

Hydrate

Parameters

Throws

\VivialConnect\Resources\ResourceException

Returns