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.

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

Our $2B Valuation

By
Blackstone Growth Invests in Cloudinary

When we started our journey in 2012, we were looking to improve our lives as developers by making it easier for us to handle the arduous tasks of handling images and videos in our code. That initial line of developer code has evolved into a full suite of media experience solutions driven by a mission that gradually revealed itself over the course of the past 10 years: help companies unleash the full potential of their media to create the most engaging visual experiences.

Read more
Direct-to-Consumer E-Commerce Requires Compelling Visual Experiences

When brands like you adopt a direct–to-consumer (DTC) e-commerce approach with no involvement of retailers or marketplaces, you gain direct and timely insight into evolving shopping behaviors. Accordingly, you can accommodate shoppers’ preferences by continually adjusting your product offering and interspersing the shopping journey with moments of excitement and intrigue. Opportunities abound for you to cultivate engaging customer relationships.

Read more
Automatically Translating Videos for an International Audience

No matter your business focus—public service, B2B integration, recruitment—multimedia, in particular video, is remarkably effective in communicating with the audience. Before, making video accessible to diverse viewers involved tasks galore, such as eliciting the service of production studios to manually dub, transcribe, and add subtitles. Those operations were costly and slow, especially for globally destined content.

Read more
Cloudinary Helps Minted Manage Its Image-Generation Pipeline at Scale

Shoppers return time and again to Minted’s global online community of independent artists and designers because they know they can count on unique, statement-making products of the highest quality there. Concurrently, the visual imagery on Minted.com must do justice to the designs into which the creators have poured their hearts and souls. For Minted’s VP of Engineering David Lien, “Because we are a premium brand, we need to ensure that every single one of our product images matches the selected configuration exactly. For example, if you pick an 18x24 art print on blue canvas, we will show that exact combination on the hero images in the PDF.”

Read more
Highlights on ImageCon 2021 and a Preview of ImageCon 2022

New year, same trend! Visual media will continue to play a monumental role in driving online conversions. To keep up with visual-experience trends and best practices, Cloudinary holds an annual conference called ImageCon, a one-of-a-kind event that helps attendees create the most engaging visual experiences possible.

Read more