PHPackages                             matiaspub/bx-api-docs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. matiaspub/bx-api-docs

AbandonedArchivedLibrary[API Development](/categories/api)

matiaspub/bx-api-docs
=====================

phpDoc for bitrix framework

16.5.6(8y ago)2873.1k871MITPHP

Since Mar 17Pushed 3y ago73 watchersCompare

[ Source](https://github.com/matiaspub/bxApiDocs)[ Packagist](https://packagist.org/packages/matiaspub/bx-api-docs)[ RSS](/packages/matiaspub-bx-api-docs/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)DependenciesVersions (2)Used By (1)

### 🛑 Проект не поддерживается

[](#-проект-не-поддерживается)

bxApiDocs
=========

[](#bxapidocs)

bxApiDocs призван упростить, не самую сладкую, жизнь разработчику 1С-Битрикс
----------------------------------------------------------------------------

[](#bxapidocs-призван-упростить-не-самую-сладкую-жизнь-разработчику-1с-битрикс)

Это сама по себе папка с модулями `/bitrix/modules/`, [1С-Битрикс: Управление сайтом](https://www.1c-bitrix.ru/products/cms/) - **[Бизнес](http://www.1c-bitrix.ru/download/cms.php#tab-php-link)**, но с убранными лишними файлами и папками (не `.php`, без классов методов, констант и т.д.), добавленными константами, событиями и хелпами phpDocs.

Что умеет
---------

[](#что-умеет)

Сам по себе ничего не умеет, но содержит несколько крупных вкусностей, что в комплекте с IDE колоcально облегчает жизнь разработчику (расхолаживает, обленяет и т.д. - так что *будьте осторожны*).

### Фичи

[](#фичи)

- **В общем-то само API**, со всеми [phpDocs](http://ru.wikipedia.org/wiki/PHPDoc)’ами, что удалось автоматически вытащить с [ресурса](http://dev.1c-bitrix.ru/api_help/) официальной документации.
- **Есть даже константы**. Но хелпы есть только у тех, что можно найти на вышеприведенном ресурсе официальной документации.
- **События модулей**. Синтетические классы с набором методов, т.е. контейнер с возможными событиями определенного модуля, все также с документациями.

Документации с примерами использования и ссылками на [ресурс](http://dev.1c-bitrix.ru/api_help/) официальной документации. Константы и события находятся в соответствующих модулях в файлах `bx_events.php` и `bx_constants.php` (Например `/modules/main/bx_events.php` и `/modules/main/bx_constants.php`). Соответственно константы, употребленные в файлах `bx_constants.php`, в местах иx реального употребления закомментированы.

Как использовать
----------------

[](#как-использовать)

Добавляем в индексацию любимого IDE или в Composer и все. Счастье!

### Composer

[](#composer)

`composer require matiaspub/bx-api-docs --dev`

Composer скачает все доки в папку vendor, IDE проиндексирует изменения. Вам останется наслаждаться результатом.

### Eclipse

[](#eclipse)

**Обязательно PDT (либо аналог)**. В окне PHP Explorer правой кнопкой по проекту, пункт выпадающего меню `Configure -> Add PHP Support`. Снова правой кнопкой по проекту, пункт меню `Include Path -> Configure Include Path`. В окне либо добавляем во **вкладке Libraries** добавляем папку `modules` (кнопка **Add External Source Folder**), либо во **вкладке Projects** добавляем проект `modules` (кнопка **Add**). Предварительно нужно создать проект на основе папки modules и добавить ему поддержку PHP (`Configure -> Add PHP Support` из первого метода). Используя второй метод, Вы сможете редактировать файлы проекта `modules`, когда, воспользовавшись первым методом, файлы-подсказки `modules` будут read-only.

### PhpStorm

[](#phpstorm)

В настройках PHP IDE PhpStorm (`File -> Settings -> Default Settings -> PHP` или `File -> Settings -> Languages & Frameworks -> PHP` ) области `Include Path` нажав на "+" добавляем путь к папке `modules`.

*Примечание: в первом случае добавляется папка `modules` для всех новых проектов, во втором - для текущего проекта.*

Брюки превращаются. Брюююки прррревращаются.....
------------------------------------------------

[](#брюки-превращаются-брюююки-прррревращаются)

### Основные синглтоны $APPLICATION, $DB, $USER, $USER\_FIELD\_MANAGER с подсказками

[](#основные-синглтоны-application-db-user-user_field_manager-с-подсказками)

[![Синглтоны: $APPLICATION](https://camo.githubusercontent.com/b5180c06d408470663bac82275cbe0f9df577cd9fa3af16b75ce80c285fd4fd0/68747470733a2f2f6d6f6e6f736e61702e636f6d2f696d6167652f64706c726a534c6d4258744b3341385276336e584a496a36672e706e67)](https://camo.githubusercontent.com/b5180c06d408470663bac82275cbe0f9df577cd9fa3af16b75ce80c285fd4fd0/68747470733a2f2f6d6f6e6f736e61702e636f6d2f696d6167652f64706c726a534c6d4258744b3341385276336e584a496a36672e706e67)

### Максимально полные доки по методам и классам

[](#максимально-полные-доки-по-методам-и-классам)

[![Доки по методам и классам](https://camo.githubusercontent.com/40a08ce25ff7f6e3e0090dc3a0eab86b33f87e55e92780b0a06531389eea7e00/68747470733a2f2f6d6f6e6f736e61702e636f6d2f696d6167652f396f526135625a6a3971624c56654e6b3352364e59753434752e706e67)](https://camo.githubusercontent.com/40a08ce25ff7f6e3e0090dc3a0eab86b33f87e55e92780b0a06531389eea7e00/68747470733a2f2f6d6f6e6f736e61702e636f6d2f696d6167652f396f526135625a6a3971624c56654e6b3352364e59753434752e706e67)

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

[](#посмотреть-события-модуля-и-почитать-как-его-использовать-можно-так)

[![События модуля с доками](https://camo.githubusercontent.com/c1e3f87cf95bae79f9d930baa00cb067679c7dc43b43b77572f5c8bd327392b5/68747470733a2f2f6d6f6e6f736e61702e636f6d2f696d6167652f397049686a687659624b353652756d767456666f5267446c732e706e67)](https://camo.githubusercontent.com/c1e3f87cf95bae79f9d930baa00cb067679c7dc43b43b77572f5c8bd327392b5/68747470733a2f2f6d6f6e6f736e61702e636f6d2f696d6167652f397049686a687659624b353652756d767456666f5267446c732e706e67)

### Константы с доками

[](#константы-с-доками)

[![Константы с доками](https://camo.githubusercontent.com/9223981788f3b1fd2920ba2e9678109a7c5135bbdc5622a1237643f4841082b3/68747470733a2f2f6d6f6e6f736e61702e636f6d2f696d6167652f4662424c7736373763456655724f4d6375474f6a48396a33482e706e67)](https://camo.githubusercontent.com/9223981788f3b1fd2920ba2e9678109a7c5135bbdc5622a1237643f4841082b3/68747470733a2f2f6d6f6e6f736e61702e636f6d2f696d6167652f4662424c7736373763456655724f4d6375474f6a48396a33482e706e67)

Да, согласен
------------

[](#да-согласен)

Подсказки есть не на все методы и с ошибками, но и без этого есть многое (то что, повторюсь, удалось спарсить в автоматическом режиме с сайта оф.доков на котором порядка не больше чем в API). К тому же у Вас есть шанс поучавствовать во вселенском добре, закоммитив изменения или дополнения в эту ветку.

Обновления
----------

[](#обновления)

Обновления происходят только по мажорным версиям главного модуля.

Контакты
--------

[](#контакты)

- **twitter**: [matiaspub](https://twitter.com/matiaspub)
- **email**:

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity40

Moderate usage in the ecosystem

Community30

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 82.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2985d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b47d0dc1ea09c2a537ed59023e12834fb0c518dca6f5311677ccaae0f5bc1c1f?d=identicon)[matiaspub](/maintainers/matiaspub)

---

Top Contributors

[![matiaspub](https://avatars.githubusercontent.com/u/1339704?v=4)](https://github.com/matiaspub "matiaspub (57 commits)")[![nook-ru](https://avatars.githubusercontent.com/u/444489?v=4)](https://github.com/nook-ru "nook-ru (7 commits)")[![demoneno4ec](https://avatars.githubusercontent.com/u/48438436?v=4)](https://github.com/demoneno4ec "demoneno4ec (1 commits)")[![victorlapshev](https://avatars.githubusercontent.com/u/10122154?v=4)](https://github.com/victorlapshev "victorlapshev (1 commits)")[![xnovikov](https://avatars.githubusercontent.com/u/5765426?v=4)](https://github.com/xnovikov "xnovikov (1 commits)")[![max-starikevich](https://avatars.githubusercontent.com/u/6186896?v=4)](https://github.com/max-starikevich "max-starikevich (1 commits)")[![ildarkhasanshin](https://avatars.githubusercontent.com/u/8765305?v=4)](https://github.com/ildarkhasanshin "ildarkhasanshin (1 commits)")

---

Tags

apiphpdocautocompletebitrixide-helper

### Embed Badge

![Health badge](/badges/matiaspub-bx-api-docs/health.svg)

```
[![Health](https://phpackages.com/badges/matiaspub-bx-api-docs/health.svg)](https://phpackages.com/packages/matiaspub-bx-api-docs)
```

###  Alternatives

[phpdocumentor/phpdocumentor

Documentation Generator for PHP

4.4k3.1M878](/packages/phpdocumentor-phpdocumentor)[apigen/apigen

PHP source code API generator.

2.2k627.9k225](/packages/apigen-apigen)[pronamic/wp-documentor

Documentation Generator for WordPress.

6529.8k5](/packages/pronamic-wp-documentor)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)