CTheme
| Пакет | system.web |
|---|---|
| Наследование | класс CTheme » CComponent |
| С момента | 1.0 |
| Исходный код | framework/web/CTheme.php |
CTheme представляет тему приложения.
Свойства публичные
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| basePath | string | путь к папке темы | CTheme |
| baseUrl | string | относительный URL-адрес папки темы (без конечной косой черты) | CTheme |
| name | string | название темы | CTheme |
| skinPath | string | путь к папкам скинсов виджетов. | CTheme |
| systemViewPath | string | путь к папке системных представлений. | CTheme |
| viewPath | string | путь к папке представлений контроллеров. | CTheme |
Методы публичные
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с заданным именем, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CTheme |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| asa() | Возвращает объект поведения с заданным именем. | CComponent |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, можно ли считать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| detachBehavior() | Открепляет поведение от компонента. | CComponent |
| detachBehaviors() | Открепляет все поведения от компонента. | CComponent |
| detachEventHandler() | Открепляет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает прикрепленное поведение. | CComponent |
| disableBehaviors() | Отключает все прикрепленные к этому компоненту поведения. | CComponent |
| enableBehavior() | Включает прикрепленное поведение. | CComponent |
| enableBehaviors() | Включает все прикрепленные к этому компоненту поведения. | CComponent |
| evaluateExpression() | Вычисляет PHP-выражение или обратный вызов в контексте этого компонента. | CComponent |
| getBasePath() | Возвращает путь к папке темы | CTheme |
| getBaseUrl() | Возвращает относительный URL-адрес папки темы (без конечной косой черты) | CTheme |
| getEventHandlers() | Возвращает список прикрепленных обработчиков событий для события. | CComponent |
| getLayoutFile() | Находит файл макета для макета указанного контроллера. | CTheme |
| getName() | Возвращает имя темы | CTheme |
| getSkinPath() | Возвращает путь к папкам скинсов виджетов. По умолчанию 'ThemeRoot/views/skins'. | CTheme |
| getSystemViewPath() | Возвращает путь к папке системных представлений. По умолчанию 'ThemeRoot/views/system'. | CTheme |
| getViewFile() | Находит файл представления для представления указанного контроллера. | CTheme |
| getViewPath() | Возвращает путь к папке представлений контроллеров. По умолчанию 'ThemeRoot/views'. | CTheme |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли у события прикрепленные обработчики. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| raiseEvent() | Вызывает событие. | CComponent |
Подробности свойств
basePath свойство только для чтения
public string getBasePath()
путь к папке темы
baseUrl свойство только для чтения
public string getBaseUrl()
относительный URL-адрес папки темы (без конечной косой черты)
name свойство только для чтения
public string getName()
название темы
skinPath свойство только для чтения (доступно с версии 1.1)
public string getSkinPath()
путь к папкам скинсов виджетов. По умолчанию 'ThemeRoot/views/skins'.
systemViewPath свойство только для чтения
public string getSystemViewPath()
путь к папке системных представлений. По умолчанию 'ThemeRoot/views/system'.
viewPath свойство только для чтения
public string getViewPath()
путь к папке представлений контроллеров. По умолчанию 'ThemeRoot/views'.
Подробности методов
__construct() метод
public void __construct(string $name, string $basePath, string $baseUrl) | ||
| $name | string | имя темы |
| $basePath | string | базовый путь к теме |
| $baseUrl | string | базовый URL-адрес темы |
Исходный код: framework/web/CTheme.php#37 (показать)
public function __construct($name,$basePath,$baseUrl)
{
$this->_name=$name;
$this->_baseUrl=$baseUrl;
$this->_basePath=$basePath;
}
Конструктор.
getBasePath() метод
public string getBasePath() | ||
| {return} | string | путь к папке темы |
Исходный код: framework/web/CTheme.php#63 (показать)
public function getBasePath()
{
return $this->_basePath;
}
getBaseUrl() метод
public string getBaseUrl() | ||
| {return} | string | относительный URL-адрес папки темы (без конечной косой черты) |
Исходный код: framework/web/CTheme.php#55 (показать)
public function getBaseUrl()
{
return $this->_baseUrl;
}
getLayoutFile() метод
public string getLayoutFile(CController $controller, string $layoutName) | ||
| $controller | CController | контроллер |
| $layoutName | строка | имя макета |
| {return} | строка | путь к файлу макета. False, если файл не существует. |
Исходный код: framework/web/CTheme.php#113 (показать)
public function getLayoutFile($controller,$layoutName)
{
$moduleViewPath=$basePath=$this->getViewPath();
$module=$controller->getModule();
if(empty($layoutName))
{
while($module!==null)
{
if($module->layout===false)
return false;
if(!empty($module->layout))
break;
$module=$module->getParentModule();
}
if($module===null)
$layoutName=Yii::app()->layout;
else
{
$layoutName=$module->layout;
$moduleViewPath.='/'.$module->getId();
}
}
elseif($module!==null)
$moduleViewPath.='/'.$module->getId();
return $controller->resolveViewFile($layoutName,$moduleViewPath.'/layouts',$basePath,$moduleViewPath);
}
Находит файл макета для указанного макета контроллера.
getName() метод
public string getName() | ||
| {return} | строка | имя темы |
Исходный код: framework/web/CTheme.php#47 (показать)
public function getName()
{
return $this->_name;
}
getSkinPath() метод (доступен с версии v1.1)
public string getSkinPath() | ||
| {return} | строка | путь к папкам с темами виджетов. По умолчанию 'ThemeRoot/views/skins'. |
Исходный код: framework/web/CTheme.php#88 (показать)
public function getSkinPath()
{
return $this->getViewPath().DIRECTORY_SEPARATOR.'skins';
}
getSystemViewPath() метод
public string getSystemViewPath() | ||
| {return} | строка | путь к системным представлениям. По умолчанию 'ThemeRoot/views/system'. |
Исходный код: framework/web/CTheme.php#79 (показать)
public function getSystemViewPath()
{
return $this->getViewPath().DIRECTORY_SEPARATOR.'system';
}
getViewFile() метод
public string getViewFile(CController $controller, string $viewName) | ||
| $controller | CController | контроллер |
| $viewName | строка | имя представления |
| {return} | строка | путь к файлу представления. False, если файл не существует. |
Исходный код: framework/web/CTheme.php#99 (показать)
public function getViewFile($controller,$viewName)
{
$moduleViewPath=$this->getViewPath();
if(($module=$controller->getModule())!==null)
$moduleViewPath.='/'.$module->getId();
return $controller->resolveViewFile($viewName,$this->getViewPath().'/'.$controller->getUniqueId(),$this->getViewPath(),$moduleViewPath);
}
Находит файл представления для указанного представления контроллера.
getViewPath() метод
public string getViewPath() | ||
| {return} | строка | путь к представлениям контроллеров. По умолчанию 'ThemeRoot/views'. |
Исходный код: framework/web/CTheme.php#71 (показать)
public function getViewPath()
{
return $this->_basePath.DIRECTORY_SEPARATOR.'views';
}
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CTheme
