Документация для разработчиков

Работа с объектом

Внимание! Мы настоятельно рекомендуем ознакомиться сначала с REST-документацией модуля Сайты, чтобы понять как модуль функционирует (тем более REST доступен и в коробочной версии). Данную документацию рассматривайте как подспорье при работе в коробке, когда вам действительно мало функционала REST, или вы хотите детальнее разобраться в API.

Объект сущности Страница это самодостаточный объект, обладающий всеми характеристиками страницы, и содержащий все блоки для вывода (каждый блок также является объектом и будет рассмотрен далее). Базовый код для работы с объектом представлен ниже.

if (\Bitrix\Main\Loader::includeModule('landing'))
{
   \Bitrix\Landing\Landing::setEditMode(true);
   
   $params = [];
   $landing = \Bitrix\Landing\Landing::createInstance(
      1,
      $params
   );
   if ($landing->exist())
   {
      //работа с лендингом
   }


   foreach ($landing->getError()->getErrors() as $error)
   {
      echo $error->getCode() . ': ';
      echo $error->getMessage();
      echo "\n";
   }
}

Массив $params является опциональным массивом параметров, который может содержать следующие ключи:

  • force_deleted (true / false): наполнить страницу как не удаленными блоками, так и удаленными (по-умолчанию удаленные игнорируются)
  • blocks_limit (int): количество блоков, инициированных в странице (по-умолчанию инициируются все блоки, связанные со страницей); удобно указывать значение 1, если объект страницы создается для некоторых действий, не связанных с блоками (например, копирование страницы)

Обратите внимание, в самом начале идет установка работы с черновиком через метод setEditMode. Это важно, так как каждая страница может быть наполнена либо черновыми блоками, либо опубликованными.

Идеология работы с объектом предполагает, что сначала необходимо произвести работы с черновиками блоков, а потом опубликовать страницу через метод publication.

Дальнейшие методы, описанные в данном подразделе, предполагают схему работу, описанную выше (режим работы, создание инстанса, проверка существование, работа, вывод ошибок).

Внимание! Вывод ошибок расположен отдельно, так как ошибка при работе со страницей может возникнуть не только на первом уровне, но и во внутренних методах (например при публикации). Имеет смысл сначала произвести необходимые действия, а потом проанализировать существующие ошибки.



© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх