CoreAssetsHelper deprecated

class CoreAssetsHelper extends Helper implements PackageInterface

^deprecated

since 2.7, will be removed in 3.0. Use the Asset component instead.

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

setCharset(string $charset)

Sets the default charset.

Parameters

string

$charset

The charset

string getCharset()

Gets the default charset.

Return Value

string

The default charset

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

Constructor.

Parameters

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

setDefaultPackage(PackageInterface $defaultPackage)

Sets the default package.

Parameters

PackageInterface

$defaultPackage

The default package

addPackage(string $name, PackageInterface $package)

Adds an asset package to the helper.

Parameters

string	$name	The package name
PackageInterface	$package	The package

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

string getVersion(string $packageName = null)

Gets the version to add to public URL.

Parameters

string

$packageName

A package name

Return Value

string

The version string

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 path
string	$packageName	The name of the asset package to use
string\|bool\|null	$version	A specific version for the path

Return Value

string

The public path

string getName()

Returns the canonical name of this helper.

Return Value

string

The canonical name

Links:

http://api.symfony.com/master/Symfony/Component/Templating/Helper/CoreAssetsHelper.html

doc_Symfony

2016-10-28 06:12:22

Comments