BaseAsset
abstract class BaseAsset implements AssetInterface
A base abstract asset.
The methods load() and getLastModified() are left undefined, although a reusable doLoad() method is available to child classes.
Properties
private | $filters | ||
private | $sourceRoot | ||
private | $sourcePath | ||
private | $sourceDir | ||
private | $targetPath | ||
private | $content | ||
private | $loaded | ||
private | $vars | ||
private | $values |
Methods
Constructor.
No description
Returns an array of filters currently applied.
Clears all filters from the current asset.
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 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 53
__construct(array $filters = [], string $sourceRoot = null, string $sourcePath = null, array $vars = [])
Constructor.
at line 66
__clone()
No description
at line 71
ensureFilter(FilterInterface $filter)
Ensures the current asset includes the supplied filter.
at line 76
array
getFilters()
Returns an array of filters currently applied.
at line 81
clearFilters()
Clears all filters from the current asset.
at line 92
protected
doLoad(string $content, FilterInterface $additionalFilter = null)
Encapsulates asset loading logic.
at line 108
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 125
string
getContent()
Returns the loaded content of the current asset.
at line 130
setContent(string $content)
Sets the content of the current asset.
Filters can use this method to change the content of the asset.
at line 135
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 140
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 145
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 150
string|null
getTargetPath()
Returns the URL for the current asset.
at line 155
setTargetPath(string $targetPath)
Sets the URL for the current asset.
at line 168
array
getVars()
Returns an array of variable names for this asset.
at line 173
setValues(array $values)
Sets the values for the asset's variables.
at line 185
array
getValues()
Returns the current values for this asset.