PHP Класс JD\Cloudder\CloudinaryWrapper

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$cloudinary Cloudinary Cloudinary lib.
$config Illuminate\Config\Repository Repository config.
$uploadedResult array Uploaded result.
$uploader Cloudinary\Uploader Cloudinary uploader.

Открытые методы

Метод Описание
__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

Описание методов

__construct() публичный Метод

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
Результат void

addTag() публичный Метод

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

createArchive() публичный Метод

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

createTransformation() публичный Метод

Create transformation
public createTransformation ( string $name, string $definition, array $options = [] ) : array
$name string
$definition string
$options array
Результат array

createUploadMapping() публичный Метод

Create upload mapping
public createUploadMapping ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

createUploadPreset() публичный Метод

Create upload preset
public createUploadPreset ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

delete() публичный Метод

Alias of destroy.
public delete ( $publicId, $options = [] ) : array
Результат array

deleteAllResources() публичный Метод

Destroy all resources from Cloudinary
public deleteAllResources ( array $options = [] ) : null
$options array
Результат null

deleteDerivedResources() публичный Метод

Delete transformed images by IDs
public deleteDerivedResources ( array $publicIds = [], array $options = [] ) : null
$publicIds array
$options array
Результат null

deleteResources() публичный Метод

Destroy images from Cloudinary
public deleteResources ( array $publicIds, array $options = [] ) : null
$publicIds array
$options array
Результат null

deleteResourcesByPrefix() публичный Метод

Destroy a resource by its prefix
public deleteResourcesByPrefix ( string $prefix, array $options = [] ) : null
$prefix string
$options array
Результат null

deleteResourcesByTag() публичный Метод

Delete all resources from one tag
public deleteResourcesByTag ( string $tag, array $options = [] ) : null
$tag string
$options array
Результат null

deleteTransformation() публичный Метод

Delete single transformation
public deleteTransformation ( string $transformation, array $options = [] ) : array
$transformation string
$options array
Результат array

deleteUploadMapping() публичный Метод

Delete upload mapping
public deleteUploadMapping ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

deleteUploadPreset() публичный Метод

Delete upload preset
public deleteUploadPreset ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

destroy() публичный Метод

Destroy resource from Cloudinary
public destroy ( string $publicId, array $options = [] ) : array
$publicId string
$options array
Результат array

destroyImage() публичный Метод

Alias for destroy
public destroyImage ( string $publicId, array $options = [] ) : array
$publicId string
$options array
Результат array

destroyImages() публичный Метод

Alias for deleteResources
public destroyImages ( array $publicIds, array $options = [] ) : null
$publicIds array
$options array
Результат null

downloadArchiveUrl() публичный Метод

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

getApi() публичный Метод

Get cloudinary api
public getApi ( ) : Api
Результат Cloudinary\Api

getCloudinary() публичный Метод

Get cloudinary class.
public getCloudinary ( ) : Cloudinary
Результат Cloudinary

getPublicId() публичный Метод

Uploaded public ID.
public getPublicId ( ) : string
Результат string

getResult() публичный Метод

Uploaded result.
public getResult ( ) : array
Результат array

getUploader() публичный Метод

Get cloudinary uploader.
public getUploader ( ) : Uploader
Результат Cloudinary\Uploader

ping() публичный Метод

Ping cloudinary servers
public ping ( array $options = [] ) : array
$options array
Результат array

privateDownloadUrl() публичный Метод

Display private image
public privateDownloadUrl ( string $publicId, string $format, array $options = [] ) : string
$publicId string
$format string
$options array
Результат string

removeTag() публичный Метод

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

rename() публичный Метод

Rename public ID.
public rename ( string $publicId, string $toPublicId, array $options = [] ) : array
$publicId string
$toPublicId string
$options array
Результат array

replaceTag() публичный Метод

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

resource() публичный Метод

Display a resource
public resource ( string $publicId, array $options = [] ) : array
$publicId string
$options array
Результат array

resources() публичный Метод

Show Resources
public resources ( array $options = [] ) : array
$options array
Результат array

resourcesByIds() публичный Метод

Show Resources by id
public resourcesByIds ( array $options = [] ) : array
$options array
Результат array

resourcesByModeration() публичный Метод

Show Resources by moderation status
public resourcesByModeration ( string $kind, string $status, $options = [] ) : array
$kind string
$status string
Результат array

resourcesByTag() публичный Метод

Show Resources by tag name
public resourcesByTag ( string $tag, $options = [] ) : array
$tag string
Результат array

restore() публичный Метод

Restore a resource
public restore ( array $publicIds = [], array $options = [] ) : null
$publicIds array
$options array
Результат null

rootFolders() публичный Метод

List Root folders
public rootFolders ( array $options = [] ) : array
$options array
Результат array

secureShow() публичный Метод

Display resource through https.
public secureShow ( string $publicId, array $options = [] ) : string
$publicId string
$options array
Результат string

show() публичный Метод

Display resource through https.
public show ( string $publicId, array $options = [] ) : string
$publicId string
$options array
Результат string

showPrivateUrl() публичный Метод

Alias for privateDownloadUrl
public showPrivateUrl ( string $publicId, string $format, array $options = [] ) : string
$publicId string
$format string
$options array
Результат string

subfolders() публичный Метод

List subfolders
public subfolders ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

tags() публичный Метод

Display tags list
public tags ( array $options = [] ) : array
$options array
Результат array

transformation() публичный Метод

List single transformation
public transformation ( string $transformation, array $options = [] ) : array
$transformation string
$options array
Результат array

transformations() публичный Метод

List transformations
public transformations ( array $options = [] ) : array
$options array
Результат array

update() публичный Метод

Updates a resource
public update ( string $publicId, array $options = [] ) : array
$publicId string
$options array
Результат array

updateTransformation() публичный Метод

Update single transformation
public updateTransformation ( string $transformation, array $updates = [], array $options = [] ) : array
$transformation string
$updates array
$options array
Результат array

updateUploadMapping() публичный Метод

Update upload mapping
public updateUploadMapping ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

updateUploadPreset() публичный Метод

Update upload preset
public updateUploadPreset ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

upload() публичный Метод

Upload image to cloud.
public upload ( mixed $source, string $publicId = null, array $uploadOptions = [], array $tags = [] ) : CloudinaryWrapper
$source mixed
$publicId string
$uploadOptions array
$tags array
Результат CloudinaryWrapper

uploadMapping() публичный Метод

Get upload mapping
public uploadMapping ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

uploadMappings() публичный Метод

List Upload Mappings
public uploadMappings ( array $options = [] ) : array
$options array
Результат array

uploadPreset() публичный Метод

Get upload mapping
public uploadPreset ( string $name, array $options = [] ) : array
$name string
$options array
Результат array

uploadPresets() публичный Метод

List Upload Presets
public uploadPresets ( array $options = [] ) : array
$options array
Результат array

uploadVideo() публичный Метод

Upload video to cloud.
public uploadVideo ( mixed $source, string $publicId = null, array $uploadOptions = [], array $tags = [] ) : CloudinaryWrapper
$source mixed
$publicId string
$uploadOptions array
$tags array
Результат CloudinaryWrapper

usage() публичный Метод

Get usage details
public usage ( array $options = [] ) : array
$options array
Результат array

Описание свойств

$cloudinary защищенное свойство

Cloudinary lib.
protected Cloudinary $cloudinary
Результат Cloudinary

$config защищенное свойство

Repository config.
protected Repository,Illuminate\Config $config
Результат Illuminate\Config\Repository

$uploadedResult защищенное свойство

Uploaded result.
protected array $uploadedResult
Результат array

$uploader защищенное свойство

Cloudinary uploader.
protected Uploader,Cloudinary $uploader
Результат Cloudinary\Uploader