Совместимость с XenForo: 2.0
В каталоге плагинов есть множество файлов и каталогов, которые имеют особую цель и смысл.
Файл addon.json:
addon.json - это файл, содержащий несколько фрагментов информации, которые необходимы, чтобы помочь XF 2.0 идентифицировать плагин и отображать информацию об этом в Панели управления. Как минимум, ваш файл addon.json должен выглядеть так:
Базовый файл будет создан для вас автоматически при создании плагина (Создание плагина через консоль). Он поддерживает намного больше, чем пример выше, но мы поговорим об этом более подробно позже.
Включение этого файла является обязательным.
Файл hashes.json
hashes.json - это новый способ добавить поддержку системы проверки работоспособности файлов, и лучшая часть - она генерируется автоматически, при выпуске в релиз плагина!
Файл Setup.php
Setup.php - это новый дом для любого кода, который требуется запускать во время установки, обновления или удаления вашего дополнения. Файл не обязательный
Каталог _data
В каталоге _data хранятся основные данные для вашего плагина. Каждый дополнительный тип данных будет иметь свой собственный XML-файл (а не один для всех типов). Хэши для этих файлов включены внутри hashes.json, поэтому мы можем гарантировать, что плагин содержит полные и согласованные данные, прежде чем разрешить установку плагина.
Каталог _output
Каталоги _output не требуются для успешной установки плагина и не должны включаться при выпуске плагина. Этот каталог предназначен исключительно для целей разработки и используется только в том случае, если включен режим разработки (Режим разработки).
Каждый элемент дополнительных данных хранится в отдельном файле. В основном они хранятся в виде файлов JSON, но в случае фраз они хранятся в виде файлов TXT, а для шаблонов они хранятся в виде файлов HTML / CSS / LESS. Все типы шаблонов редактируются непосредственно в файловой системе, а изменения, внесенные в эти файлы, автоматически записываются в базу данных при загрузке.
Класс установки
Чтобы создать класс установки для вашего плагиа, все, что вам нужно сделать, это создать файл с именем Setup.php в корневом каталоге вашего плагина.
Класс Setup должен расширять \XF\AddOn\AbstractSetup, которая требует, как минимум, для реализации методов install(), upgrade() и uninstall(). Вот как может выглядеть простой класс установки плагина:
Класс Setup также поддерживает выполнение каждого из действий в разных шагах. Чтобы реализовать это поведение, ваш класс Setup может использовать свойства StepRunnerInstallTrait, StepRunnerUpgradeTrait и/или StepRunnerUninstallTrait. Они автоматически реализуют требуемые методы, и вам просто нужно добавить соответствующие шаги, например. installStep1(), upgrade1000170Step1(), upgrade1000170Step2() и uninstallStep1(), где 1000170 и т. д. в методах обновления являются дополнительными идентификаторами версии (смотреть Рекомендации к версиям плагинов).
В каталоге плагинов есть множество файлов и каталогов, которые имеют особую цель и смысл.
Файл addon.json:
addon.json - это файл, содержащий несколько фрагментов информации, которые необходимы, чтобы помочь XF 2.0 идентифицировать плагин и отображать информацию об этом в Панели управления. Как минимум, ваш файл addon.json должен выглядеть так:
Базовый файл будет создан для вас автоматически при создании плагина (Создание плагина через консоль). Он поддерживает намного больше, чем пример выше, но мы поговорим об этом более подробно позже.
Включение этого файла является обязательным.
Файл hashes.json
hashes.json - это новый способ добавить поддержку системы проверки работоспособности файлов, и лучшая часть - она генерируется автоматически, при выпуске в релиз плагина!
Файл Setup.php
Setup.php - это новый дом для любого кода, который требуется запускать во время установки, обновления или удаления вашего дополнения. Файл не обязательный
Каталог _data
В каталоге _data хранятся основные данные для вашего плагина. Каждый дополнительный тип данных будет иметь свой собственный XML-файл (а не один для всех типов). Хэши для этих файлов включены внутри hashes.json, поэтому мы можем гарантировать, что плагин содержит полные и согласованные данные, прежде чем разрешить установку плагина.
Каталог _output
Каталоги _output не требуются для успешной установки плагина и не должны включаться при выпуске плагина. Этот каталог предназначен исключительно для целей разработки и используется только в том случае, если включен режим разработки (Режим разработки).
Каждый элемент дополнительных данных хранится в отдельном файле. В основном они хранятся в виде файлов JSON, но в случае фраз они хранятся в виде файлов TXT, а для шаблонов они хранятся в виде файлов HTML / CSS / LESS. Все типы шаблонов редактируются непосредственно в файловой системе, а изменения, внесенные в эти файлы, автоматически записываются в базу данных при загрузке.
Класс установки
Чтобы создать класс установки для вашего плагиа, все, что вам нужно сделать, это создать файл с именем Setup.php в корневом каталоге вашего плагина.
Класс Setup должен расширять \XF\AddOn\AbstractSetup, которая требует, как минимум, для реализации методов install(), upgrade() и uninstall(). Вот как может выглядеть простой класс установки плагина:
Класс Setup также поддерживает выполнение каждого из действий в разных шагах. Чтобы реализовать это поведение, ваш класс Setup может использовать свойства StepRunnerInstallTrait, StepRunnerUpgradeTrait и/или StepRunnerUninstallTrait. Они автоматически реализуют требуемые методы, и вам просто нужно добавить соответствующие шаги, например. installStep1(), upgrade1000170Step1(), upgrade1000170Step2() и uninstallStep1(), где 1000170 и т. д. в методах обновления являются дополнительными идентификаторами версии (смотреть Рекомендации к версиям плагинов).
