Cloudinary Blog

Associating Media Files With Laravel’s Eloquent Models

Associating Media Files With Laravel’s Eloquent Models

Laravel, currently the most popular PHP framework, offers databases an efficient, well-written Active Record implementation, called the Eloquent Object-Relational Mapper (ORM). Specifically, Eloquent maps a database table to an Eloquent model along with fluent methods and expressions for querying and modifying the database’s records.

Given that you as web developers routinely and frequently upload, download, and transform media files, being able to efficiently associate them with your Laravel Eloquent models saves time and resources. This tutorial describes that process, step by step, with code examples.

Set Up a Laravel Project

  1. Install Composer and PHP on your development or production machine and then run this command:

    Copy to clipboard
    composer create-project --prefer-dist laravel/laravel project
  2. Go to the project directory and rename the env.example file to .env.

  3. Run the project with the command php artisan serve.

Your Laravel project is now up and running.


Sign up for Cloudinary free today!


Set Up Cloudinary’s Laravel SDK

  1. Install Cloudinary’s Laravel SDK:

    Copy to clipboard
    composer require cloudinary-labs/cloudinary-laravel

    Note: Be sure to follow the steps in the #Installation section. Publish the configuration file and add your Cloudinary credentials to the .env file of your app.

  2. Publish the migration file in Cloudinary’s Laravel SDK with this command:

    Copy to clipboard
    php artisan vendor:publish --provider="CloudinaryLabs\CloudinaryLaravel\CloudinaryServiceProvider" --tag="cloudinary-laravel-migration"
  3. Run php artisan migrate to create the required media table in your database. Verify that the table is in place afterwards.

    Before uploading files to Cloudinary, sign up for a free Cloudinary account, log in, and note your cloud name and API keys from the dashboard.

media library

Set Up the Mechanics for Attaching Media

Follow the two steps below to attach media to a webpage, which can accept as many as you desire as thumbnails or as files. Follow these two steps:

  1. Create with Laravel migrations a pages table with two fields, id and body, in your database.

  2. Create the Page model that maps to the pages database table:

Copy to clipboard
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Page extends Model
{

    /**
    * The table associated with the model.
    *
    * @var string
    */
    protected $table = 'pages';
}

Set Up the Mechanics for Attaching Files to Laravel Eloquent Models

Next, import the CloudinaryLabs\CloudinaryLaravel\MediaAlly trait into your model so that you can attach media files to the Eloquent model:

Copy to clipboard
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use CloudinaryLabs\CloudinaryLaravel\MediaAlly;

class Page extends Model
{
    use MediaAlly;

    ...
}

App\Models\Page.php

Attach, Retrieve, Or Delete Media Files

You can now attach media files to the Page model in your Laravel controller. Below are three use cases. The first two assume that you’re uploading the files as attachments for the first time

First Use Case

Create a page and then attach files to it:

Copy to clipboard
...
$page = Page::create($this->request->input());
$page->attachMedia($file);   // Example of $file is $request->file('file');
...

To verify, check the media table in your database for a new record that looks like this:

media table

Second Use Case

Fetch an existing page and attach media files to it:

Copy to clipboard
...
$page = Page::find(2);
$page->attachMedia($file);   // Example of $file is $request->file('file');
...

Third Use Case

In this instance, you’ve already uploaded to Cloudinary or another cloud storage the media files to be attached to a page. Call the attachRemoteMedia method:

Copy to clipboard
...
$page = Page::create($this->request->input());
$page->attachRemoteMedia($existingRemoteUrl); 
...
Copy to clipboard
...
$page = Page::find(2);
$page->attachRemoteMedia($existingRemoteUrl);  
...

File Retrieval

You can retrieve all the files you’ve attached to the Page record, or just the first or last file.

To retrieve all the files that are attached to the Page record:

Copy to clipboard
...
$filesBelongingToSecondPage = Page::find(2)->fetchAllMedia();
...

To retrieve the first file that’s attached to the Page record:

Copy to clipboard
...
$fileBelongingToSecondPage = Page::find(2)->fetchFirstMedia();
...

To retrieve the last file that’s attached to the Page record:

Copy to clipboard
...
$fileBelongingToSecondPage = Page::find(2)->fetchLastMedia();
...

File Deletion

To delete all the files you’ve attached to the Page record:

Copy to clipboard
...
$page = Page::find(2);
$page->detachMedia();
...

Leverage More Cloudinary Capabilities

Uploading and attaching files barely scratches the surface of media management. Cloudinary helps you administer the entire spectrum of your media’s lifecycle, end to end, from upload and transformation to optimization and delivery. Do check it out.

Want to Learn More About Laravel?

Recent Blog Posts

Five Ways to Effectively Manage Online Media

The digital economy is driven by highly visual experiences. After all, viewers process images 60,000 times faster than text. Therefore, it’s no surprise that top-notch visual media has been an essential component of a captivating e-commerce experience for years. Nor is it surprising that visual media’s importance only rose during the COVID-19 pandemic, a reality for all retailers, including our client Levi’s.

Read more
Creating an API With Python Flask to Upload Files to Cloudinary

Code

Cloudinary offers SDKs for many programming languages and frameworks. Even though it also offers an Upload API endpoint for both back-end and front-end code, most developers find the SDKs very helpful. If you're working with a powerful back-end framework like Python Flask, you'll be happy to hear that a Python SDK is now available.
This tutorial walks you through the process of building an API to upload images to Cloudinary. You can also upload other file types, including video and even nonmedia files, with the API.

Read more
How to Use the Cloudinary Media Editor Widget

At Cloudinary, we manage the entire pipeline of media assets for thousands of customers of varying sizes from numerous verticals.

As part of our commitment to support the entire flow of media assets, we are now introducing an intuitive media editing widget: an out­-of­-the-­box, interactive UI providing your users with a set of common image editing actions for immediate use on your website or web app. The widget is interactive and simple, built on Cloudinary's transformation capabilities, and requiring only a few lines of code to integrate. Afterwards, you can seamlessly and effortlessly add content to your site or app with no need for in-house image editing capabilities.

Read more
Shoppable Video Is Becoming Popular in E-Commerce

As pandemic restrictions necessitated, many shopping trips in 2020 took place outside the traditional brick-and-mortar store, or at least void of the physical aisle-browsing experience. Same-day curbside pickup became a safe and convenient alternative, and e-commerce transactions skyrocketed as consumers shopped online. In fact, Digital Commerce 360 estimates that, compared to 2019, e-commerce transactions grew by more than 40% last year.

Read more
Enhance Your Travel Site With Cloudinary in Anticipation of a Return to New Normal

Read more