Рассмотрим сравнительно сложные, и в то же время, часто возникающие, задачи, для которых ядро Yii не дает готового решения. Посмотрим как из отдельных моделей ActiveRecord собирать единые сущности, и как разбивать большие модели на составляющие. Разберем как правильно сохранять файлы и как сэкономить на обработчиках событий и поведениях - Интернационализация сущностей в базе данных; - Обработка “ролей” в реляционных базах данных; - Работа с файлами; - Вложенные модели; - Trait вместо Behavior.

1. Примеры
решения
типичных задач
за рамками ядра
Yii2
QuartSoft
YiiSoft
Климов П.В.

2. Интернационализация статического
текста
I18N
$translations
translate()
“translation
source”
1
*
MessageSource
translate()
DbMessageSource
PhpMessageSource
Client
“Yii::t()”

3. Интернационализация сущностей в
базе данных
Item
n
id
canonicalName
price
Language
id
name
locale
Translation
n
itemId
languageId
name
description

4. Расширение «yii2tech/ar-variation»
VariationBehavior
$variationRelation
$defaultVariationRelation
“attached behavior”
1
*
Item
$canonicalName
Language
ItemTranslation
$name
1
1
1
* “has many”
“has many”
“has many via”

5. class Item extends yiidbActiveRecord
{
public function behaviors()
{
return [
‘translations’ => [
'class' => VariationBehavior::class,
'variationsRelation' => 'translations',
'variationOptionReferenceAttribute' => 'languageId',
'optionModelClass' => Language::class,
]
];
}
public function getTranslations()
{
return $this->hasMany(ItemTranslation::class, [‘itemId' => 'id']);
}
}
Конфигурация «VariationBehavior»

6. $model = new Item();
// `getVariationModels()` возвращает список моделей-вариаций
$variations = $model->getVariationModels();
// их количество всегда равно количеству доступных опций:
var_dump(count($variations) == Language::find()->count()); // `true`
// валидация и сохранение производятся автоматически:
$post = Yii::$app->request->post();
if ($model->load($post)
&& Model::loadMultiple($model->getVariationModels(), $post)
&& $model->save())
{
return $this->redirect(['index']);
}
Управление вариаторами

7. class Item extends yiidbActiveRecord
{
public function behaviors()
{
return [
‘translations’ => [
// …
'defaultVariationRelation' => 'defaultTranslation',
'defaultVariationOptionReference' => function () {
return Yii::$app->language; // ID опции по умолчанию
},
'variationAttributeDefaultValueMap' => [
‘name' => ‘canonicalName‘ // fallback для атрибутов вариатора
],
]
];
}
public function getDefaultTranslation()
{
return $this->hasDefaultVariationRelation(); // `has many` -> `has one`
}
}
Вариация «по умолчанию»

8. class VariationBehavior extends yiibaseBehavior
{
public function __get($name)
{
try {
return parent::__get($name);
} catch (yiibaseUnknownPropertyException $e) {
return $this->getDefaultVariationModel()->{$name};
}
}
public function __set($name, $value) {…}
public function canGetProperty($name, $checkVars = true) {…}
public function canSetProperty($name, $checkVars = true) {…}
}
Добавление виртуальных свойств
«хозяину» поведения

9. $model = Item::find()->one();
echo $model->name; // вернет `$model->defaultTranslation->name`
// а если `defaultTranslation` не найдено, то `$model->canonicalName`
// Задание нового значения:
$model->name = ‘New translation name’;
// «Жадная» загрузка:
$models = Item::find()->with(‘defaultTranslation’)->all();
foreach ($models as $model) {
echo $model->name;
}
Прямой доступ к атрибутам вариатора

10. Сущности с общими атрибутами
Преподаватель Студент
- Ученая
степень
- Зарплата
- ФИО
- Паспорт
- Адрес
- Телефон
- Учебная
группа
- Стипендия

11. Роли в реляционной базе данных
Person
id
name
address
phone Student
personId
studyGroupId
scolarship
Instructor
personId
rankId
salary

12. Роли в реляционной базе данных
Person
1
id
name
address
phone Student
personId
studyGroupId
scolarship
Can be
1
Instructor
personId
rankId
salary
Can be
1 1

13. Расширение «yii2tech/ar-role»
RoleBehavior
$roleRelation
“attached behavior”
1
Student
Instructor
Person
1
1
1
“has one”
“has one”
1
1
“attached behavior”
1
1

14. class Student extends yiidbActiveRecord
{
public function behaviors()
{
return [
‘translations’ => [
'class' => RoleBehavior::class,
‘roleRelation' => ‘person',
]
];
}
public function getPerson()
{
return $this->hasOne(Person::class, [‘id' => ‘personId']);
}
}
Конфигурация «RoleBehavior»

15. class RoleBehavior extends yiibaseBehavior
{
public function __get($name)
{
try {
return parent::__get($name);
} catch (yiibaseUnknownPropertyException $e) {
return $this->getRoleRelationModel()->{$name};
}
}
public function __call($name, $params)
{
$model = $this->getRoleRelationModel();
if ($model->hasMethod($name)) {
return call_user_func_array([$model, $name], $params);
}
return parent::__call($name, $params);
}
}
Эмуляция наследования

16. $model = Student::find()->one();
echo $model->name; // вернет `$model->person->name`
// Задание нового значения:
$model->name = ‘John Doe’;
// валидация и сохранение производятся автоматически:
$model->save(); // вызов `$model->person->save()`
$model->locateAddress(); // вызов `$model->person->locateAddress()`
// «Жадная» загрузка:
$models = Student::find()->with(‘person’)->all();
foreach ($models as $model) {
echo $model->name;
}
Прямой доступ к атрибутам роли

17. Сохранение файлов
Client
Web
Server
HTTP
requests
HDD
File read/write

18. Распределенные приложения
Client
Load
Balancer
Regular
HTTP
requests
Web
Server 1
Web
Server 2
Internal HTTP requests
HDD 1 HDD 2
File read/write File read/write

19. Централизованное файловое хранилище
Client
Load
Balancer
Regular
HTTP
requests
Web
Server 1
Web
Server 2
Internal HTTP requests
File
Server
FTP / SFTP / REST
FTP / SFTP / REST

20. Абстракция файловой системы
sftpStorage
fileStorage
$buckets
getBucket()
“consists of”
1
*
fileBucket
saveFileContent()
getFileContent()
localStorage
sftpBucket
localBucket
Client
“file
r/w”

21. $bucket = Yii::$app->fileStorage->getBucket('tempFiles');
// создать файл с заданным содержимым:
$bucket->saveFileContent('foo.txt', 'Foo content');
// удалить файл:
$bucket->deleteFile('foo.txt');
// скопировать файл в хранилище:
$bucket->copyFileIn('/path/to/source/file.txt', 'file.txt');
// скопировать файл из хранилища:
$bucket->copyFileOut('file.txt', '/path/to/destination/file.txt');
var_dump($bucket->fileExists('file.txt')); // выводит `true`
echo $bucket->getFileUrl('file.txt'); // выводит:
// http://domain.com/files/f/i/file.txt'
Операции с файлами

22. Файловые потоки
// Открыть локальный файл:
$resource = fopen(‘/path/to/file.txt’, ‘r’);
// Открыть удаленный файл по протоколу HTTP:
// файл загружается по протоколу HTTP и доступен как локальный:
$resource = fopen(‘http://example.com/file.txt’, ‘r’);
// Дескриптор потока в общем виде:
$resource = fopen(‘{PROTOCOL}://{PATH}[?{QUERY}]’, ‘r’);

23. Потоковая Обвертка
class StreamWrapper
{
public function stream_open($path, $mode, $options, &$openedPath) {}
public function stream_close() {}
public function stream_eof() {}
public function stream_read($count) {}
public function stream_write($data) {}
}
stream_wrapper_register(‘foo’, StreamWrapper::class, STREAM_IS_URL);

24. Примеры
// Потоковая обвертка для протокола HTTP:
$resource = fopen(‘http://example.com/file.txt’, ‘r’);
// Потоковая обвертка для протокола FTP:
$resource = fopen(‘ftp://user:password@example.com/file.txt’, ‘r’);
// Потоковая обвертка для протокола SFTP:
$resource = fopen(‘ssh2.sftp://1234file.txt’, ‘r’);
// Потоковая обвертка для MongoDB GridFS:
$resource = fopen(‘gridfs://mydatabase.fs?filename=file.txt’, ‘r’);
// Потоковая обвертка для Amazon S3:
$resource = fopen(‘s3://bucket-name/file.txt’, ‘r’);

25. $bucket = Yii::$app->fileStorage->getBucket('tempFiles');
// открытие дескриптора потока:
$resource = $bucket->openFile(‘file.dat’, ‘r’);
while (!feof($resource)) {
echo fread($resource, 1024);
}
fclose($resource);
Обработка больших файлов

26. Максимальное количество файлов в
одном каталоге
• Для «старых» файловых систем (FAT) –
65 000
• Для современных (NTFS) теоретическое
– 4 294 967 295
• Практическое (без существенной потери
производительности) – 50 000..100 000

27. Шаблон под-каталога
return [
'components' => [
'fileStorage' => [
'class' => 'yii2techfilestoragelocalStorage',
'buckets' => [
‘item' => [
'fileSubDirTemplate' => '{^name}/{^^name}',
],
]
// ...
];
$bucket = Yii::$app->fileStorage->getBucket(‘item');
$bucket->saveFileContent('foo.txt', 'Foo content');
// реальное имя файла - ‘f/o/foo.txt’

28. Связывание файлов с сущностями БД
Item
id
…
fileExtension
fileVersion
Имя файла
Сохранение
mime-типа
Чтобы
обмануть кэш
браузера

29. Расширение «yii2tech/ar-file»
"yii2tech/file-storage"
FileBehavior
“attached behavior”
Item
1
1
fileStorage
fileBucket
“consists of”
1
*
$fileAttribute
“read / write
file”
"yii2tech/ar-file"

30. class Item extends yiidbActiveRecord
{
public function behaviors()
{
return [
‘file’ => [
'class' => FileBehavior::class,
‘fileStorageBucket' => ‘item',
‘fileExtensionAttribute' => ‘fileExtension',
‘fileVersionAttribute' => ‘fileVersion',
]
];
}
}
Конфигурация «FileBehavior»

31. use yiiwebUploadedFile;
$model = Item::findOne(1);
$model->file = UploadedFile::getInstance($model, 'file');
$model->save();
var_dump($model->fileExists()); // выводит `true`
Сохранение файлов

32. {
“name”: “John Doe”,
“email”: “johndoe@example.com”,
“address” : {
“city”: “Houston”,
“region”: “Texas”,
},
“comments”: [
{
“date”: “2016-11-26 08:16:11”,
“content”: “Hello World”
},
…
]
}
Комплексные записи

33. Вложенные модели
User
$name
$email
1“has address”
1
1
Address
$city
$region
Comment
$date
$content
mongodbActiveRecord
“has comments”
*
Model

34. Расширение «yii2tech/embedded»
"yii2tech/embedded"
User
1
ContainerTrait
*
Container
Interface
Mapping
Address
“Declare and
store”
Comment
“Satisfy
interface”

35. class User extends ActiveRecord implements ContainerInterface
{
use ContainerTrait;
public function embedAddressModel()
{
return $this->mapEmbedded(‘address', Address::class);
}
public function embedCommentModels()
{
return $this->mapEmbeddedList('comments', Comment::class);
}
}
Объявление вложенных объектов

36. $user = new User();
// Заполнение одиночного вложенного объекта:
$user->addressModel->city = ‘Houston';
$user->addressModel->region = ‘Texas';
// Заполнение списка:
$comment = new Comment();
$comment->content = ‘New comment’;
$user->comments[] = $comment;
// Синхронизация данных:
$user->refreshFromEmbedded();
var_dump($user->address); // выводит массив:
// ['city' => 'Houston', 'region' => 'Texas']
Доступ к вложенным объектам

37. События и поведения
Component
trigger()
attachBehavior()
$events
$behaviors
Behavior
events()
$owner
1
*
Event
$sender
1 1
* *
“Trigger” “Handle”
Handler
PHP
Callback
*
1
*
1
“Handle event” “Declare event handler”
1 *
“Has behavior”
“Has owner”

38. class User extends yiidbActiveRecord
{
public function behaviors()
{
return [
‘timestamp’ => [
'class' => TimestampBehavior::class,
// обрабатывает только 2 собыития:
// - `beforeInsert`
// - `beforeUpdate`
]
];
}
}
Конфигурация «TimestampBehavior»

39. $user = new User(); // срабатывает событие `init`
// поведения проинициализированы!
$models = User::find()->all(); // срабатывает событие `afterFind`
// поведения проинициализированы!
unset($models); // объекты НЕ разрушены!
gc_collect_cycles(); // принудительная сборка мусора
// только теперь объекты разрушены
Инициализация и разрушение
поведений

40. class User extends yiidbActiveRecord
{
public function init()
{
// «прыжок» через родителя
// убираем событие «init»
yiibaseModel::init();
}
public function afterFind()
{
// нет вызова родительской реализации
// убираем событие «afterFind»
}
}
Устранение «лишних» событий

41. $user = new User(); // нет события `init`
// поведения НЕ проинициализированы!
$models = User::find()->all(); // нет события `afterFind`
// поведения НЕ проинициализированы!
unset($models); // объекты разрушены!
echo gc_collect_cycles(); // выводит `0`
$user->save(); // событие `beforeInsert`
// поведения проинициализированы!
Отложенная инициализация
поведений

42. Расширение «yii2tech/behavior-trait»
User BehaviorTrait
ActiveRecord
“Allow usage of
inline methods as
event handlers”
TimestampTrait
“Add particular event
handler”

43. class User extends yiidbActiveRecord
{
use BehaviorTrait;
use TimestampTrait;
}
trait TimestampTrait
{
// Имя обработчика: «{событие}Handler{суффикс}»
// Обработка события «beforeInsert»
public function beforeInsertHandlerTimestamp($event)
{
$this->createdAt = time();
}
}
Использование «BehaviorTrait»

44. Примеры решения типичных задач за
рамками ядра Yii2
• Интернационализация в БД
• Роли в реляционных БД
• Абстракция файлового хранилища
• Связывание файлов с записями в БД
• Вложенные модели
• Trait вместо Behavior
http://www.yiiframework.com/
https://github.com/yii2tech