Index
A
- AdminApi — Class in namespace Cloudinary\Api\Admin
- Enables Cloudinary Admin API functionality.
- AnalysisTrait — Class in namespace Cloudinary\Api\Admin
- Represents Analysis API methods.
- $AnalysisTrait#apiV2Client — Property in class AnalysisTrait
- Defined in AdminApi class.
- AnalysisTrait::analyze() — Method in class AnalysisTrait
- Analyzes an asset with the requested analysis type.
- AnalysisTrait::analyzeAsync() — Method in class AnalysisTrait
- Analyzes an asset with the requested analysis type asynchronously.
- $FoldersTrait#apiClient — Property in class FoldersTrait
- Defined in AdminApi class.
- $MiscTrait#apiClient — Property in class MiscTrait
- Defined in AdminApi class.
- $UploadMappingsTrait#apiClient — Property in class UploadMappingsTrait
- Defined in AdminApi class
- $UploadPresetsTrait#apiClient — Property in class UploadPresetsTrait
- Defined in AdminApi class
- AlreadyExists — Class in namespace Cloudinary\Api\Exception
- AlreadyExists error.
- ApiError — Class in namespace Cloudinary\Api\Exception
- General API error class.
- AuthorizationRequired — Class in namespace Cloudinary\Api\Exception
- AuthorizationRequired error.
- ArchiveTrait — Class in namespace Cloudinary\Api\Upload
- Trait ArchiveTrait
- $ArchiveTrait#apiClient — Property in class ArchiveTrait
- Defined in UploadApi class
- $EditTrait#apiClient — Property in class EditTrait
- Defined in UploadApi class
- $UploadTrait#apiClient — Property in class UploadTrait
- Defined in UploadApi class
- AccessType — Class in namespace Cloudinary\Asset\AccessControl
- Class AccessType
- AssetType — Class in namespace Cloudinary\Asset
- Class AssetType
- AssetConfigTrait — Class in namespace Cloudinary\Configuration
- Trait AssetConfigTrait
B
- BadRequest — Class in namespace Cloudinary\Api\Exception
- BadRequest error.
- UploadTrait::buildUploadParams() — Method in class UploadTrait
- Consolidates the upload parameters.
C
- FoldersTrait::createFolder() — Method in class FoldersTrait
- Creates a new empty folder.
- MiscTrait::config() — Method in class MiscTrait
- Gets account config details.
- UploadMappingsTrait::createUploadMapping() — Method in class UploadMappingsTrait
- Creates a new upload mapping.
- UploadPresetsTrait::createUploadPreset() — Method in class UploadPresetsTrait
- Creates a new upload preset.
- ComparisonRule — Class in namespace Cloudinary\Api\Metadata\Validators
- Base class for all comparison (greater than/less than) validation rules.
- ArchiveTrait::createArchiveAsync() — Method in class ArchiveTrait
- Creates a new archive in the server and returns information in JSON format.
- ArchiveTrait::createArchive() — Method in class ArchiveTrait
- Creates a new archive in the server and returns information in JSON format.
- ArchiveTrait::createZipAsync() — Method in class ArchiveTrait
- Creates a new zip archive in the server and returns information in JSON format.
- ArchiveTrait::createZip() — Method in class ArchiveTrait
- Creates a new zip archive in the server and returns information in JSON format.
- ConfigurationException — Class in namespace Cloudinary\Exception
- Class ConfigurationException
D
- FoldersTrait::deleteFolder() — Method in class FoldersTrait
- Deletes an empty folder.
- UploadMappingsTrait::deleteUploadMapping() — Method in class UploadMappingsTrait
- Deletes an upload mapping.
- UploadPresetsTrait::deleteUploadPreset() — Method in class UploadPresetsTrait
- Deletes the specified upload preset.
- DateMetadataField — Class in namespace Cloudinary\Api\Metadata
- Represents a structured metadata field with 'Date' type.
- DateGreaterThan — Class in namespace Cloudinary\Api\Metadata\Validators
- Greater-than rule for dates.
- DateLessThan — Class in namespace Cloudinary\Api\Metadata\Validators
- Less-than rule for dates.
- ArchiveTrait::downloadArchiveUrl() — Method in class ArchiveTrait
- Returns a URL that when invoked creates an archive and returns it.
- ArchiveTrait::downloadZipUrl() — Method in class ArchiveTrait
- Returns a URL that when invokes creates a zip archive and returns it.
- ArchiveTrait::downloadFolder() — Method in class ArchiveTrait
- Creates and returns a URL that when invoked creates an archive of a folder.
- ArchiveTrait::downloadBackedupAsset() — Method in class ArchiveTrait
- The returned url allows downloading the backedup asset based on the the asset ID and the version ID.
- EditTrait::destroyAsync() — Method in class EditTrait
- Immediately and permanently deletes a single asset from your Cloudinary cloud.
- EditTrait::destroy() — Method in class EditTrait
- Immediately and permanently deletes a single asset from your Cloudinary cloud.
- DeliveryType — Class in namespace Cloudinary\Asset
- Class DeliveryType
E
- EditTrait — Class in namespace Cloudinary\Api\Upload
- Trait EditTrait
- EditTrait::explicitAsync() — Method in class EditTrait
- Applies actions to an already uploaded asset.
- EditTrait::explicit() — Method in class EditTrait
- Applies actions to already uploaded assets.
- Error — Class in namespace Cloudinary\Exception
- Class Error
F
- FoldersTrait — Class in namespace Cloudinary\Api\Admin
- Enables you to manage the folders in your cloud.
G
- GeneralError — Class in namespace Cloudinary\Api\Exception
- General error.
- DateMetadataField::getDefaultValue() — Method in class DateMetadataField
- Gets the default date of this field.
- UploadApi::getUploadUrl() — Method in class UploadApi
- Gets upload URL for the specified asset type and endpoint.
I
- IntMetadataField — Class in namespace Cloudinary\Api\Metadata
- Represents a structured metadata field with 'Int' type.
- IntGreaterThan — Class in namespace Cloudinary\Api\Metadata\Validators
- Greater-than rule for integers.
- IntLessThan — Class in namespace Cloudinary\Api\Metadata\Validators
- Less-than rule for integers.
- ImageTag — Class in namespace Cloudinary\Tag
- Generates an HTML
<img>
tag with thesrc
attribute set to the transformation URL, optionalsrcset
and other specified attributes.
J
- Metadata::jsonSerialize() — Method in class Metadata
- Returns data that should be serialized to JSON.
M
- MiscTrait — Class in namespace Cloudinary\Api\Admin
- Represents several Admin API methods.
- Metadata — Class in namespace Cloudinary\Api\Metadata
- The root structured metadata class.
- MetadataFieldType — Class in namespace Cloudinary\Api\Metadata
- Defines the structured metadata field type.
- ModerationStatus — Class in namespace Cloudinary\Asset
- Class ModerationStatus
- ModerationType — Class in namespace Cloudinary\Asset
- Class ModerationType
N
- NotAllowed — Class in namespace Cloudinary\Api\Exception
- NotAllowed error.
- NotFound — Class in namespace Cloudinary\Api\Exception
- NotFound error.
P
- MiscTrait::ping() — Method in class MiscTrait
- Tests the reachability of the Cloudinary API.
- MiscTrait::pingAsync() — Method in class MiscTrait
- Tests the reachability of the Cloudinary API asynchronously.
- ArchiveTrait::privateDownloadUrl() — Method in class ArchiveTrait
- Returns a URL that when invoked downloads the asset.
R
- FoldersTrait::rootFolders() — Method in class FoldersTrait
- Lists all root folders.
- FoldersTrait::renameFolder() — Method in class FoldersTrait
- Renames folder.
- RateLimited — Class in namespace Cloudinary\Api\Exception
- RateLimited error.
- EditTrait::renameAsync() — Method in class EditTrait
- Renames the specified asset in your Cloudinary cloud.
- EditTrait::rename() — Method in class EditTrait
- Renames the specified asset in your Cloudinary cloud.
S
- FoldersTrait::subFolders() — Method in class FoldersTrait
- Lists sub-folders.
- DateMetadataField::setDefaultValue() — Method in class DateMetadataField
- Sets the default date for this field.
- IntMetadataField::setDefaultValue() — Method in class IntMetadataField
- Sets the default value for this field.
- StringMetadataField — Class in namespace Cloudinary\Api\Metadata
- Represents a metadata field with 'String' type.
- StringMetadataField::setDefaultValue() — Method in class StringMetadataField
- Sets the default value.
- StringLength — Class in namespace Cloudinary\Api\Metadata\Validators
- A validator to validate string lengths.
- SearchFoldersApi — Class in namespace Cloudinary\Api\Search
- Class SearchFoldersApi
- ImageTag::serializeAttributes() — Method in class ImageTag
- Serializes the tag attributes.
T
- MiscTrait::tags() — Method in class MiscTrait
- Lists all the tags currently used for a specified asset type.
U
- MiscTrait::usage() — Method in class MiscTrait
- Gets cloud usage details.
- UploadMappingsTrait — Class in namespace Cloudinary\Api\Admin
- Enables you to manage the upload mappings.
- UploadMappingsTrait::uploadMappings() — Method in class UploadMappingsTrait
- Lists upload mappings by folder and its mapped template (URL).
- UploadMappingsTrait::uploadMapping() — Method in class UploadMappingsTrait
- Returns the details of the specified upload mapping.
- UploadMappingsTrait::updateUploadMapping() — Method in class UploadMappingsTrait
- Updates an existing upload mapping with a new template (URL).
- UploadPresetsTrait — Class in namespace Cloudinary\Api\Admin
- Enables you to manage upload presets.
- UploadPresetsTrait::uploadPresets() — Method in class UploadPresetsTrait
- Lists existing upload presets.
- UploadPresetsTrait::uploadPreset() — Method in class UploadPresetsTrait
- Retrieves the details of the specified upload preset.
- UploadPresetsTrait::updateUploadPreset() — Method in class UploadPresetsTrait
- Updates the specified upload preset.
- UserRole — Class in namespace Cloudinary\Api\Provisioning
- A user role to use in the user management API (create/update user)
- EditTrait::updateMetadataAsync() — Method in class EditTrait
- Populates metadata fields with the given values. Existing values will be overwritten.
- EditTrait::updateMetadata() — Method in class EditTrait
- Populates metadata fields with the given values.
- UploadApi — Class in namespace Cloudinary\Api\Upload
- Class UploadApi for accessing Cloudinary Upload API functionality
- UploadTrait — Class in namespace Cloudinary\Api\Upload
- Trait UploadTrait
- UploadTrait::uploadAsync() — Method in class UploadTrait
- Uploads an asset to a Cloudinary cloud.
- UploadTrait::upload() — Method in class UploadTrait
- Uploads an asset to a Cloudinary cloud.
- UploadTrait::unsignedUploadAsync() — Method in class UploadTrait
- Uploads an asset to a Cloudinary cloud.
- UploadTrait::unsignedUpload() — Method in class UploadTrait
- Uploads an asset to a Cloudinary cloud.
_
- AdminApi::__construct() — Method in class AdminApi
- AdminApi constructor.
- DateMetadataField::__construct() — Method in class DateMetadataField
- The DateMetadataField constructor.
- IntMetadataField::__construct() — Method in class IntMetadataField
- The IntMetadataField constructor.
- StringMetadataField::__construct() — Method in class StringMetadataField
- The StringMetadataField constructor.
- ComparisonRule::__construct() — Method in class ComparisonRule
- ComparisonRule constructor.
- DateGreaterThan::__construct() — Method in class DateGreaterThan
- Create a new rule with the given integer.
- DateLessThan::__construct() — Method in class DateLessThan
- Create a new rule with the given date.
- IntGreaterThan::__construct() — Method in class IntGreaterThan
- Create a new rule with the given integer.
- IntLessThan::__construct() — Method in class IntLessThan
- Create a new rule with the given integer.
- StringLength::__construct() — Method in class StringLength
- Create a new instance with the given min and max.
- SearchFoldersApi::__construct() — Method in class SearchFoldersApi
- SearchFoldersApi constructor.
- UploadApi::__construct() — Method in class UploadApi
- Admin Api constructor.