PHPackages                             saad/laravel-model-images - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. saad/laravel-model-images

ActiveLibrary[File & Storage](/categories/file-storage)

saad/laravel-model-images
=========================

This library will make it easy to save and upload model images

v1.1.4(3y ago)52241[1 issues](https://github.com/ahmad-sa3d/laravel-model-images/issues)MITPHP

Since May 31Pushed 3y ago2 watchersCompare

[ Source](https://github.com/ahmad-sa3d/laravel-model-images)[ Packagist](https://packagist.org/packages/saad/laravel-model-images)[ RSS](/packages/saad-laravel-model-images/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (3)Versions (8)Used By (0)

 [![](https://camo.githubusercontent.com/640c3d52b2764f179ef3cf089b604516a8c4ac0a06f055a46c6a7fce9428b787/68747470733a2f2f6c61726176656c2e636f6d2f6173736574732f696d672f636f6d706f6e656e74732f6c6f676f2d6c61726176656c2e737667)](https://camo.githubusercontent.com/640c3d52b2764f179ef3cf089b604516a8c4ac0a06f055a46c6a7fce9428b787/68747470733a2f2f6c61726176656c2e636f6d2f6173736574732f696d672f636f6d706f6e656e74732f6c6f676f2d6c61726176656c2e737667)

Model Images
============

[](#model-images)

[![License](https://camo.githubusercontent.com/f45d904953153ca304a2328243d2733e095eee13a631a1f390709885d41dd692/68747470733a2f2f706f7365722e707567782e6f72672f6c61726176656c2f6672616d65776f726b2f6c6963656e73652e737667)](https://packagist.org/packages/saad/json-response-builder)

 this package make saving (uploading or from storage) images with any set of dimensions and attachs them to you model is very easy just a few lines of code
 for any customizations also have the full control of saving process

### Dependencies

[](#dependencies)

this library uses two providers one of [intervention/image](https://github.com/Intervention/image) library and the other [saad/image](https://github.com/ahmad-sa3d/saad-image) (My Package) for image manipulation the default provider is my package (saad/image) but you can switch between them as you wish and also you can create your own driver if you wish and use it.

### Install

[](#install)

```
	composer require saad/laravel-model-images
```

Basic Usage
-----------

[](#basic-usage)

#### 1- Model Setup

[](#1--model-setup)

- assume we have a model like User model has a string field called `image`this field will contains his profile image

    all we need to do is in User Model File `User.php` we need to do:

    1. implement `Saad\ModelImages\Contracts\ImageableContract`
    2. use trait `Saad\ModelImages\Traits\HasImages`
    3. define image fields for this model via defining a static method `imageableFields()`which will return array of image fields for the model

```
// User.php File
class User extends Autheticatable implements ImageableContract
{
    use HasImages;

    public static function imageableFields() {
        return ['image'];
    }
}
```

#### 2- Store Images:

[](#2--store-images)

Now to set user profile image, assume in profile controller we have a method called `uploadUserProfile`responds to upload image request, and another method `setUserProfile` to set profile image from storage image file

```
// ProfilesController.php File
class ProfilesController
{
    // Save Image From Upload Request
    public function setUserProfile(Request $request, User $user) {
        // You can Validate
        $image = $request->file('image');
        if ($image) {
            $user->image = $image;
        }

        $user->save();
    }

    // Set Image from image file on storage
    public function setUserProfile() {
        $user = User::find(1);
        $user->image = storage_path('app/images/profile.png');
        $user->save();
    }
}
```

#### 3- Public link

[](#3--public-link)

OK, for now we stored our user profile image, so how we can get our user profile image public link
this is very easy just use `$user->getImagePublicLink()` it will get profile photo url
by default all images will be stored inside `public` directory in the following directory `images/uploads`

> this library uses the convention naming ***get`ImageField`PublicLink()***
> so if we have image field called `profile_photo` the method will be `getProfilePhotoPublicLink()`

### Customization

[](#customization)

---

#### 1- Multiple image sizes:

[](#1--multiple-image-sizes)

to set custom sizes like thumbnails or different dimensions for your uploaded images all you need is to define ***`imageField`ImageSizes()*** method on your model

```

// User.php File
class User extends Autheticatable implements ImageableContract
{
    use HasImages;
    ...
    public function imageImageSizes() {
        return [
            [512, 512], // Full size version
            [256, 256], // Thumbnail version
            [46, 46],   // Thumbnail version
        ];
    }
}

```

> **Get Public links**
> `$user->getImagePublicLink()` => for 512x512
> `$user->getImagePublicLink('256x256')` => for 256x256
> `$user->getImagePublicLink('46x46')` => for 46x46
>
> Or yo can use general method `getPublicLink($field)`
> `$user->getPublicLink('image')` => for 512x512
> `$user->getPublicLink('image', '256x256')` => for 256x256
> `$user->getPublicLink('image', '46x46')` => for 46x46

#### 2- Custom save directory:

[](#2--custom-save-directory)

to set custom save directory (within public folder) define method

> `imageGeneralSavePath()` this method will set save path for all model image fields
>
> ***image`FieldName`SavePath*** the naming convention used to set different paths for each field

```

// User.php File
class User extends Autheticatable implements ImageableContract
{
    use HasImages;
    ...
    // path for saving user profile images
    public function imageImageSavePath() :string
    {
        return 'images/users/profile';
    }

    // user model default saving directory for all model image fields if any
    public function imageGeneralSavePath() :string
    {
        return 'images/users';
    }
}

```

#### 3- Custom save options:

[](#3--custom-save-options)

you can control saving format, quality and png filters by defining those methods:

> `imageSaveExtension()` defines image format default `jpg`
> `imageSaveQuality()` defines image quality default `70` for `jpg`
>
> > for jpg quality will be from `0 to 100` `low to high` quality
> > for png quality will be from `0 to 9` `high to low` quality

> `imagePNGFilter()` defines png image filter default `PNG_NO_FILTER`

```

// User.php File
class User extends Autheticatable implements ImageableContract
{
    use HasImages;
    ...
    public function imageSaveExtension() :string
    {
        return 'png';
    }

    public function imageSaveQuality() :int
    {
        return 7;
    }

    public function imagePNGFilter() :int
    {
        return PNG_ALL_FILTERS;
    }
}

```

#### 4- Custom save provider:

[](#4--custom-save-provider)

this package shipped with two image manipulation providers:

> **Providers:**
> `SaadImageProvider` this is the default provider, it uses my image package `saad/image` for image manipulation process
> `InterventionImageProvider` provider for famous package `intervention/image` for image manipulation process

> **Define Custom Provider:**
> you can define your custom provider class by implementing this interface `Saad\ModelImages\Contracts\ImageProviderContract`

> **Change Provider**
> you can change driver be defining `imageSaveProvider()` method in your model, which should return the provider instance.

> **Note:**
>
> There are difference between how intervention and my image library handle resizing images when width and height are defined and differs from original aspect
>
> **saad/image** resize images to new dimensions by centering original image then resize and crop if necessary
>
> **intervention/image** will stretch image to new size or will preserve aspect so it will respect one dimension and auto set the other according to original aspect
>
> if this note is not clear, you can try both providers and see.

```

// User.php File
class User extends Autheticatable implements ImageableContract
{
    use HasImages;
    ...
    public function imageSaveProvider() :ImageProviderContract
    {
        return new InterventionImageProvider;
    }

}

```

#### 4- Default image:

[](#4--default-image)

Each model image field should have a default image, so consider the following cases:

> 1-`Record does not have image`when we try to get an image for a record which does not have an image attached yet
>
> 2- `Record has image but file deleted or not exists`when we try to get an image for a record but this image file is deleted or not exists

for these reasons we should define default image for each field, and this package will automatically return this default image if one of the previous cases happens

**To set Default Image:**defining a default image is the same process as attaching image to the model, the only difference is we tell the model that we are defining default image
by calling the static method `settingDefaultImage()` on the model ex: `User::settingDefaultImage()`
here we can see in action:

```
// ProfilesController.php File
class ProfilesController
{
    // Set image field default image
    public function setDefaultProfileImage() {
        // telling User model we are defining default image
        User::settingDefaultImage();

        // assign default image
        $user = new User;
        $user->image = storage_path('app/images/default_profile.png');
    }
}
```

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community5

Small or concentrated contributor base

Maturity68

Established project with proven stability

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~300 days

Recently: every ~450 days

Total

7

Last Release

1103d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7927d2c9296987c6329eeda722cee82eb4622cff56b2b628f6a698a05e9ddad1?d=identicon)[ahmad-sa3d](/maintainers/ahmad-sa3d)

---

Tags

laravelimagesphotosprofilegalleryinterventionimageablesaad

### Embed Badge

![Health badge](/badges/saad-laravel-model-images/health.svg)

```
[![Health](https://phpackages.com/badges/saad-laravel-model-images/health.svg)](https://phpackages.com/packages/saad-laravel-model-images)
```

###  Alternatives

[unisharp/laravel-filemanager

A file upload/editor intended for use with Laravel 5 to 10 and CKEditor / TinyMCE

2.2k3.3M74](/packages/unisharp-laravel-filemanager)[itskodinger/midia

Simple Media manager for your Laravel project

1415.8k](/packages/itskodinger-midia)[erlandmuchasaj/laravel-file-uploader

A simple package to help you easily upload files to your laravel project.

128.7k](/packages/erlandmuchasaj-laravel-file-uploader)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)