Создание собственной структуры приложения

Примечание: Этот раздел находится в разработке.

Хотя шаблоны проектов базовый и расширенный подходят для большинства задач, вы можете создать собственный шаблон проекта, с которого начинать свои проекты.

Шаблоны проектов в Yii — это просто хранилища, содержащие файл composer.json, и зарегистрированные как пакет Composer. Любое хранилище может быть идентифицировано как пакет Composer, что делает его устанавливаемым с помощью команды create-project Composer.

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

Клонировать базовый шаблон

Первый шаг — клонировать Git-репозиторий базового шаблона Yii:

git clone git@github.com:yiisoft/yii2-app-basic.git

Затем дождитесь, пока репозиторий будет загружен на ваш компьютер. Поскольку внесённые в шаблон изменения не будут отправлены обратно, вы можете удалить папку .git и все её содержимое из загрузки.

Изменить файлы

Далее вам нужно будет изменить composer.json для отражения вашего шаблона. Измените значения name, description, keywords, homepage, license, и support, чтобы описать ваш новый шаблон. Также настройте require, require-dev, suggest, и другие параметры в соответствии с требованиями вашего шаблона.

Примечание: В файле composer.json используйте параметр writable в extra для указания разрешений на каждый файл, которые будут установлены после создания приложения с использованием шаблона.

Затем фактически измените структуру и содержимое приложения так, как вы хотите, чтобы было по умолчанию. Наконец, обновите файл README, чтобы он соответствовал вашему шаблону.

Создать пакет

После определения шаблона создайте из него Git-репозиторий и отправьте ваши файлы туда. Если вы собираетесь опубликовать свой шаблон с открытым исходным кодом, Github — лучшее место для его размещения. Если вы хотите сохранить шаблон без совместной работы, подойдёт любой сайт Git-репозиториев.

Далее вам нужно зарегистрировать свой пакет для Composer. Для общедоступных шаблонов пакет должен быть зарегистрирован на Packagist. Для закрытых шаблонов регистрация пакета немного сложнее. Инструкции см. в документации Composer.

Использовать шаблон

Это всё, что требуется для создания нового шаблона проекта Yii. Теперь вы можете создавать проекты, используя свой шаблон:

composer create-project --prefer-dist --stability=dev mysoft/yii2-app-coolone new-project