Index | Rokka PHP Client API

A

$ Membership#active — Property in class Membership: Active.
Stack::addStackExpression() — Method in class Stack: Adds a Stack Expression to the list of existing Stack Expression.
StackAbstract::addStackOperation() — Method in class StackAbstract: Adds a StackOperation to the list of existing Stack Operations.
StackAbstract::addStackOption() — Method in class StackAbstract: Sets a single Stack option to the list of existing Stack options.
StackExpression::addOptionOverride() — Method in class StackExpression: Adds a single option override to the options overrides.
StackUri::addOverridingOptions() — Method in class StackUri: For overwriting stack operation options or adding stack options.
$ User#apiKey — Property in class User: Key.
Image::addUserMetadata() — Method in class Image: Add the given fields to the user-metadata of the image.
UriHelper::addOptionsToUriString() — Method in class UriHelper: Allows you to add stack options to a Rokka URL.
UriHelper::addOptionsToUri() — Method in class UriHelper: Allows you to add stack options to a Rokka URL.

B

Base — Class in namespace Rokka\Client: Base Client class.
$ Organization#billingEmail — Property in class Organization: Email.
$ SourceImage#binaryHash — Property in class SourceImage
DynamicMetadataHelper::buildDynamicMetadata() — Method in class DynamicMetadataHelper
SearchHelper::buildSearchSortParameter() — Method in class SearchHelper: Builds the "sort" parameter for the source image listing API endpoint.

C

$ Base#client — Property in class Base: Client to access Rokka.
Base::call() — Method in class Base: Call the API rokka endpoint.
DetectionFace::createFromJsonResponse() — Method in class DetectionFace: Create a SubjectArea from the JSON data.
DynamicMetadataInterface::createFromJsonResponse() — Method in class DynamicMetadataInterface: Create a DynamicMetadata from the JSON data.
SubjectArea::createFromJsonResponse() — Method in class SubjectArea: Create a SubjectArea from the JSON data.
Membership::createFromJsonResponse() — Method in class Membership: Create a user from the JSON data returned by the rokka.io API.
OperationCollection::count() — Method in class OperationCollection: Return number of operations.
OperationCollection::createFromJsonResponse() — Method in class OperationCollection: Create a collection from the JSON data returned by the rokka.io API.
OperationCollection::current() — Method in class OperationCollection
Organization::createFromJsonResponse() — Method in class Organization: Create an organization from the JSON data.
$ SourceImage#created — Property in class SourceImage
SourceImage::createFromJsonResponse() — Method in class SourceImage: Create a source image from the JSON data.
SourceImageCollection::count() — Method in class SourceImageCollection: Return number in the collection.
SourceImageCollection::createFromJsonResponse() — Method in class SourceImageCollection: Create a collection from the JSON data returned by the rokka.io API.
SourceImageCollection::current() — Method in class SourceImageCollection
Stack::createFromJsonResponse() — Method in class Stack: Create a stack from the JSON data returned by the rokka.io API.
Stack::createFromConfig() — Method in class Stack: Creates a Stack object from an array.
StackCollection::count() — Method in class StackCollection: Return the number of stacks in this collection.
StackCollection::createFromJsonResponse() — Method in class StackCollection: Create a stack from the JSON data returned by the rokka.io API.
StackCollection::current() — Method in class StackCollection
StackExpression::createFromJsonResponse() — Method in class StackExpression: Create a stack from the JSON data returned by the rokka.io API.
StackOperation::createFromJsonResponse() — Method in class StackOperation: Create a stack operation from the JSON data returned by the rokka.io API.
UriComponents::createFromArray() — Method in class UriComponents: Creates a UriComponent object from an array with 'stack', 'hash', 'format', 'filename' and 'stack' as keys.
User::createFromJsonResponse() — Method in class User: Create a user from the JSON data returned by the rokka.io API.
Image::createStack() — Method in class Image: Create a stack.
UriHelper::composeUri() — Method in class UriHelper: Generate a rokka uri with an array or an UriComponent returned by decomposeUri().
User::createUser() — Method in class User: Create a user.
User::createOrganization() — Method in class User: Create an organization.
User::createMembership() — Method in class User: Create a membership.

D

DetectionFace — Class in namespace Rokka\Client\Core\DynamicMetadata
DynamicMetadataInterface — Class in namespace Rokka\Client\Core\DynamicMetadata: Marker interface to mark classes as dynamic metadata.
$ Organization#displayName — Property in class Organization: Public display name.
$ SourceImage#dynamicMetadata — Property in class SourceImage
DynamicMetadataHelper — Class in namespace Rokka\Client
Image::deleteSourceImage() — Method in class Image: Delete a source image.
Image::deleteSourceImagesWithBinaryHash() — Method in class Image: Delete source images by binaryhash.
Image::deleteStack() — Method in class Image: Delete a stack.
Image::deleteDynamicMetadata() — Method in class Image: Delete the given DynamicMetadata from a SourceImage.
Image::deleteUserMetadata() — Method in class Image: Delete the user-metadata from the given image.
Image::deleteUserMetadataField() — Method in class Image: Delete the given field from the user-metadata of the image.
Image::deleteUserMetadataFields() — Method in class Image: Delete the given fields from the user-metadata of the image.
UriHelper::decomposeUri() — Method in class UriHelper: Return components of a rokka URL.

E

$ StackExpression#expression — Property in class StackExpression
$ User#email — Property in class User: Email of user.
Image::extractHashFromLocationHeader() — Method in class Image: Helper function to extract from a Location header the image hash, only the first Location is used.

F

$ SourceImage#format — Property in class SourceImage
Factory — Class in namespace Rokka\Client: Factory class with static methods to easily instantiate clients.

G

DetectionFace::getName() — Method in class DetectionFace
DynamicMetadataInterface::getName() — Method in class DynamicMetadataInterface
SubjectArea::getName() — Method in class SubjectArea
Operation::getName() — Method in class Operation: Get Name.
Operation::getProperties() — Method in class Operation: Get Properties.
Operation::getRequired() — Method in class Operation: Get Required properties.
OperationCollection::getOperations() — Method in class OperationCollection: Return operations.
Organization::getId() — Method in class Organization: Get Id.
Organization::getDisplayName() — Method in class Organization: Get name for displaying.
Organization::getName() — Method in class Organization: Get name for url.
Organization::getBillingEmail() — Method in class Organization: Get Billing Email.
SourceImageCollection::getTotal() — Method in class SourceImageCollection: Returns the total amount of items available in the API for the current listing.
SourceImageCollection::getCursor() — Method in class SourceImageCollection: Returns the cursor value, if any.
SourceImageCollection::getLinks() — Method in class SourceImageCollection: Returns the pagination/navigation links.
SourceImageCollection::getSourceImages() — Method in class SourceImageCollection: Return the source images in the collection.
Stack::getOrganization() — Method in class Stack: Get name of organization this stack belongs to.
Stack::getCreated() — Method in class Stack: Get date of creation for this stack.
Stack::getStackExpressions() — Method in class Stack
Stack::getConfig() — Method in class Stack: Gets stack operations / options / expressions as one array.
Stack::getDynamicUriString() — Method in class Stack: Returns the stack url part as a dynamic stack for previewing.
StackAbstract::getName() — Method in class StackAbstract: Get name of stack for url.
StackAbstract::getStackOperations() — Method in class StackAbstract
StackAbstract::getStackOperationsByName() — Method in class StackAbstract: Returns all operations matching name.
StackAbstract::getStackOptions() — Method in class StackAbstract
StackCollection::getStacks() — Method in class StackCollection: Return the stacks.
StackExpression::getExpression() — Method in class StackExpression
StackExpression::getOptionsOverrides() — Method in class StackExpression
StackUri::getStackUri() — Method in class StackUri: Returns the stack uri in 'dynamic' notation.
StackUri::getStackUriString() — Method in class StackUri: Returns the stack url part as it should be with "addOptionsToUrl" calls in 'dynamic' notation.
StackUri::getConfigAsArray() — Method in class StackUri: Gets stack operations / options as "flat" array.
UriComponents::getStack() — Method in class UriComponents
UriComponents::getHash() — Method in class UriComponents
UriComponents::getFormat() — Method in class UriComponents
UriComponents::getFilename() — Method in class UriComponents
User::getId() — Method in class User: Get Id.
User::getEmail() — Method in class User: Get Email.
User::getApiKey() — Method in class User: Get Api Key.
DynamicMetadataHelper::getDynamicMetadataClassName() — Method in class DynamicMetadataHelper: Returns the Dynamic Metadata class name from the API name.
Factory::getImageClient() — Method in class Factory: Return an image client.
Factory::getUserClient() — Method in class Factory: Return a user client.
Image::getSourceImage() — Method in class Image: Load a source image's metadata from Rokka.
Image::getSourceImagesWithBinaryHash() — Method in class Image: Loads source images metadata from Rokka by binaryhash.
Image::getSourceImageContents() — Method in class Image: Get a source image's binary contents from Rokka.
Image::getStack() — Method in class Image: Return a stack.
Image::getSourceImageUri() — Method in class Image: Returns url for accessing the image.
UriHelper::getSrcSetUrlString() — Method in class UriHelper
UriHelper::getSrcSetUrl() — Method in class UriHelper: Returns a rokka URL to be used in srcset style attributes.
User::getOrganization() — Method in class User: Return an organization.
User::getMembership() — Method in class User: Get the membership metadata for the given organization and user's email.

H

$ DetectionFace#height — Property in class DetectionFace
$ SubjectArea#height — Property in class SubjectArea
$ SourceImage#hash — Property in class SourceImage
$ SourceImage#height — Property in class SourceImage

I

$ Organization#id — Property in class Organization: UUID v4.
$ User#id — Property in class User: UUID v4.
Image — Class in namespace Rokka\Client: Image client for the rokka.io service.

K

OperationCollection::key() — Method in class OperationCollection
SourceImageCollection::key() — Method in class SourceImageCollection
StackCollection::key() — Method in class StackCollection

L

$ SourceImage#link — Property in class SourceImage
Image::listSourceImages() — Method in class Image: List source images.
Image::listOperations() — Method in class Image: List operations.
Image::listStacks() — Method in class Image: List stacks.

M

Membership — Class in namespace Rokka\Client\Core: Represents the relation of a user to an organization.

N

$ Operation#name — Property in class Operation: Descriptive name of the operation.
OperationCollection::next() — Method in class OperationCollection
$ Organization#name — Property in class Organization: Organization name.
$ SourceImage#name — Property in class SourceImage
SourceImageCollection::next() — Method in class SourceImageCollection
$ StackAbstract#name — Property in class StackAbstract
StackCollection::next() — Method in class StackCollection
$ StackOperation#name — Property in class StackOperation: Name of the operation.

O

$ Membership#organizationId — Property in class Membership: UUID v4 of organization.
Operation — Class in namespace Rokka\Client\Core: Represents a single operation to be executed on an image.
OperationCollection — Class in namespace Rokka\Client\Core: Represents a collection of image transformation operations in a stack.
Organization — Class in namespace Rokka\Client\Core: Organizations are independent instances of the Rokka service.
$ SourceImage#organization — Property in class SourceImage
$ Stack#organization — Property in class Stack
$ StackExpression#overrides — Property in class StackExpression
$ StackOperation#options — Property in class StackOperation: Configured options provided for the stack.
UriComponents::offsetExists() — Method in class UriComponents
UriComponents::offsetGet() — Method in class UriComponents
UriComponents::offsetSet() — Method in class UriComponents
UriComponents::offsetUnset() — Method in class UriComponents

P

$ Operation#properties — Property in class Operation: Properties.

R

$ Membership#role — Property in class Membership: Role.
$ Operation#required — Property in class Operation: Required parameters.
OperationCollection::rewind() — Method in class OperationCollection
SourceImageCollection::rewind() — Method in class SourceImageCollection
StackCollection::rewind() — Method in class StackCollection

S

Base::setCredentials() — Method in class Base: Set the credentials.
SubjectArea — Class in namespace Rokka\Client\Core\DynamicMetadata
SourceImage — Class in namespace Rokka\Client\Core: Represents the metadata of an image.
$ SourceImage#shortHash — Property in class SourceImage
$ SourceImage#size — Property in class SourceImage
$ SourceImage#staticMetadata — Property in class SourceImage
SourceImageCollection — Class in namespace Rokka\Client\Core: Represents a collection of source images.
Stack — Class in namespace Rokka\Client\Core: Represents a collection of stack operations for an organization.
$ Stack#stackExpressions — Property in class Stack
Stack::setOrganization() — Method in class Stack
Stack::setStackExpressions() — Method in class Stack
StackAbstract — Class in namespace Rokka\Client\Core
$ StackAbstract#stackOperations — Property in class StackAbstract
$ StackAbstract#stackOptions — Property in class StackAbstract
StackAbstract::setName() — Method in class StackAbstract
StackAbstract::setStackOperations() — Method in class StackAbstract
StackAbstract::setStackOptions() — Method in class StackAbstract
StackCollection — Class in namespace Rokka\Client\Core: Holds a list of stacks.
StackExpression — Class in namespace Rokka\Client\Core
StackExpression::setExpression() — Method in class StackExpression
StackExpression::setOptionsOverrides() — Method in class StackExpression
StackOperation — Class in namespace Rokka\Client\Core: Represents an operation with configuration.
StackUri — Class in namespace Rokka\Client\Core: This class is useful for working on stack URIs (dynamic or defined ones).
UriComponents::setStack() — Method in class UriComponents
UriComponents::setHash() — Method in class UriComponents
UriComponents::setFormat() — Method in class UriComponents
UriComponents::setFilename() — Method in class UriComponents
Image::searchSourceImages() — Method in class Image: Search and list source images.
Image::saveStack() — Method in class Image: Save a stack on rokka.
Image::setDynamicMetadata() — Method in class Image: Add the given DynamicMetadata to a SourceImage.
Image::setUserMetadataField() — Method in class Image: Add (or update) the given user-metadata field to the image.
Image::setUserMetadata() — Method in class Image: Set the given fields as the user-metadata of the image.
SearchHelper — Class in namespace Rokka\Client: Helper class for Search parameter building for Rokka.io service.

T

StackOperation::toArray() — Method in class StackOperation: Return the stack operation as an array.

U

$ Membership#userId — Property in class Membership: UUID v4 of user.
$ SourceImage#userMetadata — Property in class SourceImage
UriComponents — Class in namespace Rokka\Client\Core: Class UriComponents.
User — Class in namespace Rokka\Client\Core: Represents a user.
Image::uploadSourceImage() — Method in class Image: Upload a source image.
UriHelper — Class in namespace Rokka\Client
User — Class in namespace Rokka\Client: User management client for the rokka.io service.

V

OperationCollection::valid() — Method in class OperationCollection
SourceImageCollection::valid() — Method in class SourceImageCollection
StackCollection::valid() — Method in class StackCollection
SearchHelper::validateFieldName() — Method in class SearchHelper: Validates the field name.

W

$ DetectionFace#width — Property in class DetectionFace
$ SubjectArea#width — Property in class SubjectArea
$ SourceImage#width — Property in class SourceImage

X

$ DetectionFace#x — Property in class DetectionFace
$ SubjectArea#x — Property in class SubjectArea

Y

$ DetectionFace#y — Property in class DetectionFace
$ SubjectArea#y — Property in class SubjectArea

_

Base::__construct() — Method in class Base: Constructor.
DetectionFace::__construct() — Method in class DetectionFace: DetectionFace constructor.
SubjectArea::__construct() — Method in class SubjectArea: SubjectArea constructor.
Membership::__construct() — Method in class Membership: Constructor.
Operation::__construct() — Method in class Operation: Constructor.
OperationCollection::__construct() — Method in class OperationCollection: Constructor.
Organization::__construct() — Method in class Organization: Constructor.
SourceImage::__construct() — Method in class SourceImage: Constructor.
SourceImageCollection::__construct() — Method in class SourceImageCollection: Constructor.
Stack::__construct() — Method in class Stack: Constructor.
StackAbstract::__construct() — Method in class StackAbstract
StackCollection::__construct() — Method in class StackCollection: Constructor.
StackExpression::__construct() — Method in class StackExpression
StackOperation::__construct() — Method in class StackOperation: Constructor.
StackUri::__construct() — Method in class StackUri
StackUri::__toString() — Method in class StackUri
UriComponents::__construct() — Method in class UriComponents: StackUriComponents constructor.
User::__construct() — Method in class User: Constructor.
Image::__construct() — Method in class Image: Constructor.