CWidget

Подробное описание свойств

actionPrefix свойство

public string $actionPrefix;

Префикс для ID действий. Когда виджет объявлен как поставщик действий в CController::actions, можно указать префикс для различения его ID действий от других. Тот же префикс затем должен быть использован для настройки этого свойства при использовании виджета в представлении контроллера.

controller свойство только для чтения

public CController getController()

Возвращает контроллер, к которому принадлежит этот виджет.

id свойство

public string getId(boolean $autoGenerate=true)
public void setId(string $value)

Возвращает ID виджета или генерирует новый, если требуется.

owner свойство только для чтения

public CBaseController getOwner()

Возвращает владельца/создателя этого виджета.

skin свойство (доступно начиная с v1.1)

public mixed $skin;

Имя используемой темы этого виджета. По умолчанию 'default'. Если установлено false, тема к этому виджету не будет применена.

viewPath свойство только для чтения

public string getViewPath(boolean $checkTheme=false)

Возвращает директорию, содержащую файлы представлений для этого виджета. По умолчанию возвращает поддиректорию 'views' директории, содержащей файл класса виджета. Если $checkTheme установлен в true, будет возвращена директория "ThemeID/views/ClassName", если она существует.

Подробное описание методов

__construct() метод

public void __construct(CBaseController $owner=NULL)

public function __construct($owner=null)
{
    $this->_owner=$owner===null?Yii::app()->getController():$owner;
}

Конструктор.

actions() метод

public static array actions()

public static function actions()
{
    return array();
}

Возвращает список действий, используемых этим виджетом. Структура возвращаемого значения этого метода похожа на возвращаемое значение CController::actions.

Если виджет использует несколько действий, вы можете объявить эти действия с помощью этого метода. В таком случае виджет станет поставщиком действий, и их можно легко импортировать в контроллер.

Обратите внимание, при создании URL-адресов, ссылающихся на действия, перечисленные в этом методе, убедитесь, что идентификаторы действий опережаются префиксом actionPrefix.

getController() метод

public CController getController()

public function getController()
{
    if($this->_owner instanceof CController)
        return $this->_owner;
    else
        return Yii::app()->getController();
}

Возвращает контроллер, к которому принадлежит этот виджет.

getId() метод

public string getId(boolean $autoGenerate=true)

public function getId($autoGenerate=true)
{
    if($this->_id!==null)
        return $this->_id;
    elseif($autoGenerate)
        return $this->_id='yw'.self::$_counter++;
}

Возвращает ID виджета или генерирует новый, если запрошено.

getOwner() метод

public CBaseController getOwner()

public function getOwner()
{
    return $this->_owner;
}

Возвращает владельца/создателя этого виджета.

getViewFile() метод

public string getViewFile(string $viewName)

public function getViewFile($viewName)
{
    if(($renderer=Yii::app()->getViewRenderer())!==null)
        $extension=$renderer->fileExtension;
    else
        $extension='.php';
    if(strpos($viewName,'.')) // a path alias
        $viewFile=Yii::getPathOfAlias($viewName);
    else
    {
        $viewFile=$this->getViewPath(true).DIRECTORY_SEPARATOR.$viewName;
        if(is_file($viewFile.$extension))
            return Yii::app()->findLocalizedFile($viewFile.$extension);
        elseif($extension!=='.php' && is_file($viewFile.'.php'))
            return Yii::app()->findLocalizedFile($viewFile.'.php');
        $viewFile=$this->getViewPath(false).DIRECTORY_SEPARATOR.$viewName;
    }

    if(is_file($viewFile.$extension))
        return Yii::app()->findLocalizedFile($viewFile.$extension);
    elseif($extension!=='.php' && is_file($viewFile.'.php'))
        return Yii::app()->findLocalizedFile($viewFile.'.php');
    else
        return false;
}

Ищет файл сценария представления по имени представления. Этот метод будет искать представление в viewPath виджета. Файл сценария представления имеет имя "ViewName.php". Может быть возвращён локализованный файл представления, если необходима локализация. Подробнее см. CApplication::findLocalizedFile. Имя представления также может ссылаться на псевдоним пути, если он содержит точки.

getViewPath() метод

public string getViewPath(boolean $checkTheme=false)

public function getViewPath($checkTheme=false)
{
    $className=get_class($this);
    $scope=$checkTheme?'theme':'local';
    if(isset(self::$_viewPaths[$className][$scope]))
        return self::$_viewPaths[$className][$scope];
    else
    {
        if($checkTheme && ($theme=Yii::app()->getTheme())!==null)
        {
            $path=$theme->getViewPath().DIRECTORY_SEPARATOR;
            if(strpos($className,'\\')!==false) // namespaced class
                $path.=str_replace('\\','_',ltrim($className,'\\'));
            else
                $path.=$className;
            if(is_dir($path))
                return self::$_viewPaths[$className]['theme']=$path;
        }

        $class=new ReflectionClass($className);
        return self::$_viewPaths[$className]['local']=dirname($class->getFileName()).DIRECTORY_SEPARATOR.'views';
    }
}

Возвращает директорию, содержащую файлы представлений для этого виджета. По умолчанию возвращает поддиректорию 'views' в директории, содержащей файл класса виджета. Если $checkTheme установлено в true, возвращается директория "ThemeID/views/ClassName", если она существует.

init() метод

public void init()

public function init()
{
}

Инициализирует виджет. Этот метод вызывается CBaseController::createWidget и CBaseController::beginWidget после инициализации свойств виджета.

render() метод

public string render(string $view, array $data=NULL, boolean $return=false)

public function render($view,$data=null,$return=false)
{
    if(($viewFile=$this->getViewFile($view))!==false)
        return $this->renderFile($viewFile,$data,$return);
    else
        throw new CException(Yii::t('yii','{widget} cannot find the view "{view}".',
            array('{widget}'=>get_class($this), '{view}'=>$view)));
}

Рендерит представление.

Имя представления ссылается на скрипт PHP (разрешается через getViewFile), который включается этим методом. Если $data является ассоциативным массивом, он будет извлечён как переменные PHP и будет доступен в скрипте.

run() метод

public void run()

public function run()
{
}

Выполняет виджет. Этот метод вызывается CBaseController::endWidget.

setId() метод

public void setId(string $value)

public function setId($value)
{
    $this->_id=$value;
}

Устанавливает ID виджета.