CWidgetFactory

CWidgetFactory создаёт новые виджеты для использования в представлениях.

CWidgetFactory используется в качестве компонента приложения по умолчанию "widgetFactory".

При вызове CBaseController::createWidget, CBaseController::widget или CBaseController::beginWidget, если компонент "widgetFactory" установлен, он будет использован для создания запрошенного виджета. Для установки компонента "widgetFactory" необходимо следующее конфигурирование приложения:

return array(
    'components'=>array(
        'widgetFactory'=>array(
            'class'=>'CWidgetFactory',
        ),
    ),
)

CWidgetFactory реализует функцию "skin", которая позволяет создать и инициализировать новый виджет с набором предопределённых значений свойств (называемых skin).

Когда CWidgetFactory используется для создания нового виджета, он сначала создаёт экземпляр виджета. Затем он проверяет, доступен ли skin для этого виджета в соответствии с именем класса виджета и свойством виджета CWidget::skin. Если skin найден, он будет объединён с начальными свойствами, переданными через createWidget. Затем объединённые начальные свойства будут использованы для инициализации вновь созданного экземпляра виджета.

Как уже упоминалось, skin — это набор начальных значений свойств для виджета. Поэтому он представлен как ассоциативный массив пар имя-значение. Skins хранятся в скриптах PHP, как и другие конфигурации. Каждый скрипт файла хранит skins для определённого типа виджета и называется именем класса виджета (например, CLinkPager.php). Каждый тип виджета может иметь один или несколько skins, идентифицируемых именем skin, заданным свойством CWidget::skin. Если свойство CWidget::skin не задано для данного виджета, будет использован default skin. Ниже показаны возможные skins для виджета CLinkPager:

return array(
    'default'=>array(
        'nextPageLabel'=>'>>',
        'prevPageLabel'=>'<<',
    ),
    'short'=>array(
        'header'=>'',
        'maxButtonCount'=>5,
    ),
);

В данном примере два skins. Первый — default skin, индексируемый строкой "default". Обратите внимание, что CWidget::skin по умолчанию равен "default". Поэтому это skin, который будет применён, если свойство CWidget::skin не указано явно. Второй skin называется "short" и будет использован только тогда, когда мы установим CWidget::skin в "short".

По умолчанию CWidgetFactory ищет skin виджета в каталоге "skins" текущей папки представлений приложения CWebApplication::viewPath (например, protected/views/skins). Если используется тема, он будет искать skin в каталоге "skins" папки представлений темы CTheme::viewPath (а также в указанном выше каталоге skin). Если указанный skin не найден, виджет по-прежнему будет создан без ошибок.

public boolean $enableSkin;

public string $skinPath;

public array $skinnableWidgets;

public array $widgets;

array(
    'CLinkPager'=>array(
        'maxButtonCount'=>5,
        'cssFile'=>false,
    ),
    'CJuiDatePicker'=>array(
        'language'=>'ru',
    ),
)

public CWidget createWidget(CBaseController $owner, string $className, array $properties=array ( ))

public function createWidget($owner,$className,$properties=array())
{
    $className=Yii::import($className,true);
    $widget=new $className($owner);

    if(isset($this->widgets[$className]))
        $properties=$properties===array() ? $this->widgets[$className] : CMap::mergeArray($this->widgets[$className],$properties);
    if($this->enableSkin)
    {
        if($this->skinnableWidgets===null || in_array($className,$this->skinnableWidgets))
        {
            $skinName=isset($properties['skin']) ? $properties['skin'] : 'default';
            if($skinName!==false && ($skin=$this->getSkin($className,$skinName))!==array())
                $properties=$properties===array() ? $skin : CMap::mergeArray($skin,$properties);
        }
    }
    foreach($properties as $name=>$value)
        $widget->$name=$value;
    return $widget;
}

protected array getSkin(string $className, string $skinName)

protected function getSkin($className,$skinName)
{
    if(!isset($this->_skins[$className][$skinName]))
    {
        $skinFile=$this->skinPath.DIRECTORY_SEPARATOR.$className.'.php';
        if(is_file($skinFile))
            $this->_skins[$className]=require($skinFile);
        else
            $this->_skins[$className]=array();

        if(($theme=Yii::app()->getTheme())!==null)
        {
            $skinFile=$theme->getSkinPath().DIRECTORY_SEPARATOR.$className.'.php';
            if(is_file($skinFile))
            {
                $skins=require($skinFile);
                foreach($skins as $name=>$skin)
                    $this->_skins[$className][$name]=$skin;
            }
        }

        if(!isset($this->_skins[$className][$skinName]))
            $this->_skins[$className][$skinName]=array();
    }
    return $this->_skins[$className][$skinName];
}

public void init()

public function init()
{
    parent::init();

    if($this->enableSkin && $this->skinPath===null)
        $this->skinPath=Yii::app()->getViewPath().DIRECTORY_SEPARATOR.'skins';
}