W3cubDocs

/Symfony 2.8

Symfony\Component\Templating\Helper\CoreAssetsHelper

class CoreAssetsHelper extends Helper implements PackageInterface

CoreAssetsHelper helps manage asset URLs.

Usage:

Methods

setCharset(string $charset)

Sets the default charset.

from Helper
string getCharset()

Gets the default charset.

from Helper
__construct(PackageInterface $defaultPackage, array $namedPackages = array())

Constructor.

setDefaultPackage(PackageInterface $defaultPackage)

Sets the default package.

addPackage(string $name, PackageInterface $package)

Adds an asset package to the helper.

PackageInterface getPackage(string $name = null)

Returns an asset package.

string getVersion(string $packageName = null)

Gets the version to add to public URL.

string getUrl(string $path, string $packageName = null, string|bool|null $version = null)

Returns the public path.

string getName()

Returns the canonical name of this helper.

Details

public setCharset(string $charset)

Sets the default charset.

Parameters

string $charset The charset

public string getCharset()

Gets the default charset.

Return Value

string The default charset

public __construct(PackageInterface $defaultPackage, array $namedPackages = array())

Constructor.

Parameters

PackageInterface $defaultPackage The default package
array $namedPackages Additional packages indexed by name

public setDefaultPackage(PackageInterface $defaultPackage)

Sets the default package.

Parameters

PackageInterface $defaultPackage The default package

public addPackage(string $name, PackageInterface $package)

Adds an asset package to the helper.

Parameters

string $name The package name
PackageInterface $package The package

public PackageInterface getPackage(string $name = null)

Returns an asset package.

Parameters

string $name The name of the package or null for the default package

Return Value

PackageInterface An asset package

Exceptions

InvalidArgumentException If there is no package by that name

public string getVersion(string $packageName = null)

Gets the version to add to public URL.

Parameters

string $packageName A package name

Return Value

string The current version

public string getUrl(string $path, string $packageName = null, string|bool|null $version = null)

Returns the public path.

Absolute paths (i.e. http://...) are returned unmodified.

Parameters

string $path A public path
string $packageName The name of the asset package to use
string|bool|null $version A specific version

Return Value

string A public path which takes into account the base path and URL path

public string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Templating/Helper/CoreAssetsHelper.html