PHP Class JD\Cloudder\CloudinaryWrapper

Afficher le fichier Open project: jrm2k6/cloudder Class Usage Examples

Protected Properties

Свойство Type Description
$cloudinary Cloudinary Cloudinary lib.
$config Illuminate\Config\Repository Repository config.
$uploadedResult array Uploaded result.
$uploader Cloudinary\Uploader Cloudinary uploader.

Méthodes publiques

Méthode Description
__construct ( Illuminate\Config\Repository $config, Cloudinary $cloudinary, Uploader $uploader, Api $api ) : void Create a new cloudinary instance.
addTag ( string $tag, array $publicIds = [], array $options = [] ) Add tag to images.
createArchive ( array $options = [], $nameArchive = null, string $mode = 'create' ) Create a zip file containing images matching options.
createTransformation ( string $name, string $definition, array $options = [] ) : array Create transformation
createUploadMapping ( string $name, array $options = [] ) : array Create upload mapping
createUploadPreset ( string $name, array $options = [] ) : array Create upload preset
delete ( $publicId, $options = [] ) : array Alias of destroy.
deleteAllResources ( array $options = [] ) : null Destroy all resources from Cloudinary
deleteDerivedResources ( array $publicIds = [], array $options = [] ) : null Delete transformed images by IDs
deleteResources ( array $publicIds, array $options = [] ) : null Destroy images from Cloudinary
deleteResourcesByPrefix ( string $prefix, array $options = [] ) : null Destroy a resource by its prefix
deleteResourcesByTag ( string $tag, array $options = [] ) : null Delete all resources from one tag
deleteTransformation ( string $transformation, array $options = [] ) : array Delete single transformation
deleteUploadMapping ( string $name, array $options = [] ) : array Delete upload mapping
deleteUploadPreset ( string $name, array $options = [] ) : array Delete upload preset
destroy ( string $publicId, array $options = [] ) : array Destroy resource from Cloudinary
destroyImage ( string $publicId, array $options = [] ) : array Alias for destroy
destroyImages ( array $publicIds, array $options = [] ) : null Alias for deleteResources
downloadArchiveUrl ( array $options = [], $nameArchive = null ) Download a zip file containing images matching options.
getApi ( ) : Api Get cloudinary api
getCloudinary ( ) : Cloudinary Get cloudinary class.
getPublicId ( ) : string Uploaded public ID.
getResult ( ) : array Uploaded result.
getUploader ( ) : Uploader Get cloudinary uploader.
ping ( array $options = [] ) : array Ping cloudinary servers
privateDownloadUrl ( string $publicId, string $format, array $options = [] ) : string Display private image
removeTag ( string $tag, array $publicIds = [], array $options = [] ) Remove tag from images.
rename ( string $publicId, string $toPublicId, array $options = [] ) : array Rename public ID.
replaceTag ( string $tag, array $publicIds = [], array $options = [] ) Replace image's tag.
resource ( string $publicId, array $options = [] ) : array Display a resource
resources ( array $options = [] ) : array Show Resources
resourcesByIds ( array $options = [] ) : array Show Resources by id
resourcesByModeration ( string $kind, string $status, $options = [] ) : array Show Resources by moderation status
resourcesByTag ( string $tag, $options = [] ) : array Show Resources by tag name
restore ( array $publicIds = [], array $options = [] ) : null Restore a resource
rootFolders ( array $options = [] ) : array List Root folders
secureShow ( string $publicId, array $options = [] ) : string Display resource through https.
show ( string $publicId, array $options = [] ) : string Display resource through https.
showPrivateUrl ( string $publicId, string $format, array $options = [] ) : string Alias for privateDownloadUrl
subfolders ( string $name, array $options = [] ) : array List subfolders
tags ( array $options = [] ) : array Display tags list
transformation ( string $transformation, array $options = [] ) : array List single transformation
transformations ( array $options = [] ) : array List transformations
update ( string $publicId, array $options = [] ) : array Updates a resource
updateTransformation ( string $transformation, array $updates = [], array $options = [] ) : array Update single transformation
updateUploadMapping ( string $name, array $options = [] ) : array Update upload mapping
updateUploadPreset ( string $name, array $options = [] ) : array Update upload preset
upload ( mixed $source, string $publicId = null, array $uploadOptions = [], array $tags = [] ) : CloudinaryWrapper Upload image to cloud.
uploadMapping ( string $name, array $options = [] ) : array Get upload mapping
uploadMappings ( array $options = [] ) : array List Upload Mappings
uploadPreset ( string $name, array $options = [] ) : array Get upload mapping
uploadPresets ( array $options = [] ) : array List Upload Presets
uploadVideo ( mixed $source, string $publicId = null, array $uploadOptions = [], array $tags = [] ) : CloudinaryWrapper Upload video to cloud.
usage ( array $options = [] ) : array Get usage details

Method Details

__construct() public méthode

Create a new cloudinary instance.
public __construct ( Illuminate\Config\Repository $config, Cloudinary $cloudinary, Uploader $uploader, Api $api ) : void
$config Illuminate\Config\Repository
$cloudinary Cloudinary
$uploader Cloudinary\Uploader
$api Cloudinary\Api
Résultat void

addTag() public méthode

Add tag to images.
public addTag ( string $tag, array $publicIds = [], array $options = [] )
$tag string
$publicIds array
$options array

createArchive() public méthode

Create a zip file containing images matching options.
public createArchive ( array $options = [], $nameArchive = null, string $mode = 'create' )
$options array
$mode string

createTransformation() public méthode

Create transformation
public createTransformation ( string $name, string $definition, array $options = [] ) : array
$name string
$definition string
$options array
Résultat array

createUploadMapping() public méthode

Create upload mapping
public createUploadMapping ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

createUploadPreset() public méthode

Create upload preset
public createUploadPreset ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

delete() public méthode

Alias of destroy.
public delete ( $publicId, $options = [] ) : array
Résultat array

deleteAllResources() public méthode

Destroy all resources from Cloudinary
public deleteAllResources ( array $options = [] ) : null
$options array
Résultat null

deleteDerivedResources() public méthode

Delete transformed images by IDs
public deleteDerivedResources ( array $publicIds = [], array $options = [] ) : null
$publicIds array
$options array
Résultat null

deleteResources() public méthode

Destroy images from Cloudinary
public deleteResources ( array $publicIds, array $options = [] ) : null
$publicIds array
$options array
Résultat null

deleteResourcesByPrefix() public méthode

Destroy a resource by its prefix
public deleteResourcesByPrefix ( string $prefix, array $options = [] ) : null
$prefix string
$options array
Résultat null

deleteResourcesByTag() public méthode

Delete all resources from one tag
public deleteResourcesByTag ( string $tag, array $options = [] ) : null
$tag string
$options array
Résultat null

deleteTransformation() public méthode

Delete single transformation
public deleteTransformation ( string $transformation, array $options = [] ) : array
$transformation string
$options array
Résultat array

deleteUploadMapping() public méthode

Delete upload mapping
public deleteUploadMapping ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

deleteUploadPreset() public méthode

Delete upload preset
public deleteUploadPreset ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

destroy() public méthode

Destroy resource from Cloudinary
public destroy ( string $publicId, array $options = [] ) : array
$publicId string
$options array
Résultat array

destroyImage() public méthode

Alias for destroy
public destroyImage ( string $publicId, array $options = [] ) : array
$publicId string
$options array
Résultat array

destroyImages() public méthode

Alias for deleteResources
public destroyImages ( array $publicIds, array $options = [] ) : null
$publicIds array
$options array
Résultat null

downloadArchiveUrl() public méthode

Download a zip file containing images matching options.
public downloadArchiveUrl ( array $options = [], $nameArchive = null )
$options array

getApi() public méthode

Get cloudinary api
public getApi ( ) : Api
Résultat Cloudinary\Api

getCloudinary() public méthode

Get cloudinary class.
public getCloudinary ( ) : Cloudinary
Résultat Cloudinary

getPublicId() public méthode

Uploaded public ID.
public getPublicId ( ) : string
Résultat string

getResult() public méthode

Uploaded result.
public getResult ( ) : array
Résultat array

getUploader() public méthode

Get cloudinary uploader.
public getUploader ( ) : Uploader
Résultat Cloudinary\Uploader

ping() public méthode

Ping cloudinary servers
public ping ( array $options = [] ) : array
$options array
Résultat array

privateDownloadUrl() public méthode

Display private image
public privateDownloadUrl ( string $publicId, string $format, array $options = [] ) : string
$publicId string
$format string
$options array
Résultat string

removeTag() public méthode

Remove tag from images.
public removeTag ( string $tag, array $publicIds = [], array $options = [] )
$tag string
$publicIds array
$options array

rename() public méthode

Rename public ID.
public rename ( string $publicId, string $toPublicId, array $options = [] ) : array
$publicId string
$toPublicId string
$options array
Résultat array

replaceTag() public méthode

Replace image's tag.
public replaceTag ( string $tag, array $publicIds = [], array $options = [] )
$tag string
$publicIds array
$options array

resource() public méthode

Display a resource
public resource ( string $publicId, array $options = [] ) : array
$publicId string
$options array
Résultat array

resources() public méthode

Show Resources
public resources ( array $options = [] ) : array
$options array
Résultat array

resourcesByIds() public méthode

Show Resources by id
public resourcesByIds ( array $options = [] ) : array
$options array
Résultat array

resourcesByModeration() public méthode

Show Resources by moderation status
public resourcesByModeration ( string $kind, string $status, $options = [] ) : array
$kind string
$status string
Résultat array

resourcesByTag() public méthode

Show Resources by tag name
public resourcesByTag ( string $tag, $options = [] ) : array
$tag string
Résultat array

restore() public méthode

Restore a resource
public restore ( array $publicIds = [], array $options = [] ) : null
$publicIds array
$options array
Résultat null

rootFolders() public méthode

List Root folders
public rootFolders ( array $options = [] ) : array
$options array
Résultat array

secureShow() public méthode

Display resource through https.
public secureShow ( string $publicId, array $options = [] ) : string
$publicId string
$options array
Résultat string

show() public méthode

Display resource through https.
public show ( string $publicId, array $options = [] ) : string
$publicId string
$options array
Résultat string

showPrivateUrl() public méthode

Alias for privateDownloadUrl
public showPrivateUrl ( string $publicId, string $format, array $options = [] ) : string
$publicId string
$format string
$options array
Résultat string

subfolders() public méthode

List subfolders
public subfolders ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

tags() public méthode

Display tags list
public tags ( array $options = [] ) : array
$options array
Résultat array

transformation() public méthode

List single transformation
public transformation ( string $transformation, array $options = [] ) : array
$transformation string
$options array
Résultat array

transformations() public méthode

List transformations
public transformations ( array $options = [] ) : array
$options array
Résultat array

update() public méthode

Updates a resource
public update ( string $publicId, array $options = [] ) : array
$publicId string
$options array
Résultat array

updateTransformation() public méthode

Update single transformation
public updateTransformation ( string $transformation, array $updates = [], array $options = [] ) : array
$transformation string
$updates array
$options array
Résultat array

updateUploadMapping() public méthode

Update upload mapping
public updateUploadMapping ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

updateUploadPreset() public méthode

Update upload preset
public updateUploadPreset ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

upload() public méthode

Upload image to cloud.
public upload ( mixed $source, string $publicId = null, array $uploadOptions = [], array $tags = [] ) : CloudinaryWrapper
$source mixed
$publicId string
$uploadOptions array
$tags array
Résultat CloudinaryWrapper

uploadMapping() public méthode

Get upload mapping
public uploadMapping ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

uploadMappings() public méthode

List Upload Mappings
public uploadMappings ( array $options = [] ) : array
$options array
Résultat array

uploadPreset() public méthode

Get upload mapping
public uploadPreset ( string $name, array $options = [] ) : array
$name string
$options array
Résultat array

uploadPresets() public méthode

List Upload Presets
public uploadPresets ( array $options = [] ) : array
$options array
Résultat array

uploadVideo() public méthode

Upload video to cloud.
public uploadVideo ( mixed $source, string $publicId = null, array $uploadOptions = [], array $tags = [] ) : CloudinaryWrapper
$source mixed
$publicId string
$uploadOptions array
$tags array
Résultat CloudinaryWrapper

usage() public méthode

Get usage details
public usage ( array $options = [] ) : array
$options array
Résultat array

Property Details

$cloudinary protected_oe property

Cloudinary lib.
protected Cloudinary $cloudinary
Résultat Cloudinary

$config protected_oe property

Repository config.
protected Repository,Illuminate\Config $config
Résultat Illuminate\Config\Repository

$uploadedResult protected_oe property

Uploaded result.
protected array $uploadedResult
Résultat array

$uploader protected_oe property

Cloudinary uploader.
protected Uploader,Cloudinary $uploader
Résultat Cloudinary\Uploader