Используем функции быстрого доступа (глобальные функции в Yii)

С целью легкого интегрирование фреймворка со сторонними библиотеками, разработчики Yii не используют в коде глобальных функций. В Yii все необходимо решать при помощи полного названия класса или диапазона обьектов.

Например, чтобы получить доступ к данным текущего пользователя, мы должны использовать Yii::app()->user. Что бы обратиться к параметрам нашего приложения, мы должны использовать Yii::app()->params[название] и так далее.

Хотя всевозможные редакторы кода (IDE) могут немного облегчить печать этих длинных имен, лучшим вариантов будет использовать глобальные функции...

Мы можем хранить наши глобальные функции быстрого доступа в файле globals.php. Теперь что бы эти функции были доступны внутри приложения, откроем файл index.php и добавим в его начало:

require('path/to/globals.php');
require('path/to/yii.php');
......

Теперь вы можете использовать ваши глобальные функции в любом месте вашего приложения. Например, что бы получить доступ к данным пользователя мы можем использовать user() вместо Yii::app()->user

Примечание: Не используйте функции быстрого доступа в ваших компонентах, если вы собираетесь в дальнейшем использовать их в разных приложениях (или распространять). Это сделает ваши компоненты не пригодными если функции быстрого доступа не будут определены в других приложениях. Также обратите внимание что ваши глобальные функции могут быть причиной конфликта при использовании сторонних библиотек. Поэтому постарайтесь для глобальных функций использовать не сильно распространенные имена (прим. переводчика)

Ниже приведен код, содержащий список наиболее используемых функций быстрого доступа. Вы можете настроить их под свой вкус!

defined('DS') or define('DS',DIRECTORY_SEPARATOR);
 
/**
 * Быстрый доступ к Yii::app()
 */
function app()
{
    return Yii::app();
}
 
/**
 * Быстрый доступ к Yii::app()->clientScript
 */
function cs()
{
    return Yii::app()->clientScript;
}
 
/**
 * Быстрый доступ к Yii::app()->createUrl()
 */
function url($route,$params=array(),$ampersand='&')
{
    return Yii::app()->createUrl($route,$params,$ampersand);
}
 
/**
 * Быстрый доступ к CHtml::encode
 */
function h($text)
{
    return htmlspecialchars($text,ENT_QUOTES,Yii::app()->charset);
}
 
/**
 * Быстрый доступ к CHtml::link()
 */
function l($text, $url = '#', $htmlOptions = array()) 
{
    return CHtml::link($text, $url, $htmlOptions);
}
 
/**
 * Быстрый доступ к Yii::t(). По умолчанию, используется категория 'stay'
 */
function t($message, $category = 'stay', $params = array(), $source = null, $language = null) 
{
    return Yii::t($category, $message, $params, $source, $language);
}
 
/**
 * Быстрый доступ к  Yii::app()->request->baseUrl
 * Если вы используете параметр $url - он будет добавлен как префикс к baseUrl.
 */
function bu($url=null) 
{
    static $baseUrl;
    if ($baseUrl===null)
        $baseUrl=Yii::app()->request->baseUrl;
    return $url===null ? $baseUrl : $baseUrl.'/'.ltrim($url,'/');
}
 
/**
 * Быстрый доступ к Yii::app()->params[$name].
 */
function param($name) 
{
    return Yii::app()->params[$name];
}
 
/**
 * Быстрый доступ к Yii::app()->user.
 */
function user() 
{
    return Yii::app()->user;
}

• Оригинал "Use shortcut functions to reduce typing" [англ.]