RawAssetBundles extends GulpBundleAssetsRawBundles
RawAssetBundles Class.
Extends GulpBundleAssetsRawBundles with an extend method that merges the referenced asset bundles with special collision logic.
Tags
Table of Contents
| $cssBundles | array | |
|---|---|---|
| $jsBundles | array | |
| extend() | Extends the currently loaded bundles with another bundle schema. | mixed |
| addWithCollisionRule() | Adds provided bundle to provided bundle store with collision rule respected. | mixed |
| __construct() | Constructor. | mixed |
| standardiseBundle() | Validates bundle data and returns standardised data. | string[] |
| 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
$cssBundles
protected
array
$cssBundles
$jsBundles
protected
array
$jsBundles
Methods
extend()
Extends the currently loaded bundles with another bundle schema.
public
extend(
$filePath :
string
)
: mixed
Parameters
- $filePath : string
Tags
Return values
mixedaddWithCollisionRule()
Adds provided bundle to provided bundle store with collision rule respected.
protected
addWithCollisionRule(
&$bundle :
string|string[]
, $bundleName :
mixed
, $collisionRule :
string
, &$bundleStore :
mixed
)
: mixed
Parameters
- $bundle : string|string[]
Bundle to add.
- $bundleName : mixed
- $collisionRule : string
Rule to apply if collision is detected.
- $bundleStore : mixed
Tags
Return values
mixed__construct()
Constructor.
public
__construct(
$filePath :
string
)
: mixed
Parameters
- $filePath : string
Path to gulp-bundle-assets file.
Return values
mixedstandardiseBundle()
Validates bundle data and returns standardised data.
protected
standardiseBundle(
$bundle :
string|string[]
)
: string[]
Parameters
- $bundle : string|string[]
Return values
string[]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
Return values
mixed|Repository —Returns file contents parsed by json_decode or a Repository if $useRepository is true.