metrique/laravel-cdnify

Add a CDN to any path when a specified environment is active.

1.2.12 2021-07-17 19:27 UTC

Requires

• laravel/framework: >=5.5

Requires (Dev)

• php: ^7.0

MIT

• Daniel Hudson

README

Features

• Add a CDN to any path when a specified environment is active in Laravel 5.
• Easily publish laravel-mix or laravel-elixir versioned assets to a file system of your choice.

Installation

Set up.

1. composer require metrique/laravel-cdnify
2. Optionally add Metrique\CDNify\CDNifyServiceProvider::class to the list of Autoloaded Service Providers in config/app.php.
3. Optionally add 'CDNify'=>Metrique\CDNify\CDNifyFacade::class to the list of Class Aliases in config/app.php.

CDNify supports Laravel Package Discovery and so steps 2 and 3 are optional.

Config.

Config defaults can be configured by editing config/cdnify.php in your main application directory.

You can publish the config/cdnify.php config file to your application config directory by running php artisan vendor:publish --tag="cdnify-config"

Usage

Examples.

Get Helper

A resource exists in your mix-manifest.json, which has been created by Laravel Mix. <script src="{{ $cdnify->get('js/site.js', true) }}" async></script>

Get the CDN as a string.

$cdnify->cdn();

Set a local path and get the full CDN path.

$cdnify->path('/some/static/resource.jpg')->toString();

CDNify

$cdnify is automatically registered for use in all Laravel views.

$cdnify->defaults(); If environments, mix or roundRobin settings are changed, this will discard the changes in favour of the config settings.

$cdnify->cdn(); Returns a CDN path from the config, if roundRobin is set to true then it will iterate through the list of CDN's on each call.

$cdnify->path($path); Sets the path to be CDNified.

$cdnify->toString(); Returns the CDN and path as a string.

$cdnify->get($path, $params = []); Helper utility combining the path and toString methods. You may pass an array of params (mix, environments, roundRobin) to override the settings once.

$cdnify->environments($environments); Set the environments where the path should be CDNified.

$cdnify->mix($bool); Sets whether mix should be used, if available.

$cdnify->roundRobin($bool); Enables round robin iteration on the cdn list.

CDNify command

php artisan metrique:cdnify This command will run npm run production or gulp --production and then deploy any assets listed in mix-manifest.json to s3 (or other disk), via the Laravel Filesystem.

Options

--build-source[=BUILD-SOURCE] Sets the path to the source files that are to be uploaded. [default: "/build"]

--build-dest[=BUILD-DEST] Sets the path where files are to be uploaded. [default: "/build"].

--disk[=DISK] Set disk/upload method. [default: "s3"]

--force Toggle force upload of files.

--skip-build Skips the running npm run production or gulp --production build process.

--manifest[=MANIFEST] Set manifest location. [default: "/build/mix-manifest.json"]