README

bxApiDocs 的目的是简化 1С-Битрикс 开发者不那么甜蜜的生活

这是一个包含模块的文件夹本身 /bitrix/modules/，1С-Битрикс: Управление сайтом - 商业，但已删除多余的文件和文件夹（不包括 .php，没有类、方法、常量等），添加了常量、事件和 phpDocs 帮助。

功能

本身没有功能，但它包含了一些有用的特性，与 IDE 结合使用可以极大地简化开发者的工作（让开发者放松、方便等 - 所以 请谨慎使用）。

特性

• API 本身，包含所有 phpDocs，从官方文档资源自动提取。
• 甚至有常量。但只有可以在上述官方文档资源中找到的常量才有帮助。
• 模块事件。包含方法集的合成类，即特定模块可能发生的事件的容器，所有这些都带有文档。

带有示例用法和指向官方文档资源的链接的文档。常量和事件位于相应的模块中，分别在 bx_events.php 和 bx_constants.php 文件中（例如 /modules/main/bx_events.php 和 /modules/main/bx_constants.php）。相应地，在 bx_constants.php 文件中使用的常量，在实际使用的地方被注释掉。

如何使用

将其添加到 IDE 的索引中，然后就是幸福！

Eclipse

必须安装 PDT（或类似版本）。在 PHP Explorer 窗口中，通过右键单击项目，选择弹出菜单中的 Configure -> Add PHP Support。再次右键单击项目，选择菜单中的 Include Path -> Configure Include Path。在窗口中，在 库 标签页中，添加 modules 文件夹（点击 添加外部源文件夹 按钮），或者在 项目 标签页中添加 modules 项目（点击 添加 按钮）。预先需要根据 modules 文件夹创建项目并添加 PHP 支持（使用第一种方法中的 Configure -> Add PHP Support）。使用第二种方法，您将能够编辑 modules 项目的文件，而当使用第一种方法时，modules 文件的提示将是只读的。

PhpStorm

在 PhpStorm 的 PHP IDE 设置中（File -> Settings -> Default Settings -> PHP 或 File -> Settings -> Languages & Frameworks -> PHP），在 Include Path 区域中，点击 "+" 添加 modules 文件夹的路径。

注意：在第一种情况下，将 modules 文件夹添加到所有新项目，在第二种情况下，添加到当前项目。

裤子变成。裤裤变变变.....

主要单例 $APPLICATION, $DB, $USER, $USER_FIELD_MANAGER 以及相关提示

关于方法和类的最完整文档

查看模块事件及其使用方法如下

常量与文档

是的，同意

并非所有方法和提示都是正确的，但即便如此，也有很多内容（再次强调，这些内容是通过自动从官方文档网站中提取的，其中条目数量不超过API）。此外，您还有机会参与全球的善举，通过提交更改或补充到这个分支来贡献。

更新

更新仅发生在主要模块的重大版本中。

联系方式

• twitter: matiaspub
• email: matiaspub@gmail.com