1. trait
  2. Cloudinary
  3. \
  4. Api
  5. \
  6. Upload
  7. \
  8. ArchiveTrait

ArchiveTrait

trait ArchiveTrait

Trait ArchiveTrait

Properties

ApiClient $apiClient Defined in UploadApi class

Methods

createArchiveAsync(array $options = [], string|null $targetFormat = null)

Creates a new archive in the server and returns information in JSON format.

createArchive(array $options = [], $targetFormat = null)

Creates a new archive in the server and returns information in JSON format.

createZipAsync(array $options = [])

Creates a new zip archive in the server and returns information in JSON format.

createZip(array $options = [])

Creates a new zip archive in the server and returns information in JSON format.

downloadArchiveUrl(array $options = [])

Returns a URL that when invoked creates an archive and returns it.

downloadZipUrl(array $options = [])

Returns a URL that when invokes creates a zip archive and returns it.

privateDownloadUrl(string $publicId, string $format, array $options = [])

Returns a URL that when invoked downloads the asset.

downloadFolder(string $folderPath, array $options = [])

Creates and returns a URL that when invoked creates an archive of a folder.

downloadBackedupAsset(string $assetId, string $versionId)

The returned url allows downloading the backedup asset based on the the asset ID and the version ID.

Details

PromiseInterface createArchiveAsync(array $options = [], string|null $targetFormat = null)

Creates a new archive in the server and returns information in JSON format.

Parameters

Name Type Description
$options array
$targetFormat string|null

Return Value

PromiseInterface

ApiResponse createArchive(array $options = [], $targetFormat = null)

Creates a new archive in the server and returns information in JSON format.

Parameters

Name Type Description
$options array
$targetFormat

Return Value

ApiResponse

PromiseInterface createZipAsync(array $options = [])

Creates a new zip archive in the server and returns information in JSON format.

Parameters

Name Type Description
$options array

Return Value

PromiseInterface

ApiResponse createZip(array $options = [])

Creates a new zip archive in the server and returns information in JSON format.

Parameters

Name Type Description
$options array

Return Value

ApiResponse

string downloadArchiveUrl(array $options = [])

Returns a URL that when invoked creates an archive and returns it.

Parameters

Name Type Description
$options array Additional options. Can be one of the following:

Return Value

string The resulting archive URL.

string downloadZipUrl(array $options = [])

Returns a URL that when invokes creates a zip archive and returns it.

Parameters

Name Type Description
$options array Additional options. See ArchiveTrait::downloadArchiveUrl.

Return Value

string The resulting archive URL.

See also

ArchiveTrait::downloadArchiveUrl

string privateDownloadUrl(string $publicId, string $format, array $options = [])

Returns a URL that when invoked downloads the asset.

Parameters

Name Type Description
$publicId string The public ID of the asset to download.
$format string The format of the asset to download.
$options array Additional options.

Return Value

string

string downloadFolder(string $folderPath, array $options = [])

Creates and returns a URL that when invoked creates an archive of a folder.

Parameters

Name Type Description
$folderPath string Full path (from the root) of the folder to download.
$options array Additional options.

Return Value

string Url for downloading an archive of a folder.

string downloadBackedupAsset(string $assetId, string $versionId)

The returned url allows downloading the backedup asset based on the the asset ID and the version ID.

Parameters

Name Type Description
$assetId string The asset ID of the asset.
$versionId string The version ID of the asset.

Return Value

string The signed URL for downloading backup version of the asset.