CClientScript

Package	system.web
Inheritance	class CClientScript » CApplicationComponent » CComponent
Implements	IApplicationComponent
Since	1.0
Source Code	framework/web/CClientScript.php

Property Details

list of core script packages (name=>package spec). Please refer to packages for details about package spec.

By default, the core script packages are specified in 'framework/web/js/packages.php'. You may configure this property to customize the core script packages.

When calling registerPackage to register a script package, packages will be checked first followed by this property. If a package is found, it will be registered for rendering later on.

Where the scripts registered using registerCoreScript or registerPackage will be inserted in the page. This can be one of the CClientScript::POS_* constants. Defaults to CClientScript::POS_HEAD.

Returns the base URL of all core javascript files. If the base URL is not explicitly set, this method will publish the whole directory 'framework/web/js/source' and return the corresponding URL.

the registered script packages (name => package spec)

the registered css code blocks (key => array(CSS code, media type)).

the registered CSS files (CSS URL=>media type).

Where the scripts registered using registerScriptFile will be inserted in the page. This can be one of the CClientScript::POS_* constants. Defaults to CClientScript::POS_HEAD.

Where the scripts registered using registerScript will be inserted in the page. This can be one of the CClientScript::POS_* constants. Defaults to CClientScript::POS_READY.

whether JavaScript should be enabled. Defaults to true.

whether there are any javascript or css to be rendered.

the registered head link tags. Each array element represents an option array that will be passed as the last parameter of CHtml::linkTag.

the registered head meta tags. Each array element represents an option array that will be passed as the last parameter of CHtml::metaTag.

list of custom script packages (name=>package spec). This property keeps a list of named script packages, each of which can contain a set of CSS and/or JavaScript script files, and their dependent package names. By calling registerPackage, one can register a whole package of client scripts together with their dependent packages and render them in the HTML output.

The array structure is as follows:

array(
  'package-name'=>array(
    'basePath'=>'alias of the directory containing the script files',
    'baseUrl'=>'base URL for the script files',
    'js'=>array(list of js files relative to basePath/baseUrl),
    'css'=>array(list of css files relative to basePath/baseUrl),
    'depends'=>array(list of dependent packages),
  ),
  ......
)

The JS and CSS files listed are relative to 'basePath'. For example, if 'basePath' is 'application.assets', a script named 'comments.js' will refer to the file 'protected/assets/comments.js'.

When a script is being rendered in HTML, it will be prefixed with 'baseUrl'. For example, if 'baseUrl' is '/assets', the 'comments.js' script will be rendered using URL '/assets/comments.js'.

If 'baseUrl' does not start with '/', the relative URL of the application entry script will be inserted at the beginning. For example, if 'baseUrl' is 'assets' and the current application runs with the URL 'http://localhost/demo/index.php', then the 'comments.js' script will be rendered using URL '/demo/assets/comments.js'.

If 'baseUrl' is not set, the script will be published by CAssetManager and the corresponding published URL will be used.

When calling registerPackage to register a script package, this property will be checked first followed by corePackages. If a package is found, it will be registered for rendering later on.

the registered JavaScript files (position, key => URL)

the mapping between script file names and the corresponding script URLs. The array keys are script file names (without directory part) and the array values are the corresponding URLs. If an array value is false, the corresponding script file will not be rendered. If an array key is '*.js' or '*.css', the corresponding URL will replace all JavaScript files or CSS files, respectively.

This property is mainly used to optimize the generated HTML pages by merging different scripts files into fewer and optimized script files.

the registered JavaScript code blocks (position, key => code)

Method Details

public static addPackage(string $name, array $definition)
$name	string	the name of the script package.
$definition	array	the definition array of the script package,
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.10).

Adds a package to packages list.

public string getCoreScriptUrl()
{return}	string	the base URL of all core javascript files

Returns the base URL of all core javascript files. If the base URL is not explicitly set, this method will publish the whole directory 'framework/web/js/source' and return the corresponding URL.

public string getPackageBaseUrl(string $name)
$name	string	the package name
{return}	string	the base URL for the named package. False is returned if the package is not registered yet.

Returns the base URL for a registered package with the specified name. If needed, this method may publish the assets of the package and returns the published base URL.

public bool hasPackage(string $name)
$name	string	the name of the script package.
{return}	bool

Checks if package is available.

public boolean isCssFileRegistered(string $url)
$url	string	URL of the CSS file
{return}	boolean	whether the CSS file is already registered

Checks whether the CSS file has been registered.

public boolean isCssRegistered(string $id)
$id	string	ID that uniquely identifies the CSS code
{return}	boolean	whether the CSS code is already registered

Checks whether the CSS code has been registered.

public boolean isScriptFileRegistered(string $url, integer $position=0)
$url	string	URL of the javascript file
$position	integer	the position of the JavaScript code. Valid values include the following: CClientScript::POS_HEAD : the script is inserted in the head section right before the title element. CClientScript::POS_BEGIN : the script is inserted at the beginning of the body section. CClientScript::POS_END : the script is inserted at the end of the body section.
{return}	boolean	whether the javascript file is already registered

Checks whether the JavaScript file has been registered.

public boolean isScriptRegistered(string $id, integer $position=4)
$id	string	ID that uniquely identifies the JavaScript code
$position	integer	the position of the JavaScript code. Valid values include the following: CClientScript::POS_HEAD : the script is inserted in the head section right before the title element. CClientScript::POS_BEGIN : the script is inserted at the beginning of the body section. CClientScript::POS_END : the script is inserted at the end of the body section. CClientScript::POS_LOAD : the script is inserted in the window.onload() function. CClientScript::POS_READY : the script is inserted in the jQuery's ready function.
{return}	boolean	whether the javascript code is already registered

Checks whether the JavaScript code has been registered.

protected void recordCachingAction(string $context, string $method, array $params)
$context	string	a property name of the controller. It refers to an object whose method is being called. If empty it means the controller itself.
$method	string	the method name
$params	array	parameters passed to the method

Records a method call when an output cache is in effect. This is a shortcut to Yii::app()->controller->recordCachingAction. In case when controller is absent, nothing is recorded.

public static registerCoreScript(string $name)
$name	string	the name of the script package.
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.5).

Registers a script package that is listed in packages.

public static registerCss(string $id, string $css, string $media='')
$id	string	ID that uniquely identifies this piece of CSS code
$css	string	the CSS code
$media	string	media that the CSS code should be applied to. If empty, it means all media types.
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.5).

Registers a piece of CSS code.

public static registerCssFile(string $url, string $media='')
$url	string	URL of the CSS file
$media	string	media that the CSS file should be applied to. If empty, it means all media types.
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.5).

Registers a CSS file

public static registerLinkTag(string $relation=NULL, string $type=NULL, string $href=NULL, string $media=NULL, array $options=array ( ))
$relation	string	rel attribute of the link tag. If null, the attribute will not be generated.
$type	string	type attribute of the link tag. If null, the attribute will not be generated.
$href	string	href attribute of the link tag. If null, the attribute will not be generated.
$media	string	media attribute of the link tag. If null, the attribute will not be generated.
$options	array	other options in name-value pairs
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.5).

Registers a link tag that will be inserted in the head section (right before the title element) of the resulting page.

public static registerMetaTag(string $content, string $name=NULL, string $httpEquiv=NULL, array $options=array ( ), string $id=NULL)
$content	string	content attribute of the meta tag
$name	string	name attribute of the meta tag. If null, the attribute will not be generated
$httpEquiv	string	http-equiv attribute of the meta tag. If null, the attribute will not be generated
$options	array	other options in name-value pairs (e.g. 'scheme', 'lang')
$id	string	Optional id of the meta tag to avoid duplicates
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.5).

Registers a meta tag that will be inserted in the head section (right before the title element) of the resulting page.

Note: Each call of this method will cause a rendering of new meta tag, even if their attributes are equal.

Example:

   $cs->registerMetaTag('example', 'description', null, array('lang' => 'en'));
   $cs->registerMetaTag('beispiel', 'description', null, array('lang' => 'de'));

public static registerPackage(string $name)
$name	string	the name of the script package.
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.5).

Registers a script package that is listed in packages. This method is the same as registerCoreScript.

public static registerScript(string $id, string $script, integer $position=NULL, array $htmlOptions=array ( ))
$id	string	ID that uniquely identifies this piece of JavaScript code
$script	string	the javascript code
$position	integer	the position of the JavaScript code. Valid values include the following: CClientScript::POS_HEAD : the script is inserted in the head section right before the title element. CClientScript::POS_BEGIN : the script is inserted at the beginning of the body section. CClientScript::POS_END : the script is inserted at the end of the body section. CClientScript::POS_LOAD : the script is inserted in the window.onload() function. CClientScript::POS_READY : the script is inserted in the jQuery's ready function.
$htmlOptions	array	additional HTML attributes Note: HTML attributes are not allowed for script positions "CClientScript::POS_LOAD" and "CClientScript::POS_READY".
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.5).

Registers a piece of javascript code.

public static registerScriptFile(string $url, integer $position=NULL, array $htmlOptions=array ( ))
$url	string	URL of the javascript file
$position	integer	the position of the JavaScript code. Valid values include the following: CClientScript::POS_HEAD : the script is inserted in the head section right before the title element. CClientScript::POS_BEGIN : the script is inserted at the beginning of the body section. CClientScript::POS_END : the script is inserted at the end of the body section.
$htmlOptions	array	additional HTML attributes
{return}	static	the CClientScript object itself (to support method chaining, available since version 1.1.5).

Registers a javascript file.

protected void remapScripts()

Uses scriptMap to re-map the registered scripts.

public void render(string &$output)
$output	string	the existing output that needs to be inserted with script tags

Renders the registered scripts. This method is called in CController::render when it finishes rendering content. CClientScript thus gets a chance to insert script tags at head and body sections in the HTML output.

public void renderBodyBegin(string &$output)
$output	string	the output to be inserted with scripts.

Inserts the scripts at the beginning of the body section.

public void renderBodyEnd(string &$output)
$output	string	the output to be inserted with scripts.

Inserts the scripts at the end of the body section.

public void renderCoreScripts()

Renders the specified core javascript library.

public void renderHead(string &$output)
$output	string	the output to be inserted with scripts.

Inserts the scripts in the head section.

protected string renderScriptBatch(array $scripts)
$scripts	array	script values to process.
{return}	string	HTML output

Composes script HTML block from the given script values, attempting to group scripts at single 'script' tag if possible.

public void reset()

Cleans all registered scripts.

public void setCoreScriptUrl(string $value)
$value	string	the base URL of all core javascript files.

Sets the base URL of all core javascript files. This setter is provided in case when core javascript files are manually published to a pre-specified location. This may save asset publishing time for large-scale applications.

protected void unifyScripts()

Removes duplicated scripts from scriptFiles.