system system.base system.caching system.caching.dependencies system.collections system.console system.db system.db.ar system.db.schema system.db.schema.cubrid system.db.schema.mssql system.db.schema.mysql system.db.schema.oci system.db.schema.pgsql system.db.schema.sqlite system.gii system.i18n system.i18n.gettext system.logging system.test system.utils system.validators system.web system.web.actions system.web.auth system.web.filters system.web.form system.web.helpers system.web.renderers system.web.services system.web.widgets system.web.widgets.captcha system.web.widgets.pagers zii.behaviors zii.widgets zii.widgets.grid zii.widgets.jui

CGoogleApi

system.web.helpers
继承 class CGoogleApi
源码 framework/web/helpers/CGoogleApi.php
CGoogleApi provides helper methods to easily access the Google API loader.

公共属性

隐藏继承的属性

属性类型描述被定义在
bootstrapUrl string Protocol relative url to the Google API loader which allows easy access to most of the Google AJAX APIs CGoogleApi

公共方法

隐藏继承的方法

方法描述被定义在
init() Renders the jsapi script file. CGoogleApi
load() Loads the specified API module. CGoogleApi
register() Registers the specified API module. CGoogleApi

属性详情

bootstrapUrl 属性
public static string $bootstrapUrl;

Protocol relative url to the Google API loader which allows easy access to most of the Google AJAX APIs

方法详情

init() 方法
public static string init(string $apiKey=NULL)
$apiKey string the API key. Null if you do not have a key.
{return} string the script tag that loads Google jsapi.
源码: framework/web/helpers/CGoogleApi.php#30 (显示)
public static function init($apiKey=null)
{
    if(
$apiKey===null)
        return 
CHtml::scriptFile(self::$bootstrapUrl);
    else
        return 
CHtml::scriptFile(self::$bootstrapUrl.'?key='.$apiKey);
}

Renders the jsapi script file.

load() 方法
public static string load(string $name, string $version='1', array $options=array ( ))
$name string the module name
$version string the module version
$options array additional js options that are to be passed to the load() function.
{return} string the js code for loading the module. You can use CHtml::script() to enclose it in a script tag.
源码: framework/web/helpers/CGoogleApi.php#47 (显示)
public static function load($name,$version='1',$options=array())
{
    if(empty(
$options))
        return 
"google.load(\"{$name}\",\"{$version}\");";
    else
        return 
"google.load(\"{$name}\",\"{$version}\",".CJavaScript::encode($options).");";
}

Loads the specified API module. Note that you should call init first.

register() 方法
public static void register(string $name, string $version='1', array $options=array ( ), string $apiKey=NULL)
$name string the module name
$version string the module version
$options array additional js options that are to be passed to the load() function.
$apiKey string the API key. Null if you do not have a key.
源码: framework/web/helpers/CGoogleApi.php#65 (显示)
public static function register($name,$version='1',$options=array(),$apiKey=null)
{
    
$cs=Yii::app()->getClientScript();
    
$url=$apiKey===null?self::$bootstrapUrl:self::$bootstrapUrl.'?key='.$apiKey;
    
$cs->registerScriptFile($url,CClientScript::POS_HEAD);

    
$js=self::load($name,$version,$options);
    
$cs->registerScript($name,$js,CClientScript::POS_HEAD);
}

Registers the specified API module. This is similar to load except that it registers the loading code with CClientScript instead of returning it. This method also registers the jsapi script needed by the loading call.