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

JavascriptAsset

class JavascriptAsset extends Asset (View source)

Properties

protected string $assetHandle

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

 from  Asset
protected string $position

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

 from  Asset
protected bool $local

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

 from  Asset
protected string $location

The location of the asset (used to build the path & URL).

 from  Asset
protected string $assetURL

The URL of this asset.

 from  Asset
protected string $assetPath

The path to this asset.

 from  Asset
protected bool $assetHasBeenMapped

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

 from  Asset
protected string $filename

The name of the file of this asset.

 from  Asset
protected string $assetVersion

The asset version.

 from  Asset
protected Package|Package|null $pkg

The package that defines this asset.

 from  Asset
protected array $combinedAssetSourceFiles

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

 from  Asset

Methods

__construct(string $assetHandle = '')

Initialize the instance.

from  Asset
setAssetPosition(string $position)

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

from  Asset
string
getAssetPosition()

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

from  Asset
string
getAssetHandle()

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

from  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).

from  Asset
setAssetIsLocal(bool $isLocal)

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

from  Asset
bool
isAssetLocal()

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

from  Asset
setAssetSupportsMinification($minify)

No description

from  Asset
assetSupportsMinification()

No description

from  Asset
setAssetSupportsCombination($combine)

No description

from  Asset
assetSupportsCombination()

No description

from  Asset
setAssetLocation(string $location)

Set the location of this asset.

from  Asset
setAssetURL(string $url)

Set the URL of this asset.

from  Asset
string
getAssetURL()

Get the URL of this asset.

from  Asset
setAssetPath(string $path)

Set the path to this asset.

from  Asset
string
getAssetPath()

Get the path to this asset.

from  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.

from  Asset
bool
hasAssetBeenMapped()

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

from  Asset
string
getAssetURLPath()

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

from  Asset
string
getAssetFilename()

Get the name of the file of this asset.

from  Asset
string
getAssetHashKey()

Get a string that unambiguously identifies this asset.

from  Asset
setAssetVersion(string $version)

Set the version of this asset.

from  Asset
string
getAssetVersion()

Get the version of this asset.

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

Set the package that defines this asset.

from  Asset
string|null
getAssetContents()

Get the contents of the asset (if applicable).

from  Asset
setCombinedAssetSourceFiles(string[] $paths)

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

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

Register the asset properties.

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

No description

AssetPointer
getAssetPointer()

Get an AssetPointer instance that identifies this asset.

from  Asset
static string|null
getAssetContentsByRoute(string $route)

Get the contents of an asset given its route.

from  Asset
string
obfuscateNoCacheValue(string $noCacheValue)

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

from  Asset
string
getAssetDefaultPosition()

No description

static string
getRelativeOutputDirectory()

No description

static bool|string
getOutputDirectory()

No description

string
getAssetType()

No description

string
__toString()

No description

Details

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

Initialize the instance.

Parameters

string $assetHandle

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

in 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

in Asset 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

in Asset at line 130
string getAssetHandle()

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

Return Value

string

See also

AssetInterface::getAssetHandle

in Asset 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

in Asset 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

in Asset at line 160
bool isAssetLocal()

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

Return Value

bool

See also

AssetInterface::isAssetLocal

in Asset at line 168
setAssetSupportsMinification($minify)

No description

Parameters

$minify

in Asset at line 176
assetSupportsMinification()

No description

in Asset at line 184
setAssetSupportsCombination($combine)

No description

Parameters

$combine

in Asset at line 192
assetSupportsCombination()

No description

in Asset at line 202
setAssetLocation(string $location)

Set the location of this asset.

Parameters

string $location

in Asset at line 212
setAssetURL(string $url)

Set the URL of this asset.

Parameters

string $url

See also

AssetInterface::setAssetURL

in Asset at line 223
string getAssetURL()

Get the URL of this asset.

Return Value

string

See also

AssetInterface::getAssetURL

in Asset at line 251
setAssetPath(string $path)

Set the path to this asset.

Parameters

string $path

See also

AssetInterface::setAssetPath

in Asset at line 262
string getAssetPath()

Get the path to this asset.

Return Value

string

See also

AssetInterface::getAssetPath

in Asset 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

in Asset at line 297
bool hasAssetBeenMapped()

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

Return Value

bool

in Asset at line 307
string getAssetURLPath()

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

Return Value

string

See also

AssetInterface::getAssetURLPath

in Asset at line 317
string getAssetFilename()

Get the name of the file of this asset.

Return Value

string

See also

AssetInterface::getAssetFilename

in Asset at line 327
string getAssetHashKey()

Get a string that unambiguously identifies this asset.

Return Value

string

See also

AssetInterface::getAssetHashKey

in Asset at line 363
setAssetVersion(string $version)

Set the version of this asset.

Parameters

string $version

See also

AssetInterface::setAssetVersion

in Asset at line 373
string getAssetVersion()

Get the version of this asset.

Return Value

string

See also

AssetInterface::getAssetVersion

in Asset 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

in Asset at line 393
string|null getAssetContents()

Get the contents of the asset (if applicable).

Return Value

string|null

See also

AssetInterface::getAssetContents

in Asset 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

in Asset 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 48
static AssetInterface[] process(AssetInterface[] $assets)

No description

Parameters

AssetInterface[] $assets

The original assets

Return Value

AssetInterface[]

The final assets

in Asset at line 456
AssetPointer getAssetPointer()

Get an AssetPointer instance that identifies this asset.

Return Value

AssetPointer

in Asset 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

in Asset 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

at line 13
string getAssetDefaultPosition()

No description

Return Value

string

at line 21
static string getRelativeOutputDirectory()

No description

Return Value

string

at line 29
static protected bool|string getOutputDirectory()

No description

Return Value

bool|string

at line 86
string getAssetType()

No description

Return Value

string

at line 94
string __toString()

No description

Return Value

string