- Метаданные в файле манифеста Joomla 4
- База данных в файле манифеста Joomla 4
- Файл сценария в файле манифеста Joomla 4
- Медиафайлы в файле манифеста Joomla 4
- Файлы сайта в файле манифеста Joomla 4
- Файлы администратора в файле манифеста Joomla 4
- Сервер обновлений в файле манифеста Joomla 4
- Анатомия MVC Joomla 4
Метаданные в файле манифеста Joomla 4.
Файл манифеста Joomla 4 компонента должен иметь имя manifest.xml или componentname.xml, в данном случае countrybase.xml. Обратите внимание, что часть com_ не включена. Первая часть файла содержит метаданные:
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" method="upgrade">
<name>countrybase</name>
<author>Clifford E Ford</author>
<authorEmail>john.doe@example.com</authorEmail>
<authorUrl>example.com</authorUrl>
<creationDate>2022-05-10</creationDate>
<copyright>(C) 2022 Clifford E Ford</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<version>0.1.0</version>
<description>COM_COUNTRYBASE_DESCRIPTION</description>
<namespace path="src">J4xdemos\Component\Countrybase</namespace>Большая часть метаданных очевидна. На что следует обратить внимание:
extension typeв данном случае -component. Существуют и другие типы расширений, такие какmodule,pluginилиpackage.methodможет бытьinstallилиupgrade. Последний позволяет повторно выполнить установку после обновления кода.- Номер
versionочень важен! Он должен исключать возможность переустановки более старой версии. Кроме того, он используется для контроля необходимости обновления базы данных. namespace path srcсостоит из трех частей:
- Первая часть - это префикс, определяемый поставщиком, например,
Joomlaдля кода, поставляемогоJoomla,Acmeдля кода, поставляемого сторонним поставщиком расширенийAcme, и в данном случаеJ4xdemos, имя, которое было выбрано для всех демонстраций кода Joomla 4. - Вторая часть указывает на тип расширения. Это может быть
ComponentилиModuleилиPlugin.... - Третья часть - это название конкретного расширения, в данном случае
Countrybase.
- Первая часть - это префикс, определяемый поставщиком, например,
База данных в файле манифеста Joomla 4.
Файл манифеста определяет местоположение всех sql-файлов установки, обновления или удаления. Они находятся в папке sql в папке administrator.
<install>
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.sql</file>
</sql>
</install>
<uninstall>
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.sql</file>
</sql>
</uninstall>
<update>
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>Файл сценария в файле манифеста Joomla 4.
Файл сценария (script file) может быть использован для предварительных или последующих целей. Например, он может использоваться для проверки минимальных системных требований перед установкой или для настройки параметров после установки.
Медиафайлы в файле манифеста Joomla 4.
Компонент com_countrybase не нуждается в специфических для компонента css или javascript, но код для их установки включен на всякий случай. Файлы пустые.
<scriptfile>script.php</scriptfile>
<media destination="com_countrybase" folder="media">
<file>joomla.asset.json</file>
<folder>css</folder>
<folder>js</folder>
</media>Обратите внимание, что файл joomla.asset.json используется менеджером web asset, который обычно вызывается из файла шаблона.
Файлы сайта в файле манифеста Joomla 4.
Вот файлы, которые копируются в папку root/components/com_countrybase. Обратите внимание, что папка language копируется в папку компонента, а не в папку administrator/language:
<files folder="site">
<folder>language</folder>
<folder>forms</folder>
<folder>src</folder>
<folder>tmpl</folder>
</files>Файлы администратора в файле манифеста Joomla 4.
В части administration файла манифеста больше файлов, потому что в ней больше задач:
<administration>
<files folder="admin">
<filename>access.xml</filename>
<filename>config.xml</filename>
<folder>forms</folder>
<folder>help</folder>
<folder>language</folder>
<folder>layouts</folder>
<folder>services</folder>
<folder>sql</folder>
<folder>src</folder>
<folder>tmpl</folder>
</files>
<menu img="class:default">countrybase</menu>
<submenu>
<!--
Обратите внимание, что все & должны быть приведены к & для того чтобы
файл был действительным XML и мог быть разобран программой установки
-->
<menu
link="option=com_countrybase&view=countries"
img="default"
>
COM_COUNTRYBASE_COUNTRIES
</menu>
<menu
link="option=com_countrybase&view=currencies"
img="default"
>
COM_COUNTRYBASE_CURRENCIES
</menu>
</submenu>
</administration>Обратите внимание на метод создания пунктов меню администратора Joomla. Есть пункт меню, который не имеет ссылки. И два пункта меню, которые ссылаются на два доступных вида администрирования: список стран (Countries) и список валют (Currencies). Также переводы строковых ключей должны быть в файле com_countrybase.sys.ini.
Сервер обновлений в файле манифеста Joomla 4.
Код сервера обновлений (updateservers) указывает Joomla, где найти информацию об обновлениях. Он выполняется через регулярные промежутки времени, чтобы узнать, доступно ли обновление. Опустите этот раздел, если вы не используете сервер обновлений для своего компонента.
<updateservers>
<!-- Примечание: Между тегами server не допускаются пробелы и переносы строк -->
<server type="extension" name="Countrybase Update Site">https://raw.githubusercontent.com/ceford/j4xdemos-com-countrybase/master/manifest.xml</server>
</updateservers>Анатомия MVC Joomla 4.
- «Joomla 4 MVC Anatomy: Начало работы над созданием компонента»
- «Joomla 4 MVC Anatomy: Файловая структура компонента»
- «Joomla 4 MVC Anatomy: Файл манифеста компонента (Manifest File)»
- «Joomla 4 MVC Anatomy: Файлы сайта компонента»
- «Joomla 4 MVC Anatomy: Загрузочные файлы админки»
- «Joomla 4 MVC Anatomy: Файлы для правки админки»
Перевод с английского официальной документации CMS Joomla 4:
https://docs.joomla.org/J4.x:MVC_Anatomy:_File_Structure
