https://github.com/coderius/guide_create_composer_extension
In this guide step by step I show how create composer extension.
https://github.com/coderius/guide_create_composer_extension
composer composer-package composer-plugin create-composer-plugin guide
Last synced: 6 months ago
JSON representation
In this guide step by step I show how create composer extension.
- Host: GitHub
- URL: https://github.com/coderius/guide_create_composer_extension
- Owner: coderius
- Created: 2019-03-02T12:29:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-11T17:01:00.000Z (almost 7 years ago)
- Last Synced: 2025-03-18T19:56:02.108Z (11 months ago)
- Topics: composer, composer-package, composer-plugin, create-composer-plugin, guide
- Size: 3.91 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Инструкяция по созданию расширения.
===================================
_Создание расширения на примере расширения для yii2._
1. Создаем файл *composer.json* в корне расширения примерно такого плана:
```javascript
{
"name": "coderius/yii2-lightbox2-widget",
"description": "Yii 2 lightbox2-widget",
"version": "1.0.0",
"keywords": ["lightbox", "widget", "lightbox2", "yii2"],
"type": "yii2-extension",
"license": "MIT",
"authors": [
{
"name": "Serg Coderius",
"email": "sunrise4fun@gmail.com"
}
],
"require": {
"php": ">=5.4.0",
"yiisoft/yii2": "~2.0.0"
},
"require-dev": {
"phpunit/phpunit": "*"
},
"autoload": {
"psr-4": {
"coderius\\lightbox2\\": "src/"
}
},
"repositories": [
{
"type": "path",
"url": "/opt/lampp/htdocs/yii2-extentions/yii2-lightbox2-widget"
}
]
}
```
Для того, чтобы подключать расширение из локального компьютера (во время разработки) - указываем нужный адрес, где расширение
расположено в корне проекта yii2, к которому подключаем модуль в composer.json. Это нужно для того, чтобы загрузить расширение, которое лежит на локальном компьютере в проект по средствам композера.
```javascript
"repositories": [
{
"type": "path",
"url": "/opt/lampp/htdocs/yii2-extentions/yii2-lightbox2-widget"
}
]
```
Также нужно указать версию как в примере.
2.Инициализируем git
*
git init .
git add .
git commit -m "Commit"
*
3. В папке проекта yii2 в файле _composer.json_, куда включаем пакет добавляем:
```javascript
"repositories": [
{
"type": "path",
"url": "/opt/lampp/htdocs/yii2-extentions/yii2-lightbox2-widget"
}
],
```
4.Переходим в консоли в папку проекта yii2, для которого подключаем расширение.
5.Устанавливаем пакет из локального компьютера:
```
composer clear-cache
composer require "coderius/yii2-lightbox2-widget" "*"
```
6.Возможно расширение будет содержать зависимости из bower (например, какие-то скрипты типа jquery).
Для того, чтобы включить в composer.json расширения скрипты из bower нужно:
*Установить bower-asset плагин для взаимодействия с [https://asset-packagist.org](https://asset-packagist.org)
_Не забыть выполнить комманду *composer global require "fxp/composer-asset-plugin:^1.2.0"* для
установки плагина_
* Также возможно нужно указать папки для хранения скриптов в проекте:
```
"config": {
"fxp-asset": {
"installer-paths": {
"npm-asset-library": "vendor/npm",
"bower-asset-library": "vendor/bower"
}
}
},
```
# Инициализация расширения в проекте yii2. #
Теперь, когда расширение (_если наше расширение - модуль_) установлено из локального компьютера (где ведется разработка), его нужно подключить в проект. Для этого нужно открыть конфигурационный файл. В advanсed шаблоне это common/config/main.php и добавить его в массив 'modules':
```
'modules' => [
'comment' => [
'class' => 'yii2mod\comments\Module',
],
]
```
В ключе 'class' содержится класс модуля Module с пространством имен, соответствующим тому, что был указан в composer.json расширения:
```
"autoload": {
"psr-4": {
"coderius\\comments\\": ""
}
},
```
Или для виджета так:
```
"autoload": {
"psr-4": {
"coderius\\lightbox2\\": "src/"
}
},
```