UserFrosting API

GulpBundleAssetsRawBundles extends GulpBundleAssetsBundles

Represents a collection of asset bundles, loaded from a gulp-bundle-assets configuration file.

Tags
author

Alex Weissman (https://alexanderweissman.com)

author

Jordan Mele

todo

Many of the more advanced features available in gulp-bundle-assets configuration are not supported. (EG: Specifying the pre-minified versions of assets)

Table of Contents

$cssBundles array
$jsBundles array
__construct() Constructor. mixed
standardiseBundle() Validates bundle data and returns standardised data. string[]
__construct() Constructor. mixed
getCssBundleAssets() Gets assets in specified CSS bundle. string[]
getJsBundleAssets() Gets assets in specified JS bundle. string[]
readSchema() Attempts to read the schema file from provided path. mixed|Repository

Properties

Methods

standardiseBundle()

Validates bundle data and returns standardised data.

protected standardiseBundle( $bundle : string|string[] ) : string[]
Parameters
$bundle : string|string[]
Return values
string[]

__construct()

Constructor.

public __construct( $filePath : string ) : mixed
Parameters
$filePath : string

Path to gulp-bundle-assets file.

Return values
mixed

getCssBundleAssets()

Gets assets in specified CSS bundle.

public getCssBundleAssets( [ $bundleName : mixed = '' ] ) : string[]
Parameters
$bundleName : mixed = ''

Name of bundle.

Return values
string[]

getJsBundleAssets()

Gets assets in specified JS bundle.

public getJsBundleAssets( [ $bundleName : mixed = '' ] ) : string[]
Parameters
$bundleName : mixed = ''

Name of bundle.

Return values
string[]

readSchema()

Attempts to read the schema file from provided path.

protected readSchema( $path : string [, $useRepository : bool = false ] ) : mixed|Repository
Parameters
$path : string

Path to schema file.

$useRepository : bool = false

Deprecated, will be removed in a future release. Setting this to true is recommended for an easier migration.

Tags
throws
FileNotFoundException

if file cannot be found.

throws
JsonException

if file cannot be parsed as JSON.

Return values
mixed|Repository —

Returns file contents parsed by json_decode or a Repository if $useRepository is true.

Search results