blytd/media-manager

There is no license information available for the latest version (1.0.3) of this package.

1.0.3 2022-10-17 21:09 UTC

Requires

• league/flysystem-aws-s3-v3: ^3.5

Unknown License

• ali.sarmadi

README

This package can associate some sorts of media with Eloquent models. It provides some simple APIs to work with.

Installation

For install this library do these steps:

• Add this line to require section of the composer.json

"blytd/media-manager": "^1.0.0"

• And also add this section in the composer.json file:

    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/alisarmadi/media-manager"
        }
    ],

• On the end you should have something like this in your composer.json file:

    ...
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/alisarmadi/media-manager"
        }
    ],
    "require": {
        ...
        "blytd/media-manager": "^1.0.0"
    },
    ...

• Then add this line to the app.php file in the config directory of your project:

    \Blytd\MediaManager\Provider\MediaManagerProvider::class

Usage

For use the library you have to add this routes to your project routes:

Route::name('media.')->prefix('media')->group(function (){
   Route::post('/upload',[\Blytd\MediaManager\Http\Controller\MediaController::class, 'upload'])->name('upload');
        Route::delete('/delete/{media_id?}',[\Blytd\MediaManager\Http\Controller\MediaController::class, 'delete'])->name('delete');
});

Note: Please be careful to wrap these routes in the appropriate middleware to control access to them. Something like this:

Route::middleware('auth')->group(function (){
    Route::name('media.')->prefix('media')->group(function (){
   Route::post('/upload',[\Blytd\MediaManager\Http\Controller\MediaController::class, 'upload'])->name('upload');
        Route::delete('/delete/{media_id?}',[\Blytd\MediaManager\Http\Controller\MediaController::class, 'delete'])->name('delete');
    });
});

For use the library you have two endpoints for upload and delete, you can access those With these routes:

    POST {{base_path}}{/api}/media/upload
    PAYLOAD (form-data)
        media: (Selected file)
        model: (Can be one of your model name, it's an optional parameter)
        model_id: (Id of the selected model, it's an optional parameter)
        type: (Type of the file, can be one of (IMAGE,VIDEO,DOC,OTHER) it's an optional parameter)
        extra_data: (Extra data you want to store beside the file, It must be an array. It's an optional parameter)

    DELETE {{base_path}}{/api}/media/delete/{media_id}
    PAYLOAD
        {
            "path": "original/Team/630ee0ffb111e74b631f62b2_399a44ea-4642-4cda-94f4-3046904d311e.jpeg"
        }
    You must set one of the 'media_id' or 'path' param in this endpoint to delete the desired media.    

Optional usage

You can publish the MediaController with the line below and customize it if necessary.

    php artisan vendor:publish --tag=blytd-media-controller