MonoRay.ru - Блог - Yii - Хорошие поведения

Категория: Yii

Один из принципов ОО-программирования "Лучше использовать композицию, чем наследование". Воплотить этот принцип в жизнь нам помогают поведения (Behaviors).

Попробую объяснить проще, при наследовании дочерний класс получает открытые и защищенные методы родителя. Это здорово, но есть несколько недостатков. Родительский класс разрастается, некоторым детям совершенно не нужны методы и свойства родителя.

Поведения позволяют избавится от этих недостатков и добавлять к различным классам новые методы. Делается это достаточно просто - с помошью поведений мы делаем архитектуру приложения более гибкой и избавляемся от дублирования кода.

В фреймворке yii есть готовая реализация поведения - CTimestampBehavior (это поведение используется в моделях наших продуктов)

public function behaviors() {
return array(
'AutoTimestampBehavior' => array(
'class' => 'zii.behaviors.CTimestampBehavior',
'createAttribute' => null,
'updateAttribute' => 'date_updated',
'setUpdateOnCreate' => true,
),
);
}

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

Чтобы понять как это происходит глянем в код класса CTimestampBehavior:

public function beforeSave($event) {
if ($this->getOwner()->getIsNewRecord() && ($this->createAttribute !== null)) {
$this->getOwner()->{$this->createAttribute} = $this->getTimestampByAttribute($this->createAttribute);
}
if ((!$this->getOwner()->getIsNewRecord() || $this->setUpdateOnCreate) && ($this->updateAttribute !== null)) {
$this->getOwner()->{$this->updateAttribute} = $this->getTimestampByAttribute($this->updateAttribute);
}
}

Т.к. данный класс поведения наследуется от CActiveRecordBehavior, он реализует набор методов для обработки событий жизненного цикла ActiveRecord. В данном случае используется метод beforSave. Самое интересное в этом коде $this->getOwner() - это "магический" метод, позволяющий получить модель к которой мы "подцепили" данное поведение, т.е можно работать со свойствами и методами этой модели.

Сделаем для наших пользователей в ORE возможность загрузки аватара.

Воспользуемся готовым поведением fileimagearbehavior. Скачиваем данное поведение и распаковываем его в папку protected\components\behaviors\FileARBehavior. Создаем директорию для пользовательских аваторок uploads/users, выставляем на нее права - 777

Теперь нам нужно подключить это великолепное поведение к модели User, которая находится по адресу - /protected/models/User.php. Добавляем следующее строчки в класс User:

public $avaImg;
public function behaviors() {
return array(
'avaImgBehavior' => array(
'class' => 'application.components.behaviors.FileARBehavior.ImageARBehavior',
'attribute' => 'avaImg', // Эта переменная которую мы объявлили
'extension' => 'png, gif, jpg', // Возможные расширения файла
'prefix' => 'img_',
'relativeWebRootFolder' => 'uploads/users', // this folder must exist
// 'forceExt' => png, // Если раскомментировать эту строчку, то изображения будут конвертироватся в png формат
//'useImageMagick' => '/usr/bin', # Поведение может использовать ImageMagick
// Определяем "форматы" в которых будут хранится изображения
'formats' => array(
// ava_small - маленькая аватарка, ресайз изображения 90x90px
'ava_small' => array(
'suffix' => '_small',
'process' => array('resize' => array(90, 90)),
),
// ava_big - аватарка побольше, ресайз изображения 200x200px
'ava_big' => array(
'suffix' => '_big',
'process' => array('resize' => array(200, 200)),
),
// and override the default :
'normal' => array(
'process' => array('resize' => array(200, 200)),
),
),
'defaultName' => 'default', // when no file is associated, this one is used by getFileUrl
// defaultName need to exist in the relativeWebRootFolder path, and prefixed by prefix,
// and with one of the possible extensions. if multiple formats are used, a default file must exist
// for each format. Name is constructed like this :
// {prefix}{name of the default file}{suffix}{one of the extension}
)
);
}

Читаем комментарии в коде, думаю там все понятно. Теперь нужно добавить правило для данного поля в метод rules():

array('avaImg', 'file', 'types' => 'png, gif, jpg', 'allowEmpty' => true),

С моделью мы разобрались. Теперь добавим изменения в форму в личном кабинете пользователя, файл - /protected/modules/usercpanel/views/_info.php В самом начале добавляем htmlOptions:

$form=$this->beginWidget('CActiveForm', array(
'enableAjaxValidation'=>false,
'htmlOptions' => array('enctype'=>'multipart/form-data'),

Добавляем поле, в котором пользоваетль будет выбирать картинку:

<div class="row">
<?php
$avaSmallUrl = $model->avaImgBehavior->getFileUrl('ava_small');
if($avaSmallUrl){
echo CHtml::image($avaSmallUrl);
}
?>
<?php echo $form->labelEx($model,'avaImg'); ?>
<?php echo $form->fileField($model,'avaImg');; ?>
<?php echo $form->error($model,'avaImg'); ?>
</div>

В вышеприведенном коде, чтобы получить ссылку на картинку, пользуемся методом нашего поведния $avaSmallUrl = $model->avaImgBehavior->getFileUrl('ava_small'); и если картинка есть, то выводим ее в профиле. Добавим аватарку большего размера на страницу личного кабинета, в файле /protected/modules/usercpanel/views/index.php после заголовка h1 допишем:

<div class="row">
<?php
$avaBigUrl = $model->avaImgBehavior->getFileUrl('ava_big');
if($avaBigUrl){
echo CHtml::image($avaBigUrl);
}
?>
</div>

Чтобы аватарка была видна не только самому пользователю, добавим ее на страницу объявления, рядом с "Телефон владельца" - /protected/modules/apartments/views/_view.php после строки c if(param('useShowUserInfo')) добавим вывод аватарки пользователя -

<div>
<?php
$avaSmallUrl = $data->user->avaImgBehavior->getFileUrl('ava_small');
if($avaSmallUrl){
echo CHtml::image($avaSmallUrl);
}
?>
</div>

Итак, воспользовавшись готовым поведением мы добавили для каждого пользователя возможность загружать аватар. При этом не пришлось добавлять новое поле в базе данных. А при удалении пользователя поведение само удалит принадлежащие ему аватарки.

Блог. Yii. Хорошие поведения - Behaviors в Yii

Поиск

Последние