CGoogleApi
| Пакет | system.web.helpers |
|---|---|
| Наследование | класс CGoogleApi |
| Исходный код | framework/web/helpers/CGoogleApi.php |
CGoogleApi предоставляет вспомогательные методы для удобного доступа к загрузчику API Google Google API loader.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| bootstrapUrl | строка | Относительный URL загрузчика Google API, обеспечивающий легкий доступ к большинству AJAX-API Google | CGoogleApi |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| init() | Отображает файл скрипта jsapi. | CGoogleApi |
| load() | Загружает указанный модуль API. | CGoogleApi |
| register() | Регистрирует указанный модуль API. | CGoogleApi |
Подробное описание свойств
bootstrapUrl свойство
public static string $bootstrapUrl;
Относительный URL загрузчика Google API, обеспечивающий легкий доступ к большинству AJAX-API Google.
Подробное описание методов
init() метод
public static string init(string $apiKey=NULL) | ||
| $apiKey | строка | ключ API. Null, если ключ не задан. |
| {return} | строка | тег скрипта, загружающий 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);
}
Отображает файл скрипта jsapi.
load() метод
public static string load(string $name, string $version='1', array $options=array ( )) | ||
| $name | строка | имя модуля |
| $version | строка | версия модуля |
| $options | массив | дополнительные js параметры, которые должны быть переданы в функцию load(). |
| {return} | строка | js-код для загрузки модуля. Вы можете использовать CHtml::script() для вложения его в тег скрипта. |
Исходный код: 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).");";
}
Загружает указанный модуль API. Обратите внимание, что вы должны сначала вызвать init.
register() метод
public static void register(string $name, string $version='1', array $options=array ( ), string $apiKey=NULL) | ||
| $name | строка | имя модуля |
| $version | строка | версия модуля |
| $options | массив | дополнительные js параметры, которые должны быть переданы в функцию load(). |
| $apiKey | строка | ключ API. Null, если ключ не задан. |
Исходный код: 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);
}
Регистрирует указанный модуль API. Это аналогично load, за исключением того, что он регистрирует код загрузки с CClientScript вместо возврата его. Этот метод также регистрирует jsapi-скрипт, необходимый для вызова загрузки.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CGoogleApi
