{"id":13435146,"url":"https://github.com/matiaspub/bxApiDocs","last_synced_at":"2025-03-18T02:31:04.799Z","repository":{"id":62525059,"uuid":"9728944","full_name":"matiaspub/bxApiDocs","owner":"matiaspub","description":null,"archived":true,"fork":false,"pushed_at":"2022-05-30T09:26:02.000Z","size":13079,"stargazers_count":297,"open_issues_count":0,"forks_count":84,"subscribers_count":74,"default_branch":"master","last_synced_at":"2024-09-21T14:08:38.231Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matiaspub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-28T10:56:12.000Z","updated_at":"2024-06-17T15:39:07.000Z","dependencies_parsed_at":"2022-11-02T14:15:32.737Z","dependency_job_id":null,"html_url":"https://github.com/matiaspub/bxApiDocs","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matiaspub%2FbxApiDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matiaspub%2FbxApiDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matiaspub%2FbxApiDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matiaspub%2FbxApiDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matiaspub","download_url":"https://codeload.github.com/matiaspub/bxApiDocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221704662,"owners_count":16866809,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T03:00:33.134Z","updated_at":"2024-10-27T16:31:54.477Z","avatar_url":"https://github.com/matiaspub.png","language":"PHP","funding_links":[],"categories":["\u003ca id=\"tools\"\u003eИнструменты\u003c/a\u003e"],"sub_categories":[],"readme":"### 🛑 Проект не поддерживается\n\n# bxApiDocs\n\n## bxApiDocs призван упростить, не самую сладкую, жизнь разработчику 1С-Битрикс\n\nЭто сама по себе папка с модулями `/bitrix/modules/`, [1С-Битрикс: Управление сайтом](https://www.1c-bitrix.ru/products/cms/) - **[Бизнес](http://www.1c-bitrix.ru/download/cms.php#tab-php-link)**, но с убранными лишними файлами и папками (не `.php`, без классов методов, констант и т.д.), добавленными константами, событиями и хелпами phpDocs.\n\n## Что умеет\n\nСам по себе ничего не умеет, но содержит несколько крупных вкусностей, что в комплекте с IDE колоcально облегчает жизнь разработчику (расхолаживает, обленяет и т.д. - так что *будьте осторожны*).\n\n### Фичи\n\n* **В общем-то само API**, со всеми [phpDocs](http://ru.wikipedia.org/wiki/PHPDoc)’ами, что удалось автоматически вытащить с [ресурса](http://dev.1c-bitrix.ru/api_help/) официальной документации.\n* **Есть даже константы**. Но хелпы есть только у тех, что можно найти на вышеприведенном ресурсе официальной документации.\n* **События модулей**. Синтетические классы с набором методов, т.е. контейнер с возможными событиями определенного модуля, все также с документациями.\n\nДокументации с примерами использования и ссылками на [ресурс](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 реального употребления закомментированы.\n\n## Как использовать\n\nДобавляем в индексацию любимого IDE или в Composer и все. Счастье!\n\n### Composer\n\n`composer require matiaspub/bx-api-docs --dev`\n\nComposer скачает все доки в папку vendor, IDE проиндексирует изменения. Вам останется наслаждаться результатом.\n\n### Eclipse\n\n**Обязательно PDT (либо аналог)**. В окне PHP Explorer правой кнопкой по проекту, пункт выпадающего меню `Configure -\u003e Add PHP Support`. Снова правой кнопкой по проекту, пункт меню `Include Path -\u003e Configure Include Path`. В окне либо добавляем во **вкладке Libraries** добавляем папку `modules` (кнопка **Add External Source Folder**), либо во **вкладке Projects** добавляем проект `modules` (кнопка **Add**). Предварительно нужно создать проект на основе папки modules и добавить ему поддержку PHP (`Configure -\u003e Add PHP Support` из первого метода). Используя второй метод, Вы сможете редактировать файлы проекта `modules`, когда, воспользовавшись первым методом, файлы-подсказки `modules` будут read-only.\n\n### PhpStorm\n\nВ настройках PHP IDE PhpStorm (`File -\u003e Settings -\u003e Default Settings -\u003e PHP` или `File -\u003e Settings -\u003e Languages \u0026 Frameworks -\u003e PHP` ) области `Include Path` нажав на \"+\" добавляем путь к папке `modules`.\n\n_Примечание: в первом случае добавляется папка `modules` для всех новых проектов, во втором - для текущего проекта._ \n\n## Брюки превращаются. Брюююки прррревращаются.....\n\n### Основные синглтоны $APPLICATION, $DB, $USER, $USER_FIELD_MANAGER с подсказками\n\n![Синглтоны: $APPLICATION](https://monosnap.com/image/dplrjSLmBXtK3A8Rv3nXJIj6g.png)\n\n### Максимально полные доки по методам и классам\n\n![Доки по методам и классам](https://monosnap.com/image/9oRa5bZj9qbLVeNk3R6NYu44u.png)\n\n### Посмотреть события модуля и почитать как его использовать можно так\n\n![События модуля с доками](https://monosnap.com/image/9pIhjhvYbK56RumvtVfoRgDls.png)\n\n### Константы с доками\n\n![Константы с доками](https://monosnap.com/image/FbBLw677cEfUrOMcuGOjH9j3H.png)\n\n## Да, согласен\n\nПодсказки есть не на все методы и с ошибками, но и без этого есть многое (то что, повторюсь, удалось спарсить в автоматическом режиме с сайта оф.доков на котором порядка не больше чем в API). К тому же у Вас есть шанс поучавствовать во вселенском добре, закоммитив изменения или дополнения в эту ветку.\n\n## Обновления\n\nОбновления происходят только по мажорным версиям главного модуля.\n\n## Контакты\n\n* **twitter**: [matiaspub](https://twitter.com/matiaspub)\n* **email**: matiaspub@gmail.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatiaspub%2FbxApiDocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatiaspub%2FbxApiDocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatiaspub%2FbxApiDocs/lists"}