Versions
Look up a class, method, property or event

CGoogleApi

Package system.web.helpers
Inheritance class CGoogleApi
Since 1.0.3
Version $Id: CGoogleApi.php 757 2009-02-26 21:13:19Z qiang.xue $
CGoogleApi provides helper methods to easily access Google AJAX APIs.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
init() Renders the jsapi script file. CGoogleApi
load() Loads the specified API module. CGoogleApi
register() Registers the specified API module. CGoogleApi

Method Details

init() method
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.

Renders the jsapi script file.

load() method
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.

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

register() method
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.

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.

Be the first person to leave a comment

Please to leave your comment.