trait CreativeTrait

Trait CreativeTrait

Properties

ApiClient $apiClient Defined in UploadApi class

Methods

generateSpriteAsync(string|array $tag, array $options = [])

Creates a sprite from all images that have been assigned a specified tag or from a provided array of image URLs.

generateSprite(string|array $tag, array $options = [])

Creates a sprite from all images that have been assigned a specified tag or from a provided array of image URLs.

downloadGeneratedSprite(string|array $tag, array $options = [])

Generates an url to create a sprite from all images that have been assigned a specified tag or from a provided array of URLs.

multiAsync(string|array $tag, array $options = [])

Creates a single animated image, video or PDF from all image assets that have been assigned a specified tag or from a provided array of URLs.

multi(string|array $tag, array $options = [])

Creates a single animated image, video or PDF from all image assets that have been assigned a specified tag or from a provided array of URLs.

downloadMulti(string|array $tag, array $options = [])

Generates an url to create a single animated image, video or PDF from all image assets that have been assigned a specified tag or from a provided array of URLs.

explodeAsync(string $publicId, array $options = [])

Creates derived images for all of the individual pages in a multi-page file (PDF or animated GIF).

explode(string $publicId, array $options = [])

Creates derived images for all of the individual pages in a multi-page file (PDF or animated GIF).

textAsync(string $text, array $options = [])

Dynamically generates an image from a given textual string.

text(string $text, array $options = [])

Dynamically generates an image from a given textual string.

createSlideshowAsync(array $options = [])

Create auto-generated video slideshows.

createSlideshow(array $options = [])

Create auto-generated video slideshows.

Details

PromiseInterface generateSpriteAsync(string|array $tag, array $options = [])

Creates a sprite from all images that have been assigned a specified tag or from a provided array of image URLs.

The process produces two files: * A single sprite image file containing all the images. * A CSS file that includes the style class names and the location of the individual images in the sprite.

This is an asynchronous function.

Parameters

Name Type Description
$tag string|array A string specifying a tag that indicates which images to include or an array which include options and image URLs.
$options array The optional parameters. Should be omitted when $tag is an array.

Return Value

PromiseInterface

See also

https://cloudinary.com/documentation/image_upload_api_reference#sprite_method

ApiResponse generateSprite(string|array $tag, array $options = [])

Creates a sprite from all images that have been assigned a specified tag or from a provided array of image URLs.

The process produces two files: * A single sprite image file containing all the images. * A CSS file that includes the style class names and the location of the individual images in the sprite.

Parameters

Name Type Description
$tag string|array A string specifying a tag that indicates which images to include or an array which include options and image URLs.
$options array The optional parameters. Should be omitted when $tag is an array.

Return Value

ApiResponse

See also

https://cloudinary.com/documentation/image_upload_api_reference#sprite_method

string downloadGeneratedSprite(string|array $tag, array $options = [])

Generates an url to create a sprite from all images that have been assigned a specified tag or from a provided array of URLs.

Parameters

Name Type Description
$tag string|array A string specifying a tag that indicates which images to include or an array which include options and image URLs.
$options array The optional parameters. Should be omitted when $tag is an array.

Return Value

string

See also

https://cloudinary.com/documentation/image_upload_api_reference#sprite_method

PromiseInterface multiAsync(string|array $tag, array $options = [])

Creates a single animated image, video or PDF from all image assets that have been assigned a specified tag or from a provided array of URLs.

This is an asynchronous function.

Parameters

Name Type Description
$tag string|array A string specifying a tag that indicates which images to include or an array which include options and image URLs.
$options array The optional parameters. Should be omitted when $tag is an array.

Return Value

PromiseInterface

See also

https://cloudinary.com/documentation/image_upload_api_reference#multi_method

ApiResponse multi(string|array $tag, array $options = [])

Creates a single animated image, video or PDF from all image assets that have been assigned a specified tag or from a provided array of URLs.

Parameters

Name Type Description
$tag string|array A string specifying a tag that indicates which images to include or an array which include options and image URLs.
$options array The optional parameters. Should be omitted when $tag is an array.

Return Value

ApiResponse

See also

https://cloudinary.com/documentation/image_upload_api_reference#multi_method

string downloadMulti(string|array $tag, array $options = [])

Generates an url to create a single animated image, video or PDF from all image assets that have been assigned a specified tag or from a provided array of URLs.

Parameters

Name Type Description
$tag string|array A string specifying a tag that indicates which images to include or an array which include options and image URLs.
$options array The optional parameters. Should be omitted when $tag is an array.

Return Value

string

See also

https://cloudinary.com/documentation/image_upload_api_reference#sprite_method

PromiseInterface explodeAsync(string $publicId, array $options = [])

Creates derived images for all of the individual pages in a multi-page file (PDF or animated GIF).

Each derived image is stored with the same public ID as the original file, and can be accessed using the page parameter, in order to deliver a specific image.

This is an asynchronous function.

Parameters

Name Type Description
$publicId string The public ID of the multi-page file.
$options array The optional parameters. See the upload API documentation.

Return Value

PromiseInterface

See also

https://cloudinary.com/documentation/image_upload_api_reference#explode_method

ApiResponse explode(string $publicId, array $options = [])

Creates derived images for all of the individual pages in a multi-page file (PDF or animated GIF).

Each derived image is stored with the same public ID as the original file, and can be accessed using the page parameter, in order to deliver a specific image.

Parameters

Name Type Description
$publicId string The public ID of the multi-page file.
$options array The optional parameters. See the upload API documentation.

Return Value

ApiResponse

See also

https://cloudinary.com/documentation/image_upload_api_reference#explode_method

PromiseInterface textAsync(string $text, array $options = [])

Dynamically generates an image from a given textual string.

This is an asynchronous function.

Parameters

Name Type Description
$text string The text string to generate an image for.
$options array The optional parameters. See the upload API documentation.

Return Value

PromiseInterface

See also

https://cloudinary.com/documentation/image_upload_api_reference#text_method

ApiResponse text(string $text, array $options = [])

Dynamically generates an image from a given textual string.

Parameters

Name Type Description
$text string The text string to generate an image for.
$options array The optional parameters. See the upload API documentation.

Return Value

ApiResponse

See also

https://cloudinary.com/documentation/image_upload_api_reference#text_method

PromiseInterface createSlideshowAsync(array $options = [])

Create auto-generated video slideshows.

Parameters

Name Type Description
$options array The optional parameters. See the upload API documentation.

Return Value

PromiseInterface

See also

https://cloudinary.com/documentation/video_slideshow_generation

ApiResponse createSlideshow(array $options = [])

Create auto-generated video slideshows.

Parameters

Name Type Description
$options array The optional parameters. See the upload API documentation.

Return Value

ApiResponse

See also

https://cloudinary.com/documentation/video_slideshow_generation