Image

Constructor.

Set the credentials.

Set the API Token.

Get the API Token.

Get the API Token Payload (unverified).

Returns for how many seconds a token is valid for.

Doesn't check for other validity (like ip restrictions)

Returns -1 if there's no token

Call the API rokka endpoint.

Return the organization or the default if empty.

Gets the payload of an API JWT Token (not validated against the signature).

Upload a source image.

Upload a source image.

Delete a source image.

Restore a source image.

Copy a source image to another org.

Needs read permissions on the source organization and write permissions on the write organization.

Copy multiple sources image to another org.

Needs read permissions on the source organization and write permissions on the write organization.

Delete source images by binaryhash.

Since the same binaryhash can have different images in rokka, this may delete more than one picture.

Search and list source images.

Sort direction can either be: "asc", "desc" (or the boolean TRUE value, treated as "asc")

List source images.

Load a source image's metadata from Rokka.

Loads source images metadata from Rokka by binaryhash.

Since the same binaryhash can have different images in rokka, this may return more than one picture.

Get a source image's binary contents from Rokka.

List operations.

Create a stack.

Save a stack on rokka.

Example:

$stack = new Stack(null, 'teststack');
$stack->addStackOperation(new StackOperation('resize', ['width' => 200, 'height' => 200]));
$stack->addStackOperation(new StackOperation('rotate', ['angle' => 45]));
$stack->setStackOptions(['jpg.quality' => 80]);
$requestConfig = ['overwrite' => true];
$stack = $client->saveStack($stack, $requestConfig);
echo 'Created stack ' . $stack->getName() . PHP_EOL;

The only requestConfig option currently can be ['overwrite' => true|false] (false is the default)

List stacks.

use Rokka\Client\Core\Stack;
$client = \Rokka\Client\Factory::getImageClient('testorganization', 'apiKey');
$stacks = $client->listStacks();
foreach ($stacks as $stack) {
  echo 'Stack ' . $stack->getName() . PHP_EOL;
}

Return a stack.

Delete a stack.

Add the given DynamicMetadata to a SourceImage.

Returns the new Hash for the SourceImage, it could be the same as the input one if the operation did not change it.

The only option currently can be ['deletePrevious' => true]

which deletes the previous image from rokka (but not the binary, since that's still used) If not set, the original image is kept in rokka.

(Un)sets protected status to a SourceImage.

Returns the new Hash for the SourceImage, it could be the same as the input one if the operation did not change the protected status.

The only option currently can be ['deletePrevious' => true]

which deletes the previous image from rokka (but not the binary, since that's still used) If not set, the original image is kept in rokka.

(Un)sets locked status to a SourceImage.

No description

Delete the given DynamicMetadata from a SourceImage.

Returns the new Hash for the SourceImage, it could be the same as the input one if the operation did not change it.

The only option currently can be ['deletePrevious' => true] which deletes the previous image from rokka (but not the binary, since that's still used) If not set, the original image is kept in rokka.

Add (or update) the given user-metadata field to the image.

Add the given fields to the user-metadata of the image.

Set the given fields as the user-metadata of the image.

Delete the user-metadata from the given image.

Delete the given field from the user-metadata of the image.

Delete the given fields from the user-metadata of the image.

Returns url for accessing the image.

No description

No description

Helper function to extract from a Location header the image hash, only the first Location is used.