PHPackages                             mcris112/file-manager-system - 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. mcris112/file-manager-system

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

mcris112/file-manager-system
============================

Laravel Package for File System Manager, administrate and get the disk

v1.1.0(1y ago)022MITPHPPHP ^8.1

Since Apr 19Pushed 1y ago1 watchersCompare

[ Source](https://github.com/MCris112/laravel-file-system-manager)[ Packagist](https://packagist.org/packages/mcris112/file-manager-system)[ RSS](/packages/mcris112-file-manager-system/feed)WikiDiscussions master Synced today

READMEChangelog (4)Dependencies (1)Versions (5)Used By (0)

LARAVEL FILE SYSTEM MANAGER
===========================

[](#laravel-file-system-manager)

---

**Laravel File System Manager** is a project to upload/view files and retrieve as resource to show it into your frontend file manager interface `If u have some recommendations, please do.`

- **Author**: MCris112
- **Vendor**: mcris112
- **Package**: laravel-file-system-manager
- **Version**: `1.x`
- **PHP Version**: 8.1+
- **Laravel Version**: `10.x`

Table of Contents
=================

[](#table-of-contents)

---

1. [Installation](#installation)
    - [Configuration](#configuration)
2. [Getting Started](#getting-started)
    1. [Save a file](#save-a-file)
    2. [Use a different disk manager](#use-a-different-disk-manager)
3. [Functions](#functions)
    1. [Url](#url)
    2. [Manage Size](#manage-size)
    3. [Content](#content)
    4. [From Base 64](#from-base-64)
    5. [Collection](#collection)
4. [Traits](#traits)
    - [Resource](#resource)
        - [Customize FmFile resource transformation](#customize-resource-transformation)
    - [Has an Image](#has-an-image)
    - [Has image variations](#has-image-variations)
    - [FmPagination](#fmpagination)
5. [Category](#category)
    1. [Folder](#folder)
        - [Create Folder](#create-folder)
        - [Content](#folder-content)
        - [Search Folders](#search-folders)
        - [Find a Folder](#find-a-folder)
        - [Folder Parent](#folder-parent)
        - [Put into Folder](#put-into-folder)
        - [Delete folder or content](#delete-folder-or-content)
    2. [File](#file)
        1. [Search files](#search-files)
        2. [Find a file](#find-a-file)
    3. [Avatar](#avatar)
        1. [Before use](#before-use)
        2. [Used](#used)
        3. [Url](#avatar-url)
        4. [Create Avatar](#create-avatar)

Installation
============

[](#installation)

Install the package with the command **[Composer](https://getcomposer.org/):**

```
composer require mcris112/laravel-file-system-manager
```

Configuration
-------------

[](#configuration)

Publish the config file

```
php artisan vendor:publish --tag="filesystemmanager.config"
```

Add/delete the disk driver size that you will use

```
return [
    "storage" => [
        /********************************
         *
         * Define here what storage disk drivers should be supported
         * and the storage size has each driver
         *
         */
        'size' => [
            "local" => env('FM_STORAGE_LOCAL_SIZE', "1GB"),
            "public" => env('FM_STORAGE_PUBLIC_SIZE', "1GB"),
            //"s3" => env('FM_STORAGE_S3_SIZE', 0),
        ],
    ],

    /********************************
     *
     *  This is required to get authenticated user at StorageController
     *  to check if the user can view the file
     *
     */
    'auth' => [
        'user' => fn() => auth()->user() // ?? auth('api)->user()
    ],
```

At Users model, need to add `CanViewFmFilePrivate`, this is necessary for check if user can view the current file selected on route `'.../storage/{disk}/{path}'`

```
use MCris112\FileSystemManager\Traits\CanViewFmFilePrivate;

class User extends Authenticatable
{
    use CanViewFmFilePrivate;

    //...
}
```

Getting Started
===============

[](#getting-started)

Save a file
-----------

[](#save-a-file)

```
use MCris112\FileSystemManager\Facades\FileSystemManager;

FileSystemManager::file()->save(
    $request->file('content'),
    true, //is Public?
    1,¨// created by id (Comes from user id)
    'test/', // folder where it will be saved
    null, // name - If name is not set, It will take filename of file
    function (FmFileContent $data, FmFile $model){ // Do something after save, this can be null
        // Do something
    }
);

// This return a FmFile model
$model = FileSystemManager::file()->save(...);
```

Use a different disk manager
----------------------------

[](#use-a-different-disk-manager)

Just use the static function disk to change

```
$model = FileSystemManager::disk('s3')->file()->save(...);
```

Functions
=========

[](#functions)

Url
---

[](#url)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;
use \MCris112\FileSystemManager\Models\FmFile;

// Get URL by model
$url = FileSystemManager::url( FmFile::first() );

// Get by path
$url = FileSystemManager::url( "documents/your-filename.jpg" );
```

Manage Size
-----------

[](#manage-size)

Get global information that is set into config and content saved

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

// Retrieve the size used in kilobytes
$size = FileSystemManager::used();

// All size allowed
$size = FileSystemManager::size();

// How much space is left
$size = FileSystemManager::left();
```

Get information by specific type of content

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

// Get how much storage file is using
$size = FileSystemManager::file()->used();

// Get how much storage Avatar is using
$size = FileSystemManager::avatar()->used();
```

Content
-------

[](#content)

Get this to show it into your file manager interface. Get a paginated list of files models that doesn't have a directory as parent

```
$list = FileSystemManager::content();

$load = 15;
// Can search by specific records - Returns CollectionsFmFileCollection
$list = FileSystemManager::list(
    $load // -> How many files will get in paginated list
);
```

From Base 64
------------

[](#from-base-64)

Convert a base64 encoded into a UploadedFile

```
/** @var Illuminate\Http\UploadedFile $list */
$list = FileSystemManager::fromBase64("base64...");
```

Collection
----------

[](#collection)

When you get a collection of files models, It has a function to use

```
use \MCris112\FileSystemManager\Models\FmFile;
use \MCris112\FileSystemManager\Collections\FmFileCollection;

/** @var FmFileCollection $models */
$models = FmFile::get();

// You can use
$models->toResource(); // This will return a FmFileListResource::collection()
```

Traits
======

[](#traits)

Resource
--------

[](#resource)

Convert relation at resource to frontend response. Use the trait `ResourceFmImageVariationTransformation` to use the function `$this->fmImageVariation()`

```
use MCris112\FileSystemManager\Traits\Resource\ResourceFmImageVariationTransformation;

class ProductResource extends JsonResource
{
    use ResourceFmImageVariationTransformation;

    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
            "name" => $this->name,

            // This function converts the normal relation into a complex array
            'image' => $this->fmImageVariation(),

            "timestamps" => [
                "createdAt" => $this->created_at,
                "updatedAt" => $this->updated_at,
            ]
        ];
    }

}
```

#### Before

[](#before)

```
{
    "id": 1,
    "name": "Aspernatur voluptas non illum. Ut sit suscipit explicabo.",
    "image": [
        {
            "id": 32,
            "filename": "..."
            //....
            "pivot": {
                //...
                "field": "full"
            }
        },
        {
            "id": 33,
            "filename": "..."
            //....
            "pivot": {
                //...
                "field": "thumbnail"
            }
        }
    ],
    "timestamps": {
        "createdAt": "2024-04-13T17:33:41.000000Z",
        "updatedAt": "2024-04-13T17:33:41.000000Z"
    }
}
```

#### After

[](#after)

```
{
    "id": 1,
    "name": "Aspernatur voluptas non illum. Ut sit suscipit explicabo.",
    "image": {
        "full": {
            //.... FmFileListResource
        },
        "thumbnail": {
            //.... FmFileListResource
        }
    },
    "timestamps": {
        "createdAt": "2024-04-13T17:33:41.000000Z",
        "updatedAt": "2024-04-13T17:33:41.000000Z"
    }
}
```

Customize resource transformation
---------------------------------

[](#customize-resource-transformation)

if you want to customize the resource to use in function `$this->fmImageVariation()`, just need to change the class in

```
use MCris112\FileSystemManager\Traits\Resource\ResourceFmImageVariationTransformation;

class ProductResource extends JsonResource
{
    use ResourceFmImageVariationTransformation;

    //Replace with your custom resource
    protected string $fmImageResource = FmFileListResource::class;
}
```

Has an Image
------------

[](#has-an-image)

If you want that a model has an image, you can define that relationship with trait and table

Model

```
use MCris112\FileSystemManager\Traits\HasFmImage;

class SomeModel extends Model
{
    use HasFmImage;
}
```

Migration

```
use MCris112\FileSystemManager\Facades\FileSystemManagerTable;

public function up(): void
{
    Schema::create('some_model', function (Blueprint $table) {
        //This will define the relationship on table
        FileSystemManagerTable::hasImage($table);
    });
}
```

Has image variations
--------------------

[](#has-image-variations)

If has different images variations

```
use MCris112\FileSystemManager\Traits\HasFmImageVariations;
use MCris112\FileSystemManager\Enums\FmFileSize;

class Product extends Model
{
    use HasFmImageVariations;
}

// Can load all image variations
Product::with('fmimages')->get();
$prodcut->load('fmimages');

//Just load specific image variation
Product::withThumbnail()->get()
Product::withSquareImage()->get()

/**
 * Load all or specific image size
 * @param array|string|FmFileSize|null $sizes can be '*'|null for load all image sizes or an array for load specific image sizes
 */
Product::withFmImageSize(FmFileSize::VIDEO)->get()
```

FmPagination
------------

[](#fmpagination)

```
use \Illuminate\Http\Resources\Json\ResourceCollection;
use MCris112\FileSystemManager\Traits\FmPagination;

class YourResource extends ResourceCollection
{
    use FmPagination;

    public function toArray(\Illuminate\Http\Request $request){
        return [
            "data" => $this->collection,
            // now you can use this function to retrieve easily the pagination data
            "pagination" => $this->paginate();
        ];
    }
}

// FmPagination does
return [
    'total' => $this->total(),
    'perPage' => $this->perPage(),
    'currentPage' => $this->currentPage(),
    'totalPages' => $this->lastPage()
];
```

Category
========

[](#category)

Folder
------

[](#folder)

### Create Folder

[](#create-folder)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

$folderManager = FileSystemManager::folder()->create("Name of folder");
```

### Folder Content

[](#folder-content)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

/**
 * Get the parents of files and folder to show it into the file manager interface
 * @param int $id
 * @param int|null $perPage
 * @return \MCris112\FileSystemManager\FileManagerContent
 */
$content = FileSystemManager::folder()->content( $folderId )
```

### Search Folders

[](#search-folders)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

/**
* @param string $name
* @param int|null $perPage
* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
*/
$content = FileSystemManager::folder()->search( "content" )
```

### Find a folder

[](#find-a-folder)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

/**
 * @param int $id
 * @return \MCris112\FileSystemManager\Models\FmFolder
 */
$content = FileSystemManager::folder()->find( $id )
```

### Folder Parent

[](#folder-parent)

If you want to create a sub folder, you can define the parent

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

$folderManager = FileSystemManager::folder( $FmFodlerOrIntOrNullableValue );

//Now will create a sub folder from parent folder
$folderManager->create("Sub Folder Name");

//For any case you couldnt set a parent folder, you can set it
$folderManager->parent($FmFodlerOrIntOrNullableValue)->create();
```

### Put into folder

[](#put-into-folder)

To save some content inside of folder, just do

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

$folderManager = FileSystemManager::folder( $FmFodlerOrIntOrNullableValue );

//Now will create a sub folder from parent folder
$folderManager->create("Sub Folder Name");

//For any case you couldnt set a parent folder, you can set it
$folderManager->parent($FmFodlerOrIntOrNullableValue)->create();
```

### Delete folder or content

[](#delete-folder-or-content)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

// For delete an specific file or content
$folderManager = FileSystemManager::folder($folder)->delete($fmFileOrFmFolderOrArray);

// For delete the folder
$folderManager = FileSystemManager::folder($folder)->delete();

// For delete the folder and the content inside
$folderManager = FileSystemManager::folder($folder)->delete(null , true);
```

File
----

[](#file)

### Search Files

[](#search-files)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

/**
* @param string $name
* @param int|null $perPage
* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
*/
$content = FileSystemManager::folder()->search( "content" )
```

### Find a File

[](#find-a-file)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

/**
 * Find a file by id or full path (folder + filename)
 * @param int|string $idOrPath
 * @return FmFile
 * @throws FmFileNotFoundException
 */
$content = FileSystemManager::folder()->find( $id )
```

Why `FileSystemManager::folder()->find( $id )` instead of `FmFile::find($id)` or `FmFile::whereId($id)->get()`, you can use it but in this case will return a full cached model.

### Delete file

[](#delete-file)

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

$folderManager = FileSystemManager::file($file)->delete();

//or

/** @var \MCris112\FileSystemManager\Models\FmFile $file */
$file->delete(); // Automatically It will delete the file in your disk
```

Why use `FileSystemManager::file($file)->delete()` instead of `$file->delete()`, in this case, if something happens when It's destroying your file, the record on your db won't be rolled back and It will generate an incorrect sum of storage size

Avatar
------

[](#avatar)

### Before Use

[](#before-use)

#### Config

[](#config)

Dont forget to configure `filesystemmanager.php` in case you want to use avatars

```
return [
    //...
    "user" => [
        "avatar" => true, // Set this true to start using avatars
        "width" => 512, // Avatar width
        "height" => 512, // Avatar height
        "quality" => 80, // file quality of JPG
        "generatorUrl" => "https://ui-avatars.com/api/?size=512&name="
    ]
]
```

Add `UserHasAvatar` trait to avoid errors when is null to generate a based name avatar, but if you always will set a file, you can avoid this step

```
use MCris112\FileSystemManager\Traits\UserHasAvatar;

class User extends Authenticatable
{
    use UserHasAvatar;

    //...
}
```

### Used

[](#used)

How much storage is the avatar using

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

$avatarManager = FileSystemManager::avatar()->used()
```

### Avatar Url

[](#avatar-url)

Get the Avatar url from User

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

$user = \App\Models\User::first();

$avatarManager = FileSystemManager::avatar()->user($user)->url();

//or
$avatarManager = FileSystemManager::avatar($user)->url();

//or
$user->avatar()->url();
```

### Create Avatar

[](#create-avatar)

You can define the file, but as same time you can let it as null and It will create an avatar based on name

```
use \MCris112\FileSystemManager\Facades\FileSystemManager;

/**
 * @param UploadedFile|null $file
 * @return User
 */
public function create(?UploadedFile $file = null): User
{
    //...
}

$user = \App\Models\User::first();

FileSystemManager::avatar()->user($user)->create($file);

//or
FileSystemManager::avatar($user)->create($file);

//or
$user->avatar()->create($file);
```

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance31

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

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

Total

4

Last Release

728d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/32046639?v=4)[Cristopher](/maintainers/MCris112)[@MCris112](https://github.com/MCris112)

---

Top Contributors

[![MCris112](https://avatars.githubusercontent.com/u/32046639?v=4)](https://github.com/MCris112 "MCris112 (19 commits)")

---

Tags

filesystemlaravellaravel-packagesfile system manager

### Embed Badge

![Health badge](/badges/mcris112-file-manager-system/health.svg)

```
[![Health](https://phpackages.com/badges/mcris112-file-manager-system/health.svg)](https://phpackages.com/packages/mcris112-file-manager-system)
```

###  Alternatives

[unisharp/laravel-filemanager

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

2.2k3.5M85](/packages/unisharp-laravel-filemanager)[unopim/unopim

UnoPim Laravel PIM

10.5k2.4k](/packages/unopim-unopim)[oneduo/nova-file-manager

A handy file manager tool for Laravel Nova

159399.9k2](/packages/oneduo-nova-file-manager)[yoelpc4/laravel-cloudinary

Laravel Cloudinary filesystem cloud driver.

3345.6k](/packages/yoelpc4-laravel-cloudinary)[mmes-design/filament-file-manager

A beautiful file manager plugin for Filament. Browse, upload, rename, move and delete files with ease.

163.1k](/packages/mmes-design-filament-file-manager)[bringyourownideas/laravel-backblaze

Backblaze B2 Cloud Storage for Laravel 5. Original by Paul Olthof (@hpolthof) continued by @bringyourownideas

1238.5k](/packages/bringyourownideas-laravel-backblaze)

PHPackages © 2026

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