PHPackages                             jvizcaya/uploadable - 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. [Database & ORM](/categories/database)
4. /
5. jvizcaya/uploadable

ActiveLibrary[Database & ORM](/categories/database)

jvizcaya/uploadable
===================

Laravel Eloquent trait for storage base64 encoded data

v0.1.3(4y ago)0240MITPHPPHP ^7.1.3|^8.0

Since May 27Pushed 4y ago1 watchersCompare

[ Source](https://github.com/jvizcaya/uploadable)[ Packagist](https://packagist.org/packages/jvizcaya/uploadable)[ RSS](/packages/jvizcaya-uploadable/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (10)Dependencies (1)Versions (14)Used By (0)

Uploadable (Laravel Eloquent trait for storage base64 encoded data)
===================================================================

[](#uploadable-laravel-eloquent-trait-for-storage-base64-encoded-data)

**Uploadable** Es un trait para Laravel 5.7+ que agrega funcionalidades de almacenamiento de archivos a nuestros modelos, cuando trabajamos con datos previamente **codificados en base64**.

Al estar relacionado con el modelo, solo debemos especificar la columna en la tabla (base de dato) en el cual deseamos que se guarde el nombre del archivo almacenado en disco.

**La columna donde se guarda el nombre del archivo debe permitir contener valores nulos ya que la funciones del trait actúan luego de los métodos save() o update() del modelo.**

Instalación
-----------

[](#instalación)

```
composer require jvizcaya/uploadable

```

Modo de uso
-----------

[](#modo-de-uso)

Agrega el **Trait** `Jvizcaya\Uploadable\UploadableTrait`al modelo y configura la variable `protected $uploadable` con las reglas de almacenamiento.

```
namespace App;

use Illuminate\Database\Eloquent\Model;
use Jvizcaya\Uploadable\UploadableTrait;

class Post extends Model
{
    use UploadableTrait;
    /**
     * Uploadable rules.
     *
     * @var array
     */
     protected $uploadable = [
       'image' => ['folder' => 'posts']
     ];
}
```

En el ejemplo anterior hemos definido que el archivo se almacenara en la carpeta `posts` y el nombre del archivo en disco se guardara en tabla en la columna `image`.

Luego de agregar el trait al modelo y configurar correctamente la variable `protected $uploadable` podemos hacer uso de las funcion de almacenamiento `storageFile()`.

```
namespace App\Http\Controllers;

use App\Post;

class PostController extends Controller
{
    public function store(Request $request)
    {
        $post = new Post($request->all());
        $post->save();

        $post->storageFile($request->image);
    }
}
```

En el ejemplo anterior `$request->image` es un archivo de imagen codificado en base64 que hemos pasado al controlador desde la vista.

> **storageFile()** Hace uso del paquete [intervention/image](https://github.com/Intervention/image) para el almacenamiento de archivos de imágenes, asegúrese que el sistema cumpla con los requerimientos de este paquete.

### Columna de la tabla

[](#columna-de-la-tabla)

Por defecto se tomara el primer elemento del array de la variable `$uploadable` como el criterio sobre aplicar las reglas de almacenamiento, podemos especificar la columna de manera dinamica, pasándola como el segundo parámetro (**Útil si tenemos varios campos de almacenamiento en la misma tabla y por tal motivo diferentes reglas**).

```
$post->storageFile($request->image, 'image');
```

### Nombre de archivo

[](#nombre-de-archivo)

Podemos hacer que el nombre del archivo sea tomado automaticamente desde otra de las columnas del modelo, configurando la regla `name_column`.

```
  use UploadableTrait;
  /**
   * Uploadable rules.
   *
   * @var array
   */
   protected $uploadable = [
     'image' => [
         'folder' => 'posts',
         'name_column' => 'title'
       ]
   ];
```

En el ejemplo anterior el archivo se almacenara con el valor contenido en la columna `title` del modelo.

También podemos especificar el nombre del archivo, enviándolo como el tercer parámetro de la función **storageFile()**.

```
$post->storageFile($request->image, 'image', 'file name');
```

En ambos casos el nombre especificado sera formateado, por ejemplo `nombre de archivo` sera cambiado a `nombre_de_archivo`.

Si no se especifica el nombre del archivo empleando algunos de los métodos anteriores tomara el valor por defecto el cual es la fecha de almacenamiento en formato `YmdHi`.

### Nombre de carpeta

[](#nombre-de-carpeta)

El nombre de la carpeta en el cual se almacenara el archivo en disco se debe especificar en la regla `folder` (ver ejemplos), pero si se desea pasar el nombre de la carpeta de almacenamiento de manera dinámica, podemos pasarla como el cuarto parámetro de la función `storageFile()`.

```
$post->storageFile($request->image, 'image', 'file name', 'folder_name');
```

### Thumbnails

[](#thumbnails)

Cuando el archivo que deseamos almacenar **es una imagen** podemos generar miniaturas o replicas en varios tamaños, para esto debemos simplemente configurar la regla `thumbnail` en la variable `$uploadable`.

```
  use UploadableTrait;
  /**
   * Uploadable rules.
   *
   * @var array
   */
   protected $uploadable = [
     'image' => [
         'folder' => 'posts',
         'name_column' => 'title',
         'thumbnail' => ['folder' => 'posts/thumbnails', 'size' => [150, 100]],
        ]
   ];
```

En el ejemplo anterior hemos especificado, que se deberá generar una replica (miniatura) de nuestro archivo de imagen al momento de ser almacenado.

Esta imagen deberá ser guardada en la carpeta `thumbnails` dentro de `posts`, y se guardara con una dimensión de 150px de ancho y 100px de altura.

Si no se especifica la regla `size` para `thumbnails`, la imagen se guardara por defecto con las dimensiones de 150px de ancho y 150px de altura.

### Multiples Thumbnails

[](#multiples-thumbnails)

En ocasiones deseamos generar múltiples archivos de diferentes tamaños, para este caso basta con agrupar cada regla para cada imagen que deseamos generar como un elemento dentro del array para la regla `thumbnail` de la siguiente manera:

```
  use UploadableTrait;
  /**
   * Uploadable rules.
   *
   * @var array
   */
   protected $uploadable = [
     'image' => [
         'folder' => 'posts',
         'name_column' => 'title',
         'thumbnail' => [
           ['folder' => 'posts/150', 'size' => [150, 100]],
           ['folder' => 'posts/400', 'size' => [400, 300]]
         ],
        ]
   ];
```

En el ejemplo anterior se crearan dos imágenes, en los directorios `posts/150` y `posts/400` respectivamente.

### Nombre de disco (Fylesystem)

[](#nombre-de-disco-fylesystem)

**Uploadable** hace uso del sistema de almacenamiento de Laravel ([File Storage](https://laravel.com/docs/5.8/filesystem)), por lo tanto se espera que los directorios esten ubicados en `storage/app`.

Por defecto el disco utilizado es `public`, si deseamos configurar el uso de otro disco podemos hacerlo especificando la regla `disk` de esta manera:

```
  use UploadableTrait;
  /**
   * Uploadable rules.
   *
   * @var array
   */
   protected $uploadable = [
      'image' => [
         'folder' => 'posts',
         'name_column' => 'title',
         'thumbnail' => [
           ['folder' => 'posts/150', 'size' => [150, 100]],
           ['folder' => 'posts/400', 'size' => [400, 300]]
         ],
         'disk' => 'public'
      ],
      'photo' => [
          'folder' => 'photos',
          'name_column' => 'title',
          'disk' => 'local'
      ]
   ];
```

Actualmente solo se garantiza compatibilidad con el uso de discos locales, no se ha probado haciendo uso de `s3` u otros métodos en la nube.

Borrar archivos
---------------

[](#borrar-archivos)

Para borrar los archivos almacenados asociados al modelo, podemos emplear la función `deleteAllFiles()`, esta función recorrerá cada una de las entradas en la variable `$uploadable` y eliminara cada archivo del disco.

Para que funcione correctamente cada regla deberá estar especificada correctamente, sobretodo la regla para el valor `folder`.

```
$post->deleteAllFiles();
```

Si no se puede emplear el método anterior o si desea eliminar un archivo en especifico podemos hacer uso del metodo `deleteFile()`, este método acepta como parámetro el nombre de la columna a borrar.

```
$post->deleteFile('photo');
```

`deleteFile()`, También acepta de manera opcional como segundo parámetro el nombre de la carpeta donde esta ubicado el archivo.

```
$post->deleteFile('photo', 'photos');
```

**Nota:** Cuando se emplea `deleteAllFiles()`, o `deleteFile()`, Si el archivo borrado es una imagen, y este tiene configurado la regla `thumbnail`, se eliminaran tambien las imágenes generadas como miniaturas.

Este paquete tiene como consideración que las funciones `deleteAllFiles()`y `deleteFile()`sean ejecutadas luego que el modelo asociado sea eliminado. Por lo tanto no realiza una limpieza en la columna de la base de datos.

Si se desea eliminar una imagen sin que sea eliminado el modelo, podemos enviar el parametro `nullColumn` como **true**. Este parámetro le indicará a las funciones de borrados de imágenes que deberan limpiar la columna en la tabla de la base de datos.

```
$post->deleteAllFiles(true);

$post->deleteFile('photo', 'photos', true);
```

**Nota:** El parámetro nullColumn no puede ser enviado, si el modelo asociado es previamente eliminado. Debe ser utilizado en los casos de una actualización del modelo o si se trata de un borrado suave [softDelete](https://laravel.com/docs/8.x/eloquent#soft-deleting).

Alternativamente Podemos eliminar el archivo previamente guardado en la misma función de almacenamiento `storageFileFile`, para ello en lugar de enviar el archivo codificado en base64 como primer parámetro, enviamos una cadena con el valor de `delete_file`. Esta funcionalidad deberá ser utilizada solo en los casos que estemos actualizando el modelo asociado. **Nota:** Esta funcionalidad automáticamente limpiara el valor en la columna en la tabla de la base de datos.

Mover Archivos (Beta)
---------------------

[](#mover-archivos-beta)

Si se desea cambiar la ubicación de un archivo almacenado dentro del sistema de almacenamiento del Framework (FyleSystem), podemos hacer uso de la función `moveFile()`, esta opción deberá tener como parámetro el nombre del directorio de la nueva ubicación.

```
$post->moveFile('images');
```

También podemos pasar como segundo parámetro el nombre de la columna, y como tercer parámetro el nombre de la carpeta donde esta ubicado actualmente el archivo que sera trasladado de ubicación.

```
$post->moveFile('images', 'image', 'posts');
```

### Notas

[](#notas)

Actualmente la función `storageFile()` tiene soporte para los siguientes tipos de archivos según su **MIME**, los cuales ya han sido probados, se agregaran mas tipos de archivos según se vayan probando su estabilidad al momento de usarlos.

Tipo MIMEapplication/pdfapplication/jsonimage/gifimage/jpegimage/pngimage/webpimage/x-iconvideo/mp4video/mpeg---

License
-------

[](#license)

[MIT](LICENSE) © Jorge Vizcaya |

###  Health Score

29

—

LowBetter than 57% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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 ~79 days

Recently: every ~133 days

Total

13

Last Release

1624d ago

PHP version history (2 changes)v0.0.1PHP ^7.1.3

v0.1.3PHP ^7.1.3|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/f01b29b53f6763c88249f798602845af303401316a0922a5fea86ce58bcf90b1?d=identicon)[jvizcaya](/maintainers/jvizcaya)

---

Top Contributors

[![jvizcaya](https://avatars.githubusercontent.com/u/15002352?v=4)](https://github.com/jvizcaya "jvizcaya (17 commits)")

---

Tags

base64eloquentlaravelstoragetraitlaraveldatabasebase64modeleloquentupload

### Embed Badge

![Health badge](/badges/jvizcaya-uploadable/health.svg)

```
[![Health](https://phpackages.com/badges/jvizcaya-uploadable/health.svg)](https://phpackages.com/packages/jvizcaya-uploadable)
```

PHPackages © 2026

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