benrowe/laravel-filesystem-url

A laravel component for generating public endpoints for assets within the filesystem

Laravel Filesystem Url

, _(*1)

Provides a url generation service for your configured filesystems, _(*2)

This extends from laravel's filesystem config., _(*3)

Installation

Composer

Simply add a dependency on benrowe/laravel-filesystem-url to your project's composer.json file if you use Composer to manage the dependencies of your project., _(*4)

{
    "require-dev": {
         "benrowe/laravel-filesystem-url": "*"
    }
}

You can also install this package via the composer command:, _(*5)

composer require 'benrowe/laravel-filesystem-url=*'

Configuration

Service Provider + Facade

Once you've installed the package via composer, you need to register the provided service provider into laravel's provider stack., _(*6)

Benrowe\Laravel\Url\ServiceProvider::class

Optionally you can register the facade:, _(*7)

'Url' => Benrowe\Laravel\Url\Facade::class,

Filesystem

The url builder uses the existing filesystem config, by extending it with some additional details., _(*8)

Each disk thats configured can have a url key + associated settings, _(*9)

'local' => [
    'url' => [
        'base' => 'http://localhost',
        'baseSecure' => 'https://localhost', // optional
        'prefix' => 'assets', // optional
        'enabled' => true, //optional
    ]
]

Any filesystems that don't have the url key won't allow a url to be generated (throws an exception)., _(*10)

Usage

The primary method is the url($path, $disk = null, $secure = false), _(*11)

It can be accessed in the following ways:, _(*12)

Facade

Url::url('path/to/file.jpg', 'local', $forceSecure);
// outputs as http://localhost/assets/path/to/file.jpg

Blade Directive

The package provides a convenient blade directive, _(*13)

@url('path/to/file.jpg', 'diskname')
// the blade directive will trap exceptions if the disk doesn't exist, or is not configured correctly.

Todo

• Dynamic config - ability to get the config for s3 buckets based on other config, api, etc.