0 follower

CClientScript

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

CClientScript manages JavaScript and CSS stylesheets for views.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
behaviors	array	the behaviors that should be attached to this component.	CApplicationComponent
coreScriptUrl	string	Returns the base URL of all core javascript files.	CClientScript
enableJavaScript	boolean	whether JavaScript should be enabled.	CClientScript
isInitialized	boolean	whether this application component has been initialized (i.e., init() is invoked.	CApplicationComponent
scriptMap	array	the mapping between script file names and the corresponding script URLs.	CClientScript

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
cssFiles	array	the registered CSS files (CSS URL=>media type).	CClientScript
scriptFiles	array	the registered JavaScript files (position, key => URL)	CClientScript
scripts	array	the registered JavaScript code blocks (position, key => code)	CClientScript

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
getCoreScriptUrl()	Returns the base URL of all core javascript files.	CClientScript
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getIsInitialized()	Checks whether this application component has been initialized (i.e., init() is invoked.)	CApplicationComponent
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
init()	Initializes the application component.	CApplicationComponent
isCssFileRegistered()	Checks whether the CSS file has been registered.	CClientScript
isCssRegistered()	Checks whether the CSS code has been registered.	CClientScript
isScriptFileRegistered()	Checks whether the JavaScript file has been registered.	CClientScript
isScriptRegistered()	Checks whether the JavaScript code has been registered.	CClientScript
raiseEvent()	Raises an event.	CComponent
registerCoreScript()	Registers a core javascript library.	CClientScript
registerCss()	Registers a piece of CSS code.	CClientScript
registerCssFile()	Registers a CSS file	CClientScript
registerLinkTag()	Registers a link tag that will be inserted in the head section (right before the title element) of the resulting page.	CClientScript
registerMetaTag()	Registers a meta tag that will be inserted in the head section (right before the title element) of the resulting page.	CClientScript
registerScript()	Registers a piece of javascript code.	CClientScript
registerScriptFile()	Registers a javascript file.	CClientScript
render()	Renders the registered scripts.	CClientScript
renderBodyBegin()	Inserts the scripts at the beginning of the body section.	CClientScript
renderBodyEnd()	Inserts the scripts at the end of the body section.	CClientScript
renderCoreScripts()	Renders the specified core javascript library.	CClientScript
renderHead()	Inserts the scripts in the head section.	CClientScript
reset()	Cleans all registered scripts.	CClientScript
setCoreScriptUrl()	Sets the base URL of all core javascript files.	CClientScript

Protected Methods

Hide inherited methods

Method	Description	Defined By
recordCachingAction()	Records a method call when an output cache is in effect.	CClientScript
remapScripts()	Uses scriptMap to re-map the registered scripts.	CClientScript

Property Details

coreScriptUrl property

public string getCoreScriptUrl()
public void setCoreScriptUrl(string $value)

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.

cssFiles property (available since v1.0.4)

protected array $cssFiles;

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

enableJavaScript property

public boolean $enableJavaScript;

whether JavaScript should be enabled. Defaults to true.

scriptFiles property (available since v1.0.4)

protected array $scriptFiles;

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

scriptMap property (available since v1.0.3)

public array $scriptMap;

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

scripts property (available since v1.0.5)

protected array $scripts;

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

Method Details

getCoreScriptUrl() method

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

Source Code: framework/web/CClientScript.php#326 (show)


public function getCoreScriptUrl()
{
    if($this->_baseUrl!==null)
        return $this->_baseUrl;
    else
        return $this->_baseUrl=Yii::app()->getAssetManager()->publish(YII_PATH.'/web/js/source');
}

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.

isCssFileRegistered() method

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

Source Code: framework/web/CClientScript.php#494 (show)


public function isCssFileRegistered($url)
{
    return isset($this->cssFiles[$url]);
}

Checks whether the CSS file has been registered.

isCssRegistered() method

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

Source Code: framework/web/CClientScript.php#504 (show)


public function isCssRegistered($id)
{
    return isset($this->_css[$id]);
}

Checks whether the CSS code has been registered.

isScriptFileRegistered() method

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

Source Code: framework/web/CClientScript.php#520 (show)


public function isScriptFileRegistered($url,$position=self::POS_HEAD)
{
    return isset($this->scriptFiles[$position][$url]);
}

Checks whether the JavaScript file has been registered.

isScriptRegistered() method

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

Source Code: framework/web/CClientScript.php#538 (show)


public function isScriptRegistered($id,$position=self::POS_READY)
{
    return isset($this->scripts[$position][$id]);
}

Checks whether the JavaScript code has been registered.

recordCachingAction() method (available since v1.0.5)

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

Source Code: framework/web/CClientScript.php#554 (show)


protected function recordCachingAction($context,$method,$params)
{
    if(($controller=Yii::app()->getController())!==null)
        $controller->recordCachingAction($context,$method,$params);
}

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 void 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

Source Code: framework/web/CClientScript.php#473 (show)


public function registerLinkTag($relation=null,$type=null,$href=null,$media=null,$options=array())
{
    $this->_hasScripts=true;
    if($relation!==null)
        $options['rel']=$relation;
    if($type!==null)
        $options['type']=$type;
    if($href!==null)
        $options['href']=$href;
    if($media!==null)
        $options['media']=$media;
    $this->_links[serialize($options)]=$options;
    $params=func_get_args();
    $this->recordCachingAction('clientScript','registerLinkTag',$params);
}

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

registerMetaTag() method (available since v1.0.1)

public void registerMetaTag(string $content, string $name=NULL, string $httpEquiv=NULL, array $options=array ( ))
$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')

Source Code: framework/web/CClientScript.php#451 (show)


public function registerMetaTag($content,$name=null,$httpEquiv=null,$options=array())
{
    $this->_hasScripts=true;
    $options['content']=$content;
    if($name!==null)
        $options['name']=$name;
    if($httpEquiv!==null)
        $options['http-equiv']=$httpEquiv;
    $this->_metas[serialize($options)]=$options;
    $params=func_get_args();
    $this->recordCachingAction('clientScript','registerMetaTag',$params);
}

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

registerScript() method

public void registerScript(string $id, string $script, integer $position=4)
$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.

Source Code: framework/web/CClientScript.php#433 (show)


public function registerScript($id,$script,$position=self::POS_READY)
{
    $this->_hasScripts=true;
    $this->scripts[$position][$id]=$script;
    if($position===self::POS_READY)
        $this->registerCoreScript('jquery');
    $params=func_get_args();
    $this->recordCachingAction('clientScript','registerScript',$params);
}

Registers a piece of javascript code.

registerScriptFile() method

public void registerScriptFile(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.

Source Code: framework/web/CClientScript.php#412 (show)


public function registerScriptFile($url,$position=self::POS_HEAD)
{
    $this->_hasScripts=true;
    $this->scriptFiles[$position][$url]=$url;
    $params=func_get_args();
    $this->recordCachingAction('clientScript','registerScriptFile',$params);
}

Registers a javascript file.

remapScripts() method (available since v1.0.3)

protected void remapScripts()

Source Code: framework/web/CClientScript.php#129 (show)


protected function remapScripts()
{
    $cssFiles=array();
    foreach($this->cssFiles as $url=>$media)
    {
        $name=basename($url);
        if(isset($this->scriptMap[$name]))
        {
            if($this->scriptMap[$name]!==false)
                $cssFiles[$this->scriptMap[$name]]=$media;
        }
        else if(isset($this->scriptMap['*.css']))
        {
            if($this->scriptMap['*.css']!==false)
                $cssFiles[$this->scriptMap['*.css']]=$media;
        }
        else
            $cssFiles[$url]=$media;
    }
    $this->cssFiles=$cssFiles;

    $jsFiles=array();
    foreach($this->scriptFiles as $position=>$scripts)
    {
        $jsFiles[$position]=array();
        foreach($scripts as $key=>$script)
        {
            $name=basename($script);
            if(isset($this->scriptMap[$name]))
            {
                if($this->scriptMap[$name]!==false)
                    $jsFiles[$position][$this->scriptMap[$name]]=$this->scriptMap[$name];
            }
            else if(isset($this->scriptMap['*.js']))
            {
                if($this->scriptMap['*.js']!==false)
                    $jsFiles[$position][$this->scriptMap['*.js']]=$this->scriptMap['*.js'];
            }
            else
                $jsFiles[$position][$key]=$script;
        }
    }
    $this->scriptFiles=$jsFiles;
}

Uses scriptMap to re-map the registered scripts.

render() method

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

Source Code: framework/web/CClientScript.php#107 (show)


public function render(&$output)
{
    if(!$this->_hasScripts)
        return;

    $this->renderCoreScripts();

    if(!empty($this->scriptMap))
        $this->remapScripts();

    $this->renderHead($output);
    if($this->enableJavaScript)
    {
        $this->renderBodyBegin($output);
        $this->renderBodyEnd($output);
    }
}

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.

renderBodyBegin() method

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

Source Code: framework/web/CClientScript.php#256 (show)


public function renderBodyBegin(&$output)
{
    $html='';
    if(isset($this->scriptFiles[self::POS_BEGIN]))
    {
        foreach($this->scriptFiles[self::POS_BEGIN] as $scriptFile)
            $html.=CHtml::scriptFile($scriptFile)."\n";
    }
    if(isset($this->scripts[self::POS_BEGIN]))
        $html.=CHtml::script(implode("\n",$this->scripts[self::POS_BEGIN]))."\n";

    if($html!=='')
    {
        $count=0;
        $output=preg_replace('/(<body\b[^>]*>)/is','$1<###begin###>',$output,1,$count);
        if($count)
            $output=str_replace('<###begin###>',$html,$output);
        else
            $output=$html.$output;
    }
}

Inserts the scripts at the beginning of the body section.

renderBodyEnd() method

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

Source Code: framework/web/CClientScript.php#282 (show)


public function renderBodyEnd(&$output)
{
    if(!isset($this->scriptFiles[self::POS_END]) && !isset($this->scripts[self::POS_END])
        && !isset($this->scripts[self::POS_READY]) && !isset($this->scripts[self::POS_LOAD]))
        return;

    $fullPage=0;
    $output=preg_replace('/(<\\/body\s*>)/is','<###end###>$1',$output,1,$fullPage);
    $html='';
    if(isset($this->scriptFiles[self::POS_END]))
    {
        foreach($this->scriptFiles[self::POS_END] as $scriptFile)
            $html.=CHtml::scriptFile($scriptFile)."\n";
    }
    $scripts=isset($this->scripts[self::POS_END]) ? $this->scripts[self::POS_END] : array();
    if(isset($this->scripts[self::POS_READY]))
    {
        if($fullPage)
            $scripts[]="jQuery(document).ready(function() {\n".implode("\n",$this->scripts[self::POS_READY])."\n});";
        else
            $scripts[]=implode("\n",$this->scripts[self::POS_READY]);
    }
    if(isset($this->scripts[self::POS_LOAD]))
    {
        if($fullPage)
            $scripts[]="window.onload=function() {\n".implode("\n",$this->scripts[self::POS_LOAD])."\n};";
        else
            $scripts[]=implode("\n",$this->scripts[self::POS_LOAD]);
    }
    if(!empty($scripts))
        $html.=CHtml::script(implode("\n",$scripts))."\n";

    if($fullPage)
        $output=str_replace('<###end###>',$html,$output);
    else
        $output=$output.$html;
}

Inserts the scripts at the end of the body section.

renderCoreScripts() method (available since v1.0.3)

public void renderCoreScripts()

Source Code: framework/web/CClientScript.php#178 (show)


public function renderCoreScripts()
{
    if($this->_packages===null)
        return;
    $baseUrl=$this->getCoreScriptUrl();
    $cssFiles=array();
    $jsFiles=array();
    foreach($this->_coreScripts as $name)
    {
        foreach($this->_packages[$name] as $path)
        {
            $url=$baseUrl.'/'.$path;
            if(substr($path,-4)==='.css')
                $cssFiles[$url]='';
            else
                $jsFiles[$url]=$url;
        }
    }
    // merge in place
    if($cssFiles!==array())
    {
        foreach($this->cssFiles as $cssFile=>$media)
            $cssFiles[$cssFile]=$media;
        $this->cssFiles=$cssFiles;
    }
    if($jsFiles!==array())
    {
        if(isset($this->scriptFiles[self::POS_HEAD]))
        {
            foreach($this->scriptFiles[self::POS_HEAD] as $url)
                $jsFiles[$url]=$url;
        }
        $this->scriptFiles[self::POS_HEAD]=$jsFiles;
    }
}

Renders the specified core javascript library.

renderHead() method

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

Source Code: framework/web/CClientScript.php#218 (show)


public function renderHead(&$output)
{
    $html='';
    foreach($this->_metas as $meta)
        $html.=CHtml::metaTag($meta['content'],null,null,$meta)."\n";
    foreach($this->_links as $link)
        $html.=CHtml::linkTag(null,null,null,null,$link)."\n";
    foreach($this->cssFiles as $url=>$media)
        $html.=CHtml::cssFile($url,$media)."\n";
    foreach($this->_css as $css)
        $html.=CHtml::css($css[0],$css[1])."\n";
    if($this->enableJavaScript)
    {
        if(isset($this->scriptFiles[self::POS_HEAD]))
        {
            foreach($this->scriptFiles[self::POS_HEAD] as $scriptFile)
                $html.=CHtml::scriptFile($scriptFile)."\n";
        }

        if(isset($this->scripts[self::POS_HEAD]))
            $html.=CHtml::script(implode("\n",$this->scripts[self::POS_HEAD]))."\n";
    }

    if($html!=='')
    {
        $count=0;
        $output=preg_replace('/(<title\b[^>]*>|<\\/head\s*>)/is','<###head###>$1',$output,1,$count);
        if($count)
            $output=str_replace('<###head###>',$html,$output);
        else
            $output=$html.$output;
    }
}

Inserts the scripts in the head section.

reset() method

public void reset()

Source Code: framework/web/CClientScript.php#86 (show)


public function reset()
{
    $this->_hasScripts=false;
    $this->_coreScripts=array();
    $this->cssFiles=array();
    $this->_css=array();
    $this->scriptFiles=array();
    $this->scripts=array();
    $this->_metas=array();
    $this->_links=array();

    $this->recordCachingAction('clientScript','reset',array());
}

Cleans all registered scripts.

setCoreScriptUrl() method

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

Source Code: framework/web/CClientScript.php#340 (show)


public function setCoreScriptUrl($value)
{
    $this->_baseUrl=$value;
}

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.