level51 / silverstripe-cloudinary
Cloudinary image handling & upload field for SilverStripe
Installs: 1 246
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 4
Forks: 5
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- php: >=8.0
- ext-json: *
- cloudinary/cloudinary_php: ^2
- nesbot/carbon: ^2
- silverstripe/framework: ^5
README
Adds a Level51\Cloudinary\Image data object and an appropriate uploader using Cloudinary's javascript upload widget.
Install
composer require level51/silverstripe-cloudinary
Setup
You have to define some mandatory configuration to get started:
Level51\Cloudinary\Cloudinary: cloud_name: String, mandatory api_key: String, mandatory api_secret: String, mandatory upload_preset: String, mandatory if unsigned, optional if signed # https://cloudinary.com/documentation/upload_widget#look_and_feel_customization theme: default 'white', # https://cloudinary.com/documentation/upload_widget#signed_uploads use_signed: true # https://cloudinary.com/documentation/admin_api#delete_all_or_selected_resources image_type: 'private' # Whether to show/hide the remove button show_remove: false # Whether to append the g_custom option or not use_custom_gravity: true # Allowed file extensions, optional, defaults to ['png', 'gif', 'jpeg'] # Note that the extensions can also be limited per instance using `setAllowedExtensions` allowed_extensions: ['png', 'gif', 'jpeg']
Usage
private static $has_one = [ 'Image' => \Level51\Cloudinary\Image::class ]; private static $has_many = [ 'Images' => Image::class ]; public function getCMSFields() { $fields = parent::getCMSFields(); $fields->addFieldsToTab( 'Root.Main', [ \Level51\Cloudinary\UploadField::create('Image', $this->fieldLabel('Image')), // ->setRatio(16 / 9) // ->disableCropping() // ->setFolderName('path/to/destination') // ->setAllowedExtensions(['jpg']) \Level51\Cloudinary\MultiUploadField::create('Images', $this->fieldLabel('Images')) // ->setAllowedMaxFileNumber(5) ] ); return $fields; }
// In templates $Image // With transormations $Image.FillMax(1920,1080) // With effect filters $Image.Grayscale.FillMax(1920,1080)
Checkout the available transformations and effects in the \Level51\Cloudinary\Image class.
Features
- UploadField using the javascript upload widget - so direct uploads to Cloudinary
- Store the relevant information in a Level51\Cloudinary\Image object
Extend
If you need any further fields just extend the Level51\Cloudinary\Image class with a data extension. To inject information returned by Cloudinary during the upload create another extension for the Level51\Cloudinary\UploadController and use one of the two extensions hooks onBeforeImageCreated or onAfterImageCreated. Both get passed the image object, either before or after the first write.
Maintainer
- Daniel Kliemsch dk@lvl51.de