Documentation

ResourceImageApi extends ResourceApi
in package
Uses CreateImage

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()  : string
Add an image to a resource
delete()  : ResponseInterface
get()  : SingleResourceResponse
getAll()  : PaginatedResponse
getClient()  : Client
getParentResourceId()  : int|null
getResourceId()  : int|null
multipleResourceUrl()  : string
singleResourceUrl()  : string

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()

Add an image to a resource

public create(string $filename) : string
Parameters
$filename : string

Any path that can be opened using fopen

Tags
throws
ClientExceptionInterface
Return values
string —

The url to the stored image

delete()

public delete() : ResponseInterface
Tags
Return values
ResponseInterface —

getAll()

public getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : PaginatedResponse
Parameters
$filters : array<string|int, mixed> = []
$page : int = 1
$limit : int = 250
Tags
Return values
PaginatedResponse —

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 —

singleResourceUrl()

public abstract singleResourceUrl() : string
Tags
Return values
string — 

        

        
    




    

    

                

    

        

            
Search results