Caution: You are browsing the legacy symfony 1.x part of this website.
Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

День 3: Модель данных.

Ранее на Jobeet

Все, кто уже скёт ногами, пытаясь открыть текстовый редактор и написать немного PHP кода, сегодня будут счастливы узнать, что в сегодняшнем уроке мы наконец-то займёмся разработкой. Мы определим модель данных Jobeet, начнём использовать ORM для общения с базой данных и построим первый модуль нашего приложения. Но так как symfony делает за нас огромную часть работы, то мы получим полнофункциональный модуль почти не притронувшись PHP коду.

Реляционная модель.

Истории пользователей, которые мы вчера написали, описывают основные объекты нашего проекта: вакансии, партнёры и категории. Вот диаграмма, связывающая это всё воедино:

Entity relationship diagram

В дополнение к полям, описанным в историях, мы так же добавим поля created_at для некоторых таблиц. Symfony замечает такие поля и устанавливает их значение равное системному времени в момент создания записи. Тоже самое верно и для полей updated_at: их значения становятся равны системному времени, каждый раз, когда обновляется запись.

Схема.

Для того чтобы хранить вакансии, партнёрв и категории, нам понадобится реляционная база данных.

Но раз symfony это Объекто-Ориентированный фреймворк, то когда мы должны хотеть управлять объектами. Например, вместо того, чтобы писать SQL запросы для получения запписи из базы данных, лучше воспользуемся объектами.

Информация о реляционной базе данных должна быть связана с объектной моделью. Это можно сделать при помощи ORM инструмента и, к счастью, symfony поставляется с двумя из них: Propel и Doctrine. В данной главе мы будем использовать Propel.

ORM потребует от вас описания таблиц и связей между ними для создания связанных классов. Есть 2 пути для создания описательной схемы: из уже созданной базы данных или же написать схемы вручную.

note

Существуют инструменты, при помощи которых можно создать базу данных графически (например Fabforce's Dbdesigner) и сгенерировать schema.xml (при помощи DB Designer 4 TO Propel Schema Converter).

Базы данных у нас пока нет, так что займёся созданием файла схемы вручную, а для этого воспользуемся файлом config/schema.yml:

# config/schema.yml
propel:
  jobeet_category:
    id:           ~
    name:         { type: varchar(255), required: true }
 
  jobeet_job:
    id:           ~
    category_id:  { type: integer, foreignTable: jobeet_category, foreignReference: id, required: true }
    type:         { type: varchar(255) }
    company:      { type: varchar(255), required: true }
    logo:         { type: varchar(255) }
    url:          { type: varchar(255) }
    position:     { type: varchar(255), required: true }
    location:     { type: varchar(255), required: true }
    description:  { type: longvarchar, required: true }
    how_to_apply: { type: longvarchar, required: true }
    token:        { type: varchar(255), required: true, index: unique }
    is_public:    { type: boolean, required: true, default: 1 }
    is_activated: { type: boolean, required: true, default: 0 }
    email:        { type: varchar(255), required: true }
    expires_at:   { type: timestamp, required: true }
    created_at:   ~
    updated_at:   ~
 
  jobeet_affiliate:
    id:           ~
    url:          { type: varchar(255), required: true }
    email:        { type: varchar(255), required: true, index: unique }
    token:        { type: varchar(255), required: true }
    is_active:    { type: boolean, required: true, default: 0 }
    created_at:   ~
 
  jobeet_category_affiliate:
    category_id:  { type: integer, foreignTable: jobeet_category, foreignReference: id, required: true, primaryKey: true, onDelete: cascade }
    affiliate_id: { type: integer, foreignTable: jobeet_affiliate, foreignReference: id, required: true, primaryKey: true, onDelete: cascade }

tip

Если вы решили создать таблицы при помощи sql выражений, то в последствии вы сможете сгенерировать файл schema.yml при помощи команды propel:build-schema.

Схема - это зеркальное отражение диаграммы связей, но в формате YAML.

sidebar

Формат YAML

Согласно официальному сайту YAML, YAML это "дружественный стандарт сериализации данных для всех языков программирования"

Другими словами, YAML это простой язык для описания данных (строки, числа, даты, массивы и хэши)

В YAML структура показана через метки, циклы определяются дефисом, а пары ключ/значение раскиданы по колонками. YAML так же имеет сокращённый синтакис для описания одной и той же структуры меньшим количеством строк, в котором массивы отображаются при помощи структуры [], а хэши при помощи {}

Если вы ещё ничего не знаете про YAML, то самое время его изучить, так как symfony активно пользуется им в конфигурационных файлах.

Файл schema.yml содержит описание всех таблиц и их полей. Каждое описание поля даёт нам следующую информацию:

  • type: Тип поля (boolean, tinyint, smallint, integer, bigint, double, float, real, decimal, char, varchar(size), longvarchar, date, time, timestamp, blob и clob)
  • required: Установите в true, если хотите чтобы поле было обязательным.
  • index: Установите в true если вы хотите создать индекс на данном поле, или unique, если хотите, чтобы на поле был создан уникальный индекс.

Если поле определено как ~ (id, created_at, and updated_at), symfony подберёт лучшую конфигурацию (primary key для id и timestamp для created_at и updated_at)

note

Атрибут onDelete определяет поведение ON DELETE для внешних ключей. Propel поддерживает CASCADE, SETNULL и RESTRICT. Например, если запись job удаляется, то все связанные с ней записи jobeet_category_affiliate будут автоматически удалены базой данных или самим Propel, если данный движок не поддерживает такой функционал.

База данных

Symfony поддерживает все базы данных, которые есть в PDO (MySQL, PostgreSQL, SQLite, Oracle, MSSQL, ...). PDO это абстрактный слой баз данных, поставляемый с PHP.

В данном учебнике мы будет использовать MySQL:

$ mysqladmin -uroot -pmYsEcret create jobeet

note

Будьте свободны в выборе баз данных. Будет весьма нетрудно адаптировать код, создаваемый нами, так как вместо SQL мы используем возможности ORM для создания запросов.

Теперь укажем symfony на базу данных, используемую в проекте Jobeet:

$ php symfony configure:database "mysql:host=localhost;dbname=jobeet" root mYsEcret

Команда configure:database принимает 3 аргумента: PDO DSN, имя пользователя и пароль для доступа к БД. Если у вас нет пароля на сервере для разработок, просто не пишите третий аргумент.

note

Команда configure:database сохраняет настройки БД в файл config/databases.yml. Данные настройки можно изменить и вручную, без использования команды

ORM

Используя описание БД в файле schema.yml вы можем при помощи встроенных в Propel команд сгенерировать SQL, необходимый для создания таблиц в БД:

$ php symfony propel:build-sql

Команда propel:build-sql создаёт SQL в каталоге data/sql, оптимизированный под ту БД, которую мы указали в конфигурации.

# snippet from data/sql/lib.model.schema.sql
CREATE TABLE `jobeet_category`
(
  `id` INTEGER  NOT NULL AUTO_INCREMENT,
  `name` VARCHAR(255)  NOT NULL,
  PRIMARY KEY (`id`)
)Type=InnoDB;

Для создания таблиц в БД, нужно запустить команду propel:insert-sql:

$ php symfony propel:insert-sql

Так как команда сбрасывает текущие таблиц перед их пересозданием, то вам нужно будет подтвердить операцию. Вы так же можете использовать флаг --no-confirmation, чтобы пропустить вопрос, что может быть полезно, если вы запускаете команду из неинтерактивного скрипта:

$ php symfony propel:insert-sql --no-confirmation

tip

Как и любое приложение командной строки, команды symfony принимают аргументы и опции. Каждая команда идёт со встроенной подсказкой, которая отображается при использовании команды help:

$ php symfony help propel:insert-sql

Подсказка показывает все возможные аргументы и флаги, показывает их стандартные значения и приводит полезные примеры.

ORM так же генерирует PHP классы, которые связывают записи таблицы и объекты:

$ php symfony propel:build-model

Команда propel:build-model генерирует PHP файлы в каталоге lib/model. Данные файлы используются для работы с базой данных.

Просматривая созданные файлы, вы наверное заметили, что для Propel генерируется 4 класса для каждой из таблиц. Для таблицы jobeet_job имеем:

  • JobeetJob: Объект данного класса представляет собой запись таблицы jobeet_job. Класс изначально пуст.
  • BaseJobeetJob: Родительский класс JobeetJob. Каждый раз когда вы запускаете propel:build-model, данный класс перезаписывается, поэтому все изменения должны вноситься в класс JobeetJob.

  • JobeetJobPeer: Клас определяет static методы, которые в основном возвращают коллекцию объектов JobeetJob. Класс изначально пуст.

  • BaseJobeetJobPeer: Корневой класс JobeetJobPeer. Каждый раз когда вы запускаете propel:build-model, данный класс перезаписывать, поэтому все изменения должны вноситься в класс JobeetJobPeer
    Значениями полей записи можно управлять при помощи акцессоров (методыget*()) и мутаторов (методы set*())

    [php] $job = new JobeetJob(); $job->setPosition('Web developer'); $job->save();

    echo $job->getPosition();

    $job->delete();

Вы так же можете определить внешние ключи напрямую, связывая объекты:

$category = new JobeetCategory();
$category->setName('Programming');
 
$job = new JobeetJob();
$job->setCategory($category);

Команда propel:build-all это ярлык для всех команд, которые мы уже запустили в данной части, а так же некоторых других. Запустите данную команду, для того чтобы сгенерировать все формы и валидаторы для классов моделей Jobeet:

$ php symfony propel:build-all

В конце дня вы увидите валидаторы в действии, а о формах пойдёт речь на 10ый день нашего учебника.

tip

Команда propel:build-all-load это ярлык, использущий команду propel:build-all, а затем propel:data-load.

В дальнейшем вы увидите, что symfony автоматически подгружает для вас классы, а это значит что никогда не придётся использовать require в вашем коде. Это одна из многочисленных вещей, автоматизируемая symfony для разработчика, но есть один косяк: при добавлении нового класса нужно очистить кеш symfony. А раз propel:build-model создал новые классы, то самое время чистить кеш:

 $ php symfony cache:clear

tip

Все команды symfony состоят и имени пространства и имени задачи. Каждая из них может быть уменьшена так, как захочется, если конечно она не пересекается с другими командами. Так что команда cache:clear равносильна: $ php symfony cc

Загрузка данных

Таблицы в базе данных у нас появлись, но вот самих данных в них нет. Любое веб-приложение имеет 3 вида данных:

  • Начальные данные: Начальны данные нужны для того, чтобы приложение работало. Например, Jobeet нужны для начала категории. Если их нет - никто не сможет добавить вакансию. Нам так же нужен администратор в таблице пользователей, чтобы иметь возможность попасть в бэкенд

  • Тестовые данные: Тестовые данные необходимо для тестирования приложения. Как разработчик, вы должны быть уверены, что Jobeet работает так, как это описано в историях пользователей, а лучшим собосом для этого является создание автоматических тестов. Так что, каждый раз когда вы запускаете тесты, вам будет нужна чистая БД со свежими данными для тестированияю

  • Пользовательские данные: Пользовательские данные создаются пользователями во время обычного жизненного цикла приложения.

Каждый раз когда symfony создаёт таблицы в базе данных, все данные теряются. Для наполнения БД начальными данными мы могли бы воспользоваться PHP скриптом или же запустить SQL запрос при помощи программы mysql. Но данная вещь является общей, поэтому есть путь лучше при помощи symfony: создать YAML файлы в каталоге data/fixtures/ и использовать propel:data-load для загрузки их в БД.

# data/fixtures/010_categories.yml
JobeetCategory:
  design:        { name: Design }
  programming:   { name: Programming }
  manager:       { name: Manager }
  administrator: { name: Administrator }
 
# data/fixtures/020_jobs.yml
JobeetJob:
  job_sensio_labs:
    category_id:  programming
    type:         full-time
    company:      Sensio Labs
    logo:         sensio_labs.png
    url:          http://www.sensiolabs.com/
    position:     Web Developer
    location:     Paris, France
    description:  |
      You've already developed websites with symfony and you want to work
      with Open-Source technologies. You have a minimum of 3 years
      experience in web development with PHP or Java and you wish to
      participate to development of Web 2.0 sites using the best
      frameworks available.
    how_to_apply: |
      Send your resume to fabien.potencier [at] sensio.com
    is_public:    true
    is_activated: true
    token:        job_sensio_labs
    email:        [email protected]
    expires_at:   2010-10-10
 
  job_extreme_sensio:
    category_id:  design
    type:         part-time
    company:      Extreme Sensio
    logo:         extreme_sensio.png
    url:          http://www.extreme-sensio.com/
    position:     Web Designer
    location:     Paris, France
    description:  |
      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
      eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
      enim ad minim veniam, quis nostrud exercitation ullamco laboris
      nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor
      in reprehenderit in.
 
      Voluptate velit esse cillum dolore eu fugiat nulla pariatur.
      Excepteur sint occaecat cupidatat non proident, sunt in culpa
      qui officia deserunt mollit anim id est laborum.
    how_to_apply: |
      Send your resume to fabien.potencier [at] sensio.com
    is_public:    true
    is_activated: true
    token:        job_extreme_sensio
    email:        [email protected]
    expires_at:   2010-10-10

Файлы данных пишутся в формает YAML и определяют модели объектов, обозначенные уникальным именем. Данное обозначение полезно при создании ссылок на связанные объекты без определения ключей (которые, обычно, устанавливаются при помощи auto-increment и не могут быть изменены). Например категория для вакансии job_sensio_labs - programming, которая является определнием для категории 'Programming'.

Файл данные может содержать как один, так и несколько объектов.

tip

Заметьте цифры перед именами файлов. Это самый простой путь контролировать очерёдность загрузки данныех. Далее в нашем проекте, если нам понадобится внедрить новый файл данных, сделать это будет легко, так как у нас есть несколько свободных чисел между текущими.

В файле данных совсем не обязательно определять значения всех полей. Если значения нет - symfony определит стандартное значение, определённое в схеме БД. А раз symfony использует Propel для загрузки данных в БД, то все встроенные поведения (такие как на полях created_at и updated_at) или собственные поведения, которые вы добавите к модели, будут активны.

Загрузить начальные данные можно в БД при помощи команды propel:data-load:

$ php symfony propel:data-load

Проверка на робоспособность в браузере

Что-то мы много пользуемся командной строкой и это не сильно то привлекательно, особенно для веб-проекта. У нас уже есть всё, для того чтобы создать веб-страницы, работающие с БД.

Посмотрим, как можно вывести список вакансий, как редактировать текущую вакансию и как удалить её. Как и говорилось в первом дне, проект на symfony сделан из приложений. Каждое приложение состоит из модулей. Модуль это набор PHP кода, который отвечает за возможности приложения (например модуль API) или же за манипуляции, которые пользователь может совершить над проектом (например модуль вакансий).

Symfony может автоматически сгенерировать модуль для данной модели, который будет отвечать за базовые функции управления:

$ php symfony propel:generate-module --with-show --non-verbose-templates frontend job JobeetJob

Команда propel:generate-module создаёт модуль job в приложении frontend для модели JobeetJob. Как и для многих других команд, были созданы файлы и папки в каталоге apps/frontend/modules/job:

Каталог Описание
actions/ Действия модуля
templates/ Шаблоны модуля

Файл actions/actions.class.php определяет все возможные действия для модуля job:

Действие Описание
index Отображает записи таблицы
show Отображает поля таблицы
new Отображает форму для заведения новой записи
create Заводит новую запись
edit Отображает форму для редактирования текущей записи
update Обновляет запись, согласно присланным пользователем данным
delete Удаляет данную запись из таблицы

Теперь вы можете протестировать модуль "Вакансии" по адресу:

 http://jobeet.localhost/frontend_dev.php/job

Job module

При попытке редактирования вакансии, вы получите исключение, потому что symfony нужно текстовое представление категории. Данное представление для объекта можно получить при помощи метода __toString(). Текстовое представление категории должно быть определно в классе JobeetCategory:

// lib/model/JobeetCategory.php
class JobeetCategory extends BaseJobeetCategory
{
  public function __toString()
  {
    return $this->getName();
  }
}

Теперь, каждый раз когда вам нужно текстовое представление, будет происходить вызов метода __toString(), которые возвращает название категории. Так как нам пригодится текствовое представление в любой момент, то стоит определить метод __toString()для всех классов моделей:

// lib/model/JobeetJob.php
class JobeetJob extends BaseJobeetJob
{
  public function __toString()
  {
    return sprintf('%s at %s (%s)', $this->getPosition(), $this->getCompany(), $this->getLocation());
  }
}
 
// lib/model/JobeetAffiliate.php
class JobeetAffiliate extends BaseJobeetAffiliate
{
  public function __toString()
  {
    return $this->getUrl();
  }
}

Теперь вы можете создавать и редактировать вакансии. Попробуйте оставить обязательные полями незаполненными или попроуйте ввести неверную дату. Всё верно, symfony создать базовые правила проверка (валидации), просмотрев схему базы данных.

validation

Увидимся завтра!

На сегодня всё. Я вас предупрежда во вступлении. Сегодня мы немного написали PHP кода, но у нас уже есть рабочий модуля для модели вакансий готовый к изменениям. Помните - отсутсвие PHP кода означает отсутвие багов.

Если у вас ещё осталось немного сил, то можете свободно сгенерировать код для модуля и моделей и попробовать понять как это всё работает. Если нет - можете не беспокоиться и спать спокойно, а завтра мы поговорим об одной и самых важных парадимг фреймворков - шаблоне проектирования MVC.

Код, написанные сегодня, доступен в репозитории SVN Jobeet под тегом release_day_03 (http://svn.jobeet.org/tags/release_day_03/).