AssetCollection
class AssetCollection implements IteratorAggregate, AssetCollectionInterface
A collection of assets.
Properties
| private | $assets | ||
| private | $filters | ||
| private | $sourceRoot | ||
| private | $targetPath | ||
| private | $content | ||
| private | $clones | ||
| private | $vars | ||
| private | $values |
Methods
Constructor.
No description
Returns all child assets.
Replaces an existing leaf with a new one.
Returns an array of filters currently applied.
Clears all filters from the current asset.
Loads the asset into memory and applies load filters.
Applies dump filters and returns the asset as a string.
Returns the loaded content of the current asset.
Sets the content of the current asset.
Returns an absolute path or URL to the source asset's root directory.
Returns the relative path for the source asset.
Returns the asset's source directory.
Returns the URL for the current asset.
Sets the URL for the current asset.
Returns the highest last-modified value of all assets in the current collection.
Returns an iterator for looping recursively over unique leaves.
Returns an array of variable names for this asset.
Sets the values for the asset's variables.
Returns the current values for this asset.
Details
at line 50
__construct(array $assets = [], array $filters = [], string $sourceRoot = null, array $vars = [])
Constructor.
at line 64
__clone()
No description
at line 70
array
all()
Returns all child assets.
at line 75
add(AssetInterface $asset)
Adds an asset to the current collection.
at line 80
bool
removeLeaf(AssetInterface $needle, bool $graceful = false)
Removes a leaf.
at line 102
bool
replaceLeaf(AssetInterface $needle, AssetInterface $replacement, bool $graceful = false)
Replaces an existing leaf with a new one.
at line 125
ensureFilter(FilterInterface $filter)
Ensures the current asset includes the supplied filter.
at line 130
array
getFilters()
Returns an array of filters currently applied.
at line 135
clearFilters()
Clears all filters from the current asset.
at line 141
load(FilterInterface $additionalFilter = null)
Loads the asset into memory and applies load filters.
You may provide an additional filter to apply during load.
at line 153
string
dump(FilterInterface $additionalFilter = null)
Applies dump filters and returns the asset as a string.
You may provide an additional filter to apply during dump.
Dumping an asset should not change its state.
If the current asset has not been loaded yet, it should be automatically loaded at this time.
at line 164
string
getContent()
Returns the loaded content of the current asset.
at line 169
setContent(string $content)
Sets the content of the current asset.
Filters can use this method to change the content of the asset.
at line 174
string|null
getSourceRoot()
Returns an absolute path or URL to the source asset's root directory.
This value should be an absolute path to a directory in the filesystem, an absolute URL with no path, or null.
For example:
- '/path/to/web'
- 'http://example.com'
- null
at line 179
string|null
getSourcePath()
Returns the relative path for the source asset.
This value can be combined with the asset's source root (if both are non-null) to get something compatible with file_get_contents().
For example:
- 'js/main.js'
- 'main.js'
- null
at line 183
string|null
getSourceDirectory()
Returns the asset's source directory.
The source directory is the directory the asset was located in and can be used to resolve references relative to an asset.
at line 187
string|null
getTargetPath()
Returns the URL for the current asset.
at line 192
setTargetPath(string $targetPath)
Sets the URL for the current asset.
at line 202
int|null
getLastModified()
Returns the highest last-modified value of all assets in the current collection.
at line 222
getIterator()
Returns an iterator for looping recursively over unique leaves.
at line 227
array
getVars()
Returns an array of variable names for this asset.
at line 232
setValues(array $values)
Sets the values for the asset's variables.
at line 241
array
getValues()
Returns the current values for this asset.