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

Asset

abstract class Asset implements AssetInterface (View source)

Properties

protected string $assetHandle

The handle of this asset (together with getAssetType, identifies this asset).
protected string $position

The position of this asset (\Concrete\Core\Asset\AssetInterface::ASSET_POSITION_HEADER or \Concrete\Core\Asset\AssetInterface::ASSET_POSITION_FOOTER).
protected bool $local

Is this asset a locally available file (accessible with the getAssetPath method)?
protected string $location

The location of the asset (used to build the path & URL).
protected string $assetURL

The URL of this asset.
protected string $assetPath

The path to this asset.
protected bool $assetHasBeenMapped

Does the URL/path have already been resolved (starting from the location) for this (local) assets?
protected string $filename

The name of the file of this asset.
protected string $assetVersion

The asset version.
protected Package|Package|null $pkg

The package that defines this asset.
protected array $combinedAssetSourceFiles

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

Methods

__construct(string $assetHandle = '')

Initialize the instance.

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
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)?

setAssetSupportsMinification($minify)

No description

assetSupportsMinification()

No description

setAssetSupportsCombination($combine)

No description

assetSupportsCombination()

No description

setAssetLocation(string $location)

Set the location of this asset.

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.

bool
hasAssetBeenMapped()

Does the URL/path have already been resolved (starting from the location) for this (local) assets?

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.

AssetPointer
getAssetPointer()

Get an AssetPointer instance that identifies this asset.

static string|null
getAssetContentsByRoute(string $route)

Get the contents of an asset given its route.

string
obfuscateNoCacheValue(string $noCacheValue)

Obfuscate the value of the query-string parameter used to avoid browser cache problems.

Details

at line 99
__construct(string $assetHandle = '')

Initialize the instance.

Parameters

string $assetHandle

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

at line 110
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

See also

AssetInterface::setAssetPosition

at line 120
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

See also

AssetInterface::getAssetPosition

at line 130
string getAssetHandle()

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

Return Value

string

See also

AssetInterface::getAssetHandle

at line 140
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

See also

AssetInterface::getOutputAssetType

at line 150
setAssetIsLocal(bool $isLocal)

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

Parameters

bool $isLocal

See also

AssetInterface::setAssetIsLocal

at line 160
bool isAssetLocal()

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

Return Value

bool

See also

AssetInterface::isAssetLocal

at line 168
setAssetSupportsMinification($minify)

No description

Parameters

$minify

at line 176
assetSupportsMinification()

No description

at line 184
setAssetSupportsCombination($combine)

No description

Parameters

$combine

at line 192
assetSupportsCombination()

No description

at line 202
setAssetLocation(string $location)

Set the location of this asset.

Parameters

string $location

at line 212
setAssetURL(string $url)

Set the URL of this asset.

Parameters

string $url

See also

AssetInterface::setAssetURL

at line 223
string getAssetURL()

Get the URL of this asset.

Return Value

string

See also

AssetInterface::getAssetURL

at line 251
setAssetPath(string $path)

Set the path to this asset.

Parameters

string $path

See also

AssetInterface::setAssetPath

at line 262
string getAssetPath()

Get the path to this asset.

Return Value

string

See also

AssetInterface::getAssetPath

at line 276
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

See also

AssetInterface::mapAssetLocation

at line 297
bool hasAssetBeenMapped()

Does the URL/path have already been resolved (starting from the location) for this (local) assets?

Return Value

bool

at line 307
string getAssetURLPath()

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

Return Value

string

See also

AssetInterface::getAssetURLPath

at line 317
string getAssetFilename()

Get the name of the file of this asset.

Return Value

string

See also

AssetInterface::getAssetFilename

at line 327
string getAssetHashKey()

Get a string that unambiguously identifies this asset.

Return Value

string

See also

AssetInterface::getAssetHashKey

at line 363
setAssetVersion(string $version)

Set the version of this asset.

Parameters

string $version

See also

AssetInterface::setAssetVersion

at line 373
string getAssetVersion()

Get the version of this asset.

Return Value

string

See also

AssetInterface::getAssetVersion

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

Set the package that defines this asset.

Parameters

Package|Package|null|false $pkg

See also

AssetInterface::setPackageObject

at line 393
string|null getAssetContents()

Get the contents of the asset (if applicable).

Return Value

string|null

See also

AssetInterface::getAssetContents

at line 405
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

See also

AssetInterface::setCombinedAssetSourceFiles

at line 415
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)

See also

AssetInterface::register

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

Asset-type specific post-processing.

Parameters

AssetInterface[] $assets

The original assets

Return Value

AssetInterface[]

The final assets

See also

AssetInterface::process

at line 456
AssetPointer getAssetPointer()

Get an AssetPointer instance that identifies this asset.

Return Value

AssetPointer

at line 470
static protected string|null getAssetContentsByRoute(string $route)

Get the contents of an asset given its route.

Parameters

string $route

Return Value

string|null

at line 522
protected string obfuscateNoCacheValue(string $noCacheValue)

Obfuscate the value of the query-string parameter used to avoid browser cache problems.

Parameters

string $noCacheValue

Return Value

string