1. interface
  2. Concrete
  3. \
  4. Core
  5. \
  6. Asset
  7. \
  8. AssetInterface

AssetInterface

interface AssetInterface (View source)

Interface that all the assets must implement.

Constants

ASSET_POSITION_HEADER

Asset position: in the tag.
ASSET_POSITION_FOOTER

Asset position: at the end of the tag.
OUTPUTASSETTYPE_CSS

Output asset type: CSS.
OUTPUTASSETTYPE_JAVASCRIPT

Output asset type: JavaScript.
OUTPUT_NOCACHE_PARAM

QueryString parameter to avoid browser cache problems.

Methods

string
__toString()

Render the HTML tag that will load this asset.

string
getAssetDefaultPosition()

Get the default asset position (\Concrete\Core\Asset\AssetInterface::ASSET_POSITION_HEADER or \Concrete\Core\Asset\AssetInterface::ASSET_POSITION_FOOTER).

setAssetPosition(string $position)

Set the position of this asset (\Concrete\Core\Asset\AssetInterface::ASSET_POSITION_HEADER or \Concrete\Core\Asset\AssetInterface::ASSET_POSITION_FOOTER).

string
getAssetPosition()

Get the position of this asset (\Concrete\Core\Asset\AssetInterface::ASSET_POSITION_HEADER or \Concrete\Core\Asset\AssetInterface::ASSET_POSITION_FOOTER).

string
getAssetType()

Get the unique identifier of the asset type.

string
getAssetHandle()

Get the handle of this asset (together with getAssetType, identifies this asset).

string
getOutputAssetType()

Get the resulting type of the asset (\Concrete\Core\Asset\AssetInterface::OUTPUTASSETTYPE_CSS, \Concrete\Core\Asset\AssetInterface::OUTPUTASSETTYPE_JAVASCRIPT or other values).

setAssetIsLocal(bool $isLocal)

Is this asset a locally available file (accessible with the getAssetPath method)?

bool
isAssetLocal()

Is this asset a locally available file (accessible with the getAssetPath method)?

setAssetURL(string $url)

Set the URL of this asset.

string
getAssetURL()

Get the URL of this asset.

setAssetPath(string $path)

Set the path to this asset.

string
getAssetPath()

Get the path to this asset.

mapAssetLocation(string $path)

If the asset is local, set its path and URL starting from the relative path. If it's not local, set its URL.

string
getAssetURLPath()

Get the path of the parent "folder" that contains this asset.

string
getAssetFilename()

Get the name of the file of this asset.

string
getAssetHashKey()

Get a string that unambiguously identifies this asset.

setAssetVersion(string $version)

Set the version of this asset.

string
getAssetVersion()

Get the version of this asset.

setPackageObject(Package|Package|null|false $pkg)

Set the package that defines this asset.

string|null
getAssetContents()

Get the contents of the asset (if applicable).

setCombinedAssetSourceFiles(string[] $paths)

Set the URL of the source files this asset has been built from (useful to understand the origin of this asset).

register(string $filename, array $args, Package|Package|string|null|false $pkg = false)

Register the asset properties.

static AssetInterface[]
process(AssetInterface[] $assets)

Asset-type specific post-processing.

Details

at line 50
string __toString()

Render the HTML tag that will load this asset.

Return Value

string

at line 57
string getAssetDefaultPosition()

Get the default asset position (\Concrete\Core\Asset\AssetInterface::ASSET_POSITION_HEADER or \Concrete\Core\Asset\AssetInterface::ASSET_POSITION_FOOTER).

Return Value

string

at line 64
setAssetPosition(string $position)

Set the position of this asset (\Concrete\Core\Asset\AssetInterface::ASSET_POSITION_HEADER or \Concrete\Core\Asset\AssetInterface::ASSET_POSITION_FOOTER).

Parameters

string $position

at line 71
string getAssetPosition()

Get the position of this asset (\Concrete\Core\Asset\AssetInterface::ASSET_POSITION_HEADER or \Concrete\Core\Asset\AssetInterface::ASSET_POSITION_FOOTER).

Return Value

string

at line 78
string getAssetType()

Get the unique identifier of the asset type.

Return Value

string

at line 85
string getAssetHandle()

Get the handle of this asset (together with getAssetType, identifies this asset).

Return Value

string

at line 92
string getOutputAssetType()

Get the resulting type of the asset (\Concrete\Core\Asset\AssetInterface::OUTPUTASSETTYPE_CSS, \Concrete\Core\Asset\AssetInterface::OUTPUTASSETTYPE_JAVASCRIPT or other values).

Return Value

string

at line 99
setAssetIsLocal(bool $isLocal)

Is this asset a locally available file (accessible with the getAssetPath method)?

Parameters

bool $isLocal

at line 106
bool isAssetLocal()

Is this asset a locally available file (accessible with the getAssetPath method)?

Return Value

bool

at line 113
setAssetURL(string $url)

Set the URL of this asset.

Parameters

string $url

at line 120
string getAssetURL()

Get the URL of this asset.

Return Value

string

at line 127
setAssetPath(string $path)

Set the path to this asset.

Parameters

string $path

at line 134
string getAssetPath()

Get the path to this asset.

Return Value

string

at line 141
mapAssetLocation(string $path)

If the asset is local, set its path and URL starting from the relative path. If it's not local, set its URL.

Parameters

string $path

at line 148
string getAssetURLPath()

Get the path of the parent "folder" that contains this asset.

Return Value

string

at line 155
string getAssetFilename()

Get the name of the file of this asset.

Return Value

string

at line 162
string getAssetHashKey()

Get a string that unambiguously identifies this asset.

Return Value

string

at line 169
setAssetVersion(string $version)

Set the version of this asset.

Parameters

string $version

at line 176
string getAssetVersion()

Get the version of this asset.

Return Value

string

at line 183
setPackageObject(Package|Package|null|false $pkg)

Set the package that defines this asset.

Parameters

Package|Package|null|false $pkg

at line 190
string|null getAssetContents()

Get the contents of the asset (if applicable).

Return Value

string|null

at line 197
setCombinedAssetSourceFiles(string[] $paths)

Set the URL of the source files this asset has been built from (useful to understand the origin of this asset).

Parameters

string[] $paths

at line 214
register(string $filename, array $args, Package|Package|string|null|false $pkg = false)

Register the asset properties.

Parameters

string $filename

the location of the asset
array $args

{

@var bool $local is this asset a locally available file (accessible with the getAssetPath method)?
@var bool $minify does this asset support minification?
@var bool $combine can this asset be combined with other assets?
@var string $version the version of this asset
@var string $position the position of this asset (\Concrete\Core\Asset\AssetInterface::ASSET_POSITION_HEADER or \Concrete\Core\Asset\AssetInterface::ASSET_POSITION_FOOTER).

}
Package|Package|string|null|false $pkg

the package that defines this asset (or its handle)

at line 225
static AssetInterface[] process(AssetInterface[] $assets)

Asset-type specific post-processing.

Parameters

AssetInterface[] $assets

The original assets

Return Value

AssetInterface[]

The final assets

Examples

Compress JavaScripts, merge CSS files...