Download the PHP package cloudinary-labs/cloudinary-laravel without Composer

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.

Contents

• Usage
  • Upload, Retrieval, Transformation Method Calls
  • Attach Files to Laravel Eloquent Models
  • Upload Files Via An Upload Widget
  • Media Management Via The Command Line
• Installation
• Configuration
• Disclaimer
• Contributions
• License

Usage

Laravel versions 8 and below should use the v1.x.x.

Upload, Retrieval & Transformation Media Method Calls:

Upload a file (Image, Video or any type of File) to Cloudinary, retrieve and transform via any of the following ways:

Attach Files to Laravel Eloquent Models:

First, import the CloudinaryLabs\CloudinaryLaravel\MediaAlly trait into your Model like so:

Next, publish the package's migration file using this command:

Note: Once this has been published, run php artisan migrate to create the required table in your Database.

You can now attach media assets to your model like so:

Add Transformation to Uploads Using AttachMedia Method:

Upload Files Via An Upload Widget:

Use the x-cld-upload-button Blade upload button component that ships with this Package like so: `

Other Blade components you can use are:

To get the upload image link from the widget in your controller, simply set a route and controller action in your .env. For example:

Make sure to specify the full path to the controller. You should be able to get the URL like so:

Media Management via The Command Line:

Installation

PHP 7.2+, and Composer are required.

To get the latest version of Laravel Cloudinary, simply require it:

Or add the following line to the require block of your composer.json file.

Apps Using Laravel 9

Apps Using Laravel 8 and below

You'll then need to run composer install or composer update to download it and have the autoloader updated.

Once Laravel Cloudinary is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

Note: If you use Laravel >= 5.5 , you can skip this step (adding the code above to the providers key) and go to configuration

Also, register the Cloudinary Facade like so:

Note: If you use Laravel >= 9.0 , you can skip the step (adding the code above for registering the facade) and can just import it in whatever class you need it like so:

Configuration

You can publish the configuration file using this command:

A configuration file named cloudinary.php with some sensible defaults will be placed in your config directory:

API Keys

Open your .env file and add your API Environment variable, upload_preset (this is optional, until you need to use the widget) like so:

Note: You need to get these credentials from your Cloudinary Dashboard. The CLOUDINARY_URL is the API Environment variable shown in your Cloudinary Dashboard. Use the Copy button there to get the full URL

If you are using a hosting service like heroku, forge, digital ocean, etc, please ensure to add the above details to your configuration variables.

Cloudinary JS

Cloudinary relies on its own JavaScript library to initiate the Cloudinary Upload Widget. You can load the JavaScript library by placing the @cloudinaryJS directive right before your application layout's closing tag:

Note: ONLY LOAD THIS IF YOU HAVE DECIDED TO USE THE UPLOAD WIDGET. IF YOU ARE USING THIS PACKAGE FOR A LARAVEL API BACKEND, YOU DON'T NEED TO DO THIS!

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 from the community via PRs are welcome and will be fully credited. For details, see contributions.md.

License

The MIT License (MIT). Please see License File for more information.