Виджеты в Yii — это как конструктор Lego для веб-разработчика. Собрал однажды — используешь везде. Но что делать, если стандартных деталей не хватает? Правильно, создавать свои! В этой статье я расскажу, как сделать кастомный виджет в Yii, чтобы вы могли переиспользовать код и не изобретать велосипед каждый раз.

Digital-студия WNDER

Что такое виджет и зачем он нужен

Виджет — это переиспользуемый блок кода, который инкапсулирует логику отображения. Например, кнопка «Поделиться», форма подписки, слайдер. В Yii виджеты наследуются от класса CWidget (в Yii 1) или yii\base\Widget (в Yii 2). Они позволяют отделить представление от логики и легко встраивать компоненты в разные части приложения.

Зачем создавать свои? Стандартные виджеты покрывают типовые задачи, но бизнес-логика уникальна. Кастомный виджет помогает избежать дублирования кода и упрощает поддержку.

Создание простого виджета на примере Yii 2

Рассмотрим Yii 2, так как он более актуален. Виджет — это класс, наследующий yii\base\Widget. Основной метод — init() для инициализации и run() для вывода HTML.

Создадим виджет, который выводит текущую дату в заданном формате. Поместим его в папку components (или widgets).

format)) {
            $this->format = 'd.m.Y';
        }
    }

    public function run()
    {
        return \yii\helpers\Html::tag($this->tag, date($this->format));
    }
}
?>

Теперь используем его в представлении:

 'Y-m-d', 'tag' => 'div']) ?>

Виджет выведет текущую дату в теге div. Просто? Ещё бы!

Правило: Всегда вызывайте parent::init() в своём методе init(), если переопределяете его. Это гарантирует выполнение базовой инициализации Yii.

Продвинутый виджет с передачей данных и шаблоном

Часто виджету нужно передать модель или массив данных. Сделаем виджет «Последние новости», который принимает массив статей и выводит их список.

news as $item) {
            $items .= Html::tag('li', Html::a($item['title'], $item['url']));
        }
        return Html::tag('div', 
            Html::tag('h3', $this->title) . 
            Html::tag('ul', $items),
            ['class' => 'news-widget']
        );
    }
}
?>

Вызов в представлении:

 [
        ['title' => 'Новость 1', 'url' => '/news/1'],
        ['title' => 'Новость 2', 'url' => '/news/2'],
    ],
    'title' => 'Свежие новости',
]) ?>

Для сложной разметки можно использовать шаблон (view-файл). Достаточно создать файл views/newsWidget.php и в методе run() вернуть $this->render('newsWidget', ['news' => $this->news]).

Параметры виджета и их настройка

У каждого виджета есть параметры — публичные свойства, которые можно задать при вызове. Ниже таблица с основными параметрами для нашего NewsWidget и DateWidget.

Виджет Параметр Тип Описание
DateWidget format string Формат даты (например, 'd.m.Y')
DateWidget tag string HTML-тег для обёртки
NewsWidget news array Массив новостей (title, url)
NewsWidget title string Заголовок блока
Лайфхак: Если виджет используется часто, создайте для него хелпер или метод в контроллере, чтобы не дублировать вызов. Например, оберните NewsWidget::widget() в функцию.

Использование JavaScript в виджетах

Виджет может подключать свои JS-скрипты. В Yii 2 для этого есть метод registerJs() в init() или run(). Пример виджета с простым скриптом, который показывает alert при клике.

view->registerJs("$('#alert-btn').on('click', function(){ alert('{$this->message}'); });");
        return Html::button($this->buttonText, ['id' => 'alert-btn', 'class' => 'btn btn-primary']);
    }
}
?>

Вызов:

 'Вы кликнули!']) ?>

Не забудьте подключить jQuery (в Yii 2 он идёт из коробки).

Заключение

Создание кастомных виджетов в Yii — это просто и удобно. Вы инкапсулируете логику, повторно используете код и делаете проект чище. Начните с простых виджетов, постепенно усложняя их. Помните о параметрах, шаблонах и регистрации JS. И не забывайте про parent::init().

Экспериментируйте, и ваши виджеты станут незаменимыми помощниками в разработке!

Студия WNDER