CGoogleApi.php
2.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<?php
/**
* CGoogleApi class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright © 2008-2011 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
/**
* CGoogleApi provides helper methods to easily access the {@link https://developers.google.com/loader/ Google API loader}.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
* @package system.web.helpers
*/
class CGoogleApi
{
/**
* @var string Protocol relative url to the Google API loader which allows easy access
* to most of the Google AJAX APIs
*/
public static $bootstrapUrl='//www.google.com/jsapi';
/**
* Renders the jsapi script file.
* @param string $apiKey the API key. Null if you do not have a key.
* @return string the script tag that loads Google jsapi.
*/
public static function init($apiKey=null)
{
if($apiKey===null)
return CHtml::scriptFile(self::$bootstrapUrl);
else
return CHtml::scriptFile(self::$bootstrapUrl.'?key='.$apiKey);
}
/**
* Loads the specified API module.
* Note that you should call {@link init} first.
* @param string $name the module name
* @param string $version the module version
* @param array $options additional js options that are to be passed to the load() function.
* @return string the js code for loading the module. You can use {@link CHtml::script()}
* to enclose it in a script tag.
*/
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).");";
}
/**
* Registers the specified API module.
* This is similar to {@link load} except that it registers the loading code
* with {@link CClientScript} instead of returning it.
* This method also registers the jsapi script needed by the loading call.
* @param string $name the module name
* @param string $version the module version
* @param array $options additional js options that are to be passed to the load() function.
* @param string $apiKey the API key. Null if you do not have a key.
*/
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);
$js=self::load($name,$version,$options);
$cs->registerScript($name,$js,CClientScript::POS_HEAD);
}
}