Bitrix Framework - технологическое ядро (платформа) для создания и управления проектами (веб-сайтами и корпоративными порталами). Платформа позволяет создавать неограниченное количество проектов с применением одной копии (лицензии) продукта, размещая ядро и базу данных системы в единственном экземпляре на сервере.

На данный момент не все возможности старого ядра продублированы в D7. Но новое ядро D7 в Bitrix Framework постепенно замещает старое. Если использование старого ядра привело к предупреждению от IDE: Method/class is deprecated, значит нужно использовать методы D7.

В силу ряда причин API документация может не охватывать все методы. Для понимания работы иногда лучше просмотреть собственно программный код. Для этого можно использовать бесплатный модуль из Маркетплейса: Живое описание АПИ.

Данная документация носит только справочный характер. Детальное описание принципов работы с системой описаны в учебном курсе Разработчик Bitrix Framework. Следить за изменениями в документации можно с помощью страницы Что нового?, либо подпиской на канал в Телеграмме, а также в блоге Отдела документации.

Примечание: добавив к адресу любой страницы #examples можно быстро перейти к примеру, если он на ней есть. (В файлах документации формата CHM это не работает.)

На каждой странице документации авторизованный на сайте посетитель может дать комментарий к содержимому страницы. Для этого воспользуйтесь расположенной в правом нижнем углу окна браузера кнопкой:

 Документация также доступна в виде файла в формате chm: bsm_api.chm.
Рекомендуется пользоваться онлайн версией, как более актуальной. Файлы формата chm обновляются периодически, в них может отсутствовать информация по последним изменениям в справочной системе. При возникновении проблем с просмотром скачанного файла chm откройте свойства файла и во вкладке "Общие" нажмите кнопку Разблокировать .

Версии сущностей

Bitrix Framework постоянно развивается. Появляются новые функции, некоторые устаревают, в функциях появляются новые параметры. Однако достаточно большое число проектов не обновляются. Для облегчения программистского труда в документации проставлено с какой и по какую версию продукта класс, метод, параметр, событие существовали (существуют).

Версии проставляются в двух местах: в названии и в таблицах. Если метод действующий, то в заголовке будет стоять только номер версии с которой он появился в продукте. Если метод устарел, то там же будет указан диапазон версий, где он был действующий.

В таблицах указывается версия, с которой сущность появилась в продукте, только в том случае, если её появление не совпадает с моментом появления самого класса, метода и так далее. На иллюстрации ниже: параметр COURSE_ID появился вместе с методом (то есть с 5.1.0), а параметр CHAPTER_ID только с версии 9.5.4.

Если с развитием продукта параметр (обычно это относится к параметрам) изменялся, то будет соответствующее примечание в его описании. (Например: до версии х.х.х параметр назывался *****).

Пример