cloudinary-labs / cloudinary-laravel
A Laravel Cloudinary Package
Installs: 758 491
Dependents: 2
Suggesters: 0
Security: 0
Stars: 291
Watchers: 14
Forks: 75
Open Issues: 0
Requires
- php: ^8.2
- ext-json: *
- cloudinary/cloudinary_php: ^3.0
- illuminate/support: ^11.0|^12.0
Requires (Dev)
- laravel/pint: ^1.20
- mockery/mockery: ^1.6
- orchestra/testbench: ^8.0|^9.0|^10.0
- pestphp/pest: ^2.35|^3.0
- phpspec/prophecy-phpunit: ^2.3
- sempro/phpunit-pretty-print: ^1.2
README
A Laravel Package for uploading, optimizing, transforming and delivering media files with Cloudinary. Furthermore, it provides a fluent and expressive API to easily attach your media files to Eloquent models.
Table of Contents
Installation
Requires PHP 8.2+ and Laravel 11+.
composer require cloudinary-labs/cloudinary-laravel
After you have installed the SDK, you can invoke the install command to set everything up:
php artisan cloudinary:install
Add your Cloudinary credentials to your .env file:
CLOUDINARY_URL=cloudinary://API_KEY:API_SECRET@CLOUD_NAME
CLOUDINARY_UPLOAD_PRESET=your_upload_preset
CLOUDINARY_NOTIFICATION_URL=
Note
You can get your CLOUDINARY_URL from your Cloudinary console. It typically looks like this: cloudinary://API_KEY:API_SECRET@CLOUD_NAME. Make sure to replace API_KEY, API_SECRET, and CLOUD_NAME with your actual Cloudinary credentials.
Usage
File Storage Driver
This SDK implements the File Storage Driver interface allowing you to use it as just another storage destination like s3, azure or local disk.
Add a new cloudinary key to your config/filesystems.php disk key like so:
..., 'cloudinary' => [ 'driver' => 'cloudinary', 'key' => env('CLOUDINARY_KEY'), 'secret' => env('CLOUDINARY_SECRET'), 'cloud' => env('CLOUDINARY_CLOUD_NAME'), 'url' => env('CLOUDINARY_URL'), 'secure' => (bool) env('CLOUDINARY_SECURE', true), 'prefix' => env('CLOUDINARY_PREFIX'), ], ...,
Blade Components
This package provides a few Blade components for easy integration of Cloudinary media in your Laravel views.
Upload Widget
You can use the <x-cloudinary::widget /> Blade component that ships with this like so:
<!DOCTYPE html> <html> <body> <x-cloudinary::widget>Upload Files</x-cloudinary::widget> </body> </html>
Image Component
Basic usage:
<x-cloudinary::image public-id="example" />
With additional properties:
<x-cloudinary::image public-id="example" width="300" height="300" />
Properties available:
| Property | Required |
|---|---|
public-id |
Yes |
width |
No |
height |
No |
alt |
No |
class |
No |
crop |
No |
gravity |
No |
effect |
No |
rotate |
No |
colorize |
No |
trim |
No |
blur |
No |
gray-scale |
No |
black-white |
No |
sepia |
No |
redeye |
No |
negate |
No |
oil-paint |
No |
vignette |
No |
simulate-colorblind |
No |
pixelate |
No |
unsharp-mask |
No |
saturation |
No |
contrast |
No |
brightness |
No |
gamma |
No |
improve-mode |
No |
shadow |
No |
border |
No |
round-corners |
No |
bg-color |
No |
art |
No |
cartoonify |
No |
Video Component
Basic usage:
<x-cloudinary::video public-id="example" />
With additional properties:
<x-cloudinary::video public-id="example" width="300" height="300" />
Properties available:
| Property | Required |
|---|---|
public-id |
Yes |
width |
No |
height |
No |
Disclaimer
This software/code provided under Cloudinary Labs is an unsupported pre-production prototype undergoing further development and provided on an “AS IS” basis without warranty of any kind, express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. Furthermore, Cloudinary is not under any obligation to provide a commercial version of the software.
Your use of the Software/code is at your sole risk and Cloudinary will not be liable for any direct, indirect, incidental, special, exemplary, consequential or similar damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of the Software, even if advised of the possibility of such damage.
You should refrain from uploading any confidential or personally identifiable information to the Software. All rights to and in the Software are and will remain at all times, owned by, or licensed to Cloudinary.
Contributions
Contributions are welcome! Please see CONTRIBUTING.md for details.
License
This package is open-sourced software licensed under the MIT license.