Download the PHP package userfrosting/assets without Composer
On this page you can find all versions of the php package userfrosting/assets. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download userfrosting/assets
More information about userfrosting/assets
Files in userfrosting/assets
Package assets
Short Description Assets module for UserFrosting
License MIT
Homepage https://github.com/userfrosting/assets
Informations about the package assets
UserFrosting/Assets
Branch | Build | Coverage | Style |
---|---|---|---|
master | |||
develop |
Assets is a library originally created for UserFrosting 4 to make it much easier to reference frontend assets in both production and development contexts.
Out of the box it can:
- Provide an easy way to generate an absolute url to an asset via a locator.
- Provide a basic level of integration with
gulp-bundle-assets
and complete integration with@userfrosting/gulp-bundle-assets
, making it easy to reference asset bundles. - Integrate via a common interface with virtually any bundling system.
- Integrate with Slim to serve assets that are inaccessible from the public folder, in the development context.
- Perform url-to-path transformations. Useful for making debuggable URLs that can be reverted back to the path to be used by the Slim asset server.
- Integrate with your preferred (and extendable) templating engine to provide easy access to asset bundles (that get wrapped with the appropriate tags) and individual assets.
Installation
Usage
To use Assets, you will need:
- An instance of
ResourceLocator
, where you can add your desired search paths. - The locator scheme (if it exists) you wish to look for assets in.
- The base url (used in generating URLs to assets).
- The base path (used in trimming the absolute path returned by the locator).
Optionally 1 more argument can be passed into the
Assets
constructor, an instance ofPrefixTransformer
.Have a look at UserFrosting in dev mode to see this in action!
Asset Bundles
To access asset bundles from an Assets
instance, it must first be passed an instance of AssetBundlesInterface
via addAssetBundles
. The following example demonstates how to integrate with @userfrosting/gulp-bundle-assets
(and by extension gulp-bundle-assets
). Note that raw bundles are only supported when their configuration is defined as JSON.
Directory Tree
build/asset-bundles.json
public/index.php
Compiled bundles can be used in much the same way, except using GulpBundleAssetsCompiledBundles
and the bundlers result file.
If using the original gulp-bundle-assets
you'll need to include an additional setting options->result->type->styles/scripts="plain"
in each bundle.
The Template Plugin
The template plugin is easy initialized by giving it the Assets
instance, and simply gets passed into the templating engine environment of your choice to be used.