README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require creode/laravel-assets

You can publish and run the migrations with:

php artisan vendor:publish --tag="assets-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="assets-config"

This is the contents of the published config file:

return [

    /*
    |--------------------------------------------------------------------------
    | Disk
    |--------------------------------------------------------------------------
    |
    | This value is the name of the disk where assets will be stored. This can
    | be any disk that you have configured in your filesystems.php config file.
    |
    */

    'disk' => env('FILESYSTEM_DISK', 'public'),
];

Usage

$asset = new Creode\LaravelAssets\Models\Asset;

// You can get the asset location from disk using a path.
$asset->path;

// You can get the url property of the asset.
$asset->url;

Custom Thumbnail Generation

The ThumbnailGenerator allows for the registration of custom thumbnail generators to handle different asset types. This extensibility ensures that your application can easily adapt to new file types or specific thumbnail generation requirements.

Example

Here's a complete example of registering and using a custom thumbnail generator:

namespace App\Generators;

use Creode\LaravelAssets\Generators\PDFThumbnailGenerator;

class EPSThumbnailGenerator implements ThumbnailGeneratorInterface
{
    /**
     * Generates a thumbnail url for an asset.
     */
    public function generateThumbnailUrl(Asset $asset): ?string {
        // Custom logic to generate a thumbnail for an EPS file.
    }

    /**
     * Gets the type of output this generator produces.
     */
    public function getOutputType(): string {
        return 'image'; // typically 'image' or 'icon'.
    }
}

// AppServiceProvider.php

namespace App\Providers;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // Add an EPS thumbnail generator.
        $generator = resolve('assets.thumbnail.factory');

        $generator->addGenerator('image/x-eps', function () {
            return new \App\Generators\EPSThumbnailGenerator();
        });
    }
}

By integrating the custom generator as shown above, your application will now respond to the needs of different asset types and thumbnail generation strategies, while maintaining a clean and modular architecture.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

creode / laravel-assets

Maintainers

Details