Подготовительные работы закончены, и сегодня мы приступаем непосредственно к разработке компонента.
Мы пишем компонент рассылок, поэтому нужно продумать основную логику работы. Обращаю ваше внимание на то, что наша цель - научиться писать компоненты для MODX, а не написать лучшую рассылку в мире. Поэтому прошу вас сразу поумерить амбиции и не предлагать добавить мега-функционал.
Логика работы мне видится такой:
Соответственно, в админке у нас будет страница управления подписками, добавление к ним подписчиков, и просмотр очереди сообщений, с возможность что-то удалить или отправить "прямо сейчас". Возможно, еще добавим страницу проверки отправки сообщений, чтобы слать себе тестовые письма для отладки.
С функционалом примерно определились, теперь нужно написать схему БД, чтобы хранить наши данные.
Схема в MODX - это файл формата XML, в котором описаны все объекты и их связи. Он не участвует в работе компонента, он нигде не используется, он нужен только для генерации модели.
Схема может изменяться, по мере развития дополнения. Вы можете добавлять или удалять объекты, индексы и связи. Не нужно пытаться предусмотреть сразу все колонки в таблицах - вы сможете добавить их в любое время.
Основные принципы схемы xPDO можно прочитать в официальной документации, а я просто покажу вам уже готовый файл и объясню, что там и как.
Открываем схему в моем репозитории на GitHub и смотрим.
Каждый объект описывается в теге object. В атрибутах объекта вы указываете его имя и таблицу БД, в которой он будет храниться. Таблица указывается без префикса сайта - он будет добавлен автоматически самим MODX, когда понадобится.
<object class="sxNewsletter" table="sendex_newsletters" extends="xPDOSimpleObject">
Наш объект обязан расширять уже существующий объект MODX, обычно используется xPDOSimpleObject. От него мы унаследуем колонку id, как первичный ключ - поэтому нигде в схеме не указано id у объектов.
А вот если бы мы наследовали xPDOObject, тогда пришлось бы самостоятельно это прописывать. Если не хотите заморочек, просто всегда используйте xPDOSimpleObject.
Дальше в объекте описываются его поля:
<field key="name" dbtype="varchar" precision="100" phptype="string" null="false" default="" />
<field key="description" dbtype="text" phptype="text" null="true" default="" />
<field key="active" dbtype="tinyint" precision="1" phptype="boolean" attributes="unsigned" null="true" default="1" />
Это только основные свойста, MODX хранит много недокументированных возможностей, поэтому рекомендую внимательно смотреть на его собственную схему, и просто копировать, что нужно.
После описания колонок таблицы, нужно указать индексы, чтобы наша таблица быстра работала. В большинстве случаем достаточно добавить в индекс те поля, по которым будет проводиться выборка:
<index alias="name" name="name" primary="false" unique="false" type="BTREE">
<column key="name" length="" collation="A" null="false" />
</index>
<index alias="active" name="active" primary="false" unique="false" type="BTREE">
<column key="active" length="" collation="A" null="false" />
</index>
Из важных атрибутов здесь - primary - является ли индекс первичным? Обычно - нет, первичный индекс у нас по полю id от xPDOSimpleObject.
Ну и последнее - отношение объектов друг к другу:
<composite alias="Subscribers" class="sxSubscriber" local="id" foreign="newsletter_id" cardinality="many" owner="local" />
<aggregate alias="Template" class="modTemplate" local="template" foreign="id" cardinality="one" owner="foreign" />
<aggregate alias="Snippet" class="modSnippet" local="snippet" foreign="id" cardinality="one" owner="foreign" />
Composite - объект является главным, по отношению к другому. При удалении такого объекта будут удалены все дочерние объекты, связанные с ним здесь. Aggregate - объект подчинён другому объекту. При его удалении главному ничего не будет. - alias - псевдоним связи. Используется в $object->getMany('Subscribers'); или $object->addOne('Template');
Для наглядного представления схемы я советую использовать сервис от Jeroen Kenters
По ходу разработки схема будет неоднократно меняться, так что дальше должно стать понятнее.
Как я уже говорил, сама схема нам ничего не даёт, нам нужна рабочая модель. А что такое модель БД в MODX? Это набор файлов php, который состоит из основных объектов и расширения для конкретной БД.
Давайте сгенериуем модель и посмотрим, что там получится: 1. Копипастим текущую схему в свой проект и сохраняем. Изменения должны синхронизироваться с сервером. 2. Удаляем старые ненужные файлы модели modExtra 3. Выполняем файл build.model.php на сервере. У меня это http://c2263.paas2.ams.modxcloud.com/Sendex/\_build/build.model.php - при первой генерации будет только done, а при последующих - сообщения, что имеющиеся объекты не будут перезаписаны. 4. На сервере были созданы новые файлы - нужно синхронизировать директорию model (жмём две зеленые стрелочки вверху). - - 5. Модель загружена к нам в проект. Файлы пока коричневые, так как они еще не добавлены в Git. Добавляем их через контекстное меню и видим зелёненькие (новые) файлы: - - 6. Добавляем создание новых обхектов при установке компонента в /_build/resolvers/resolve.tables.phpВидите белую полосу слева от номеров строк? Это система контролей версий показывает нам, где были изменены строки. Файл сразу становится синим - он содержит ихменения, которые не были сохранены в Git. 7. Отправляем изменения в репозиторий В левом нижнем окне видим старый файл, в правом нижнем - новый. Можно проверить все изменения перед отправкой.
Вот мой сегодняшний коммит со всей работой. А вот список всех коммитов, для отслеживания прогресса.
Ну а теперь давайте посмотрим внимательнее, что это за модель такая на примере объекта sxNewsletter?
Итак, у нас появились новые файлы: - /model/sendex/metadata.mysql.php - общая информация о том, какие обхекты есть в компоненте.
Как нетрудно догадаться, если бы мы создали еще одну схему для БД MsSQL, и сгенерировали модель по ней, то /model/sendex/metadata.mysql.php остался бы прежнем, а в /model/sendex/ добавилась бы директория mssql, с файлами sxnewsletter.class.php и sxnewsletter.map.inc.php.
Именно так MODX поддерживает любые БД при помощи xPDO - создаёт один общий объект, который расширяется при работе в определённой системе.
Файлы, которые лежат в /model/sendex/mysql/ нам не понадобятся, более того, они будут перезаписываться при каждой генерации модели по новой схеме (такой уж у меня скрипт генерации), а вот в /model/sendex/sxnewsletter.class.php мы потом будем писать разные методы, чтобы вызывать их вот так:
if ($newsletter = $modx->getObject('sxNewsletter', 1)) {
echo $newsletter->имяМетода('параметры');
}
Откройте, к примеру, объект modUser и поглядите на знакомые методы isAuthenticated() и joinGroup() - вот так MODX и работает =) Теперь вы знаете, как просто выяснить, что умеет какой-то объект в движке или его дополнениях.
Два других наших объекта sxSubscriber и sxQueue работают точно так же.
Итак, сегодня мы определились с основной логикой работы, которую будем программировать в дальнейшем, и набросали первый вариант нашей модели xPDO для БД MySql.
На следующем уроке собираем компонент в транспортный пакет, устанавливаем его на сайт и настраиваем для удобной дальнейшей разработки. А потом разбираемся с контроллерами custom manager pages админки и готовимся рисовать интерфейс на ExtJs.
Почему то не изменяется файл > _build/resolvers/resolve.tables.php
Как это? Открываешь файл в проекте, меняешь строчки, жмешь Ctrl+S.
В любом случае, сегодня нам это не нужно - ресолвер понадобится только при сборке пакета.
Предыдущие уроки я по несколько раз переделывал, т.к с первого раза все не получалось как надо и сейчас, после прочтения комментария, я снова перечитал урок - действительно же, надо "ручками" добавить ... а сначала я прочитал что надо запустить файл
и эти строчки сами добавяться.
Не-не-не, это же ресолвер - скрипт, который будет запущен при установке пакета.
Именно этот файл физически создаст таблицы, описанные в модели. И мы указываем, какие объекты используются.
Правильная разработка дополнений - тема сложная, так что перечитывать будем часто. Тем более, что доступ в раздел у тебя останется навсегда.
Можно как-то сравнить 2 репозитория у тебя и у меня? Так получилось, что коммит отправил 2 раза и вышло вот так вот: https://github.com/sentyakov/Sendex/commits/master
Ничего страшного, хоть 10 коммитов отправляй. Судя по всему, там разница только в отступах. Сравнивать, насколко я знаю, можно форки - то есть ответвления от основного проекта. А мы делаем все независимо.
После окончания уроков ты сможешь просто удалить свой репозиторий, форкнуть мой и присылать свои изменения.
Я, конечно, вперёд батьки в пекло лезу, но у меня вопрос - мы, получается, текст писем будем хранить в шаблонах? Может, рассылку связывать по полю template с объектом modChunk, а не modTemplate?
Мы будем доставать и процессить этот шаблон, а в нём могут быть и чанки, сниппеты и фильтры.
Будет удобно прописывать логику отображения и тестировать оформление письма
Есть ли возможность указывать ориентировочную дату выхода следующего урока?
Нет, это процесс творческий, не хочу загонять себя в рамки.
Пока за 8 дней написано 5 заметок - неплохой темп. Сегодня - завтра будет следующая.
В исходнике modUser приведённом по ссылке в тексте статьи присутствует интересная конструкция для phpStorm: /** @var modX|xPDO $xpdo */
И вообще перед каждой функцией в комментах разметка, такое чувство, что генерировалась чем-то автоматически...
Ага, это PHPDoc.
Можно генерировать автоматом по нажатию Ctrl+Enter → PHPDoc Blocks... или писать ручками.
Василий, а как в xml-схеме обозначить столбец key с типом enum и вариантами a, b, c.
Не знаю, нигде такого не видел. Думаю, варианты enum можно попробовать указать в attributes.
Нигде про enum не сказано, даже в той схеме modx его нет. У меня сработало в таком виде (важно также указать default):
Так правильно создалась таблица в БД после запуска build.transport.php Кроме корректного создания таблицы, что-то еще стоит проверить по этому столбцу?
По идее, нужно попробовать теперь сохранить объект с некорректным значением и получить ошибку - тогда ясно будет, что работает.
А если создавать объект, который расширяет modResource или какой другой объект, в таком случае достаточно :
чтобы затем использовать этот объект
или нужно еще где то указать на класс modResource?
Достаточно. Только, если ресурс с id = 1 не является объектом Test, то вернётся modResource.
Так что, можно еще точно указать нужный класс:
Такой вызов вернет test или null.
у меня вот что выдает:
Должно быть modResource, а не modResurce.
Очепятка у тебя.
виноват) с modResource все встало на свои места, а если расширить какой другой объект из другого расширения, скажем msOrder, у меня все равно такую ошибку выдает, хотя нет опечатки
Так это же не стандартный класс MODX, а из MS2.
Его как бы нет в системе, пока MODX не загрузит его для работы. Так что, наверное, не получится так расширять.
ок, сделал так:
не знаю только на сколько это правильно