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.

Download multiple source images as a ZIP archive.

The server enforces a maximum of 300 images per request. Use the same $sorts shape as {\Rokka\Client\Image::searchSourceImages()} (e.g. ['created' => 'desc']).

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.

Purge a stack from the CDN cache.

Pass '*' as the stack name to invalidate the entire organization's cache. Limited to 5 invocations per hour. Larger orgs are blocked from using this — clear stack names with deleteStack/createStack are the preferred approach.

List the available stack options as a JSON schema document.

Useful for introspecting what option keys, types, and defaults the Rokka API accepts on stack creation. The response is the raw JSON schema as an associative array.

Sign a render URL via the Rokka API.

The same signing algorithm is available client-side via {\Rokka\Client\UriHelper::signUrl()}, which is generally preferable since it requires no network round-trip. Use this method when you want the API to sign with the organization's stored signing key rather than supplying the key locally.

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.

Supported options:

• ['deletePrevious' => true] — 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.
• ['keepHash' => true] — FOOTGUN. Updates the metadata in place without changing the image hash. Downstream caches (CloudFront, memcached, browser) will keep serving stale renders until manually invalidated. Mutually exclusive with deletePrevious. When passing multiple metadata entries, all entries are written to the same (unchanged) hash.

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

Rename a source image.

Purge a source image from the CDN cache.

Only available on paid accounts. Free accounts will receive a 403 response.

Get the source image alias for the given name.

Create or overwrite an alias that maps a name to a source image hash.

The only option currently accepted is ['overwrite' => true], which allows replacing an existing alias. Without it, the call fails if the alias already exists.

Delete the alias mapping (does not invalidate the CDN cache; call {Image::deleteSourceImageAliasCache()} for that).

Purge an alias from the CDN cache.

Only available on paid accounts (rate-limited to 10 calls/hour).

No description

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.

Supported options:

• ['deletePrevious' => true] — 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.
• ['keepHash' => true] — FOOTGUN. Removes the metadata in place without changing the image hash. Downstream caches (CloudFront, memcached, browser) will keep serving stale renders until manually invalidated. Mutually exclusive with deletePrevious.

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.

Get all user-metadata for an image.

Get a single user-metadata field for an 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.