ahmed-aliraqi/eloquent-media

Associate files to your eloquent models

eloquent-media

, _(*1)

A php trait that's provides an easy way to associate images and/or files for your laravel eloquent models., _(*2)

Installation

composer require ahmed-aliraqi/eloquent-media

Configration

In your config/filesystems.php file confiure disks.local key to match your prefered upload path., _(*3)

'local' => [
    'driver' => 'local',
    'root' => public_path('uploads'),
],

Usage

namespace App;

use Illuminate\Database\Eloquent\Model;
use Aliraqi\Traits\HasFiles;

class Post extends Model
{
    use HasFiles;


    //...
}

API

putFile

Method Definition:, _(*4)

/**
   * Upload given file to this model instance.
   *
   * @param  string  $key
   * @param  string  $name
   * @param  array   $options
   * @return string  File path
   */
  $model->putFile($key, [$name, $options]);
  

NOTE: the uploaded file will be saved in the configured path in filesystems.php file., _(*5)

For example $user->putFile('avatar'); will save the uploaded file avatar and save it in public/uploads/users/USER_ID/avatar.EXT where USER_ID is the user id and EXT is the uploaded file extension., _(*6)

NOTE: if you use primary key other than $id it will be used automatically instead of $id., _(*7)

file

Method Definition:, _(*8)

/**
   * Get link of given file name that belongs to this model instance.
   *
   * @param  string $name
   * @param  string $fallback
   * @return string
   */
  $model->file([$name, $fallback]);
  

NOTE: get the link of uploaded file ., _(*9)

For example $user->file('avatar'); will get link of the uploaded file avatar http://localhost:8000/uploads/users/USER_ID/avatar.ext where USER_ID is the user id., _(*10)

putFiles

Method Definition:, _(*11)

/**
   * Upload given files to this model instance.
   *
   * @param  string  $key
   * @param  string  $name
   * @param  boolean  $delete
   * @param  array  $options
   * @return string  File path
   */
  $model->putFiles($key, [$name, $delete, $options]);
  

NOTE: the multiple uploaded files will be saved in the configured path in filesystems.php file., _(*12)

For example $user->putFiles('avatars'); will save the uploaded file avatars and save it in >public/uploads/users/USER_ID/avatars/583ac3d5a0135.ext where USER_ID is the user id., _(*13)

files

Method Definition:, _(*14)

/**
  * Get array of given files name that belongs to this model instance.
  *
  * @param  string $name  name of folder
  * @return Illuminate\Support\Collection
  */
  public function files($name)
  

NOTE: get the link of uploaded file ., _(*15)

For example $user->files('avatars'); will get array collection for pathes and >links of the uploaded files avatars For example :, _(*16)

@foreach($user->files('avatar') as $path => $link)
 file path : {{ $path }} <br>
 File link : {{ $link }}
@endforeach

filePath

Method Definition:, _(*17)

/**
   * Get path of given file name that belongs to this model instance.
   *
   * @param  string $name
   * @return string | null
   */
  public function filePath([$name])
  

hasGlobal

Method Definition:, _(*18)

/**
   * Determine if the assiciated files is global or not.
   *
   * @param  boolean $value
   * @return Illuminate\Database\Eloquent\Model
   */
  public function hasGlobal([$value = true])
  

For example:, _(*19)

$user->hasGlobal()->putFile('default');
  

the file will save in public/uploads/users/default.png, _(*20)

{{ $user-hasGlobal()->file('default') }}
  

disk

Method Definition:, _(*21)

/**
   * Determine a filesystem instance.
   *
   * @param  string  $name
   * @return Illuminate\Database\Eloquent\Model
   */
  public function disk([$name = 'local'])
  

For example:, _(*22)

$user->disk('public')->putFile('photo');
  

blade {{ $user->disk('public')->file('photo') }}, _(*23)

Fallback images.

If you want to return fallback image if given image not found you must create config/fallbackimages.php file and put the name of model table and set fallback image like this :, _(*24)

<?php
return [
    // Get users fallback image url.
    'users' => 'http://lorempixel.com/grey/800/400/cats/Faker/',

    // Get posts fallback image url.
    'posts' => 'http://lorempixel.com/grey/800/400/cats/Faker/',

    // If You do not run application using artisan serve.
    'remove_public_from_url' => false,
];