Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fi1a/bitrixrequire

Модуль 1С-Битрикс "Обертка над composer для установки зависимостей"
https://github.com/fi1a/bitrixrequire

bitrix bitrix-module composer composer-package php

Last synced: about 1 month ago
JSON representation

Модуль 1С-Битрикс "Обертка над composer для установки зависимостей"

Host: GitHub
URL: https://github.com/fi1a/bitrixrequire
Owner: fi1a
License: mit
Created: 2023-01-03T00:16:45.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-02-26T04:33:45.000Z (almost 2 years ago)
Last Synced: 2023-03-11T05:57:01.535Z (almost 2 years ago)
Topics: bitrix, bitrix-module, composer, composer-package, php
Language: PHP
Homepage:
Size: 878 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Модуль 1С-Битрикс "Обертка над composer для установки зависимостей"

[![Software License][badge-license]][license]
[![Support mail][badge-mail]][mail]

Часто бывает так, что необходимо использовать в модуле пакет распростаняемый через composer. Простое включение
его в поставку с модулем не решает проблему так как может возникнуть ситуация, что два модуля включили один и тот же пакет два раза.
Данный модуль представляет собой обертку над composer и решает проблему путем
включения зависимостей модулей централизованно через composer.
Это можно сделать используя предоставляемый API при установке ваших модулей.

Также модуль имеет интерфейс с функцией управления зависимостями (добавления, обновления и удаления пакетов).
Данная возможность будет полезна при отсутствии доступа к консоли.

После установки модуль будет доступен в меню: Настройки > Установка зависимостей.

## Установка модуля

Модуль можно установить из Маркетплейса 1С-Битрикс
["Обертка над composer для установки зависимостей"](http://marketplace.1c-bitrix.ru/solutions/fi1a.bitrixrequire/)

## Изображения модуля

Интерфейс управления зависимостями в админке 1С-Битрикс.

![Интерфейс управления зависимостями в админке 1С-Битрикс](images/fi1a.bitrixrequire-screen-1.png)

Настройки расположения домашней директории composer.

![Настройки расположения домашней директории composer](images/fi1a.bitrixrequire-screen-2.png)

## Установка и удаление пакетов модуля

При установке вашего модуля можно вызвать метод `require` класса `Fi1a\BitrixRequire\ModulePackages`
для установки пакета через composer с указанной версией
(перед вызовом необходимо проверить установлен ли модуль "fi1a.bitrixrequire").

Пример:

```php
use Fi1a\BitrixRequire\ModulePackages;

$modulePackages = new ModulePackages();
$result = $modulePackages->require('fi1a.bitrixrequire', 'fi1a/format', '^2.0');
$result->isSuccess(); // true
```

Аргументы метода `require` класса `Fi1a\BitrixRequire\ModulePackages`:

| Аргумент | Описание |
|--------------------------|------------------------------------------------|
| string $moduleId | Идентификатор вашего модуля |
| string $package | Название пакета от которого зависит ваш модуль |
| ?string $version = null | Версия пакета |

При удалении вашего модуля следует вызвать метод `remove` класса `Fi1a\BitrixRequire\ModulePackages`
для удаления информации о зависимости модуля от указанного пакета:

```php
use Fi1a\BitrixRequire\ModulePackages;

$modulePackages = new ModulePackages();
$result = $modulePackages->remove('fi1a.bitrixrequire', 'fi1a/format');
$result->isSuccess(); // true
```

Аргументы метода `remove` класса `Fi1a\BitrixRequire\ModulePackages`:

## Подключение vendor/autoload.php

Для подключения vendor/autoload.php достаточно в файле php_interface/init.php подключить модуль 'fi1a.bitrixrequire':

```php
use Bitrix\Main\Loader;

Loader::includeModule('fi1a.bitrixrequire');
```

[badge-license]: https://img.shields.io/github/license/fi1a/bitrixvalidation?style=flat-square
[badge-mail]: https://img.shields.io/badge/mail-support%40fi1a.ru-brightgreen

[license]: https://github.com/fi1a/bitrixvalidation/blob/master/LICENSE
[mail]: mailto:[email protected]