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

Set

Описание и параметры

mixed
CFormStatus::Set(
	array fields,
	mixed status_id = false,
	string check_rights = "Y"
)

Добавляет новый статус или обновляет существующий. Возвращает ID обновленного или добавленного статуса в случае положительного результата, в противном случае - "false". Метод нестатический.

Параметры метода

Параметр Описание
fields Массив значений, в качестве ключей массива допустимы:
  • FORM_ID* - ID веб-формы;
  • TITLE* - заголовок статуса;
  • C_SORT - порядок сортировки;
  • ACTIVE - флаг активности; допустимы следующие значения:
    • Y - ответ активен;
    • N - ответ не активен (по умолчанию).
  • DESCRIPTION - описание статуса;
  • CSS - имя CSS класса для вывода заголовка статуса;
  • HANDLER_OUT - путь относительно корня к обработчику, вызываемому при смене у результата данного статуса на какой либо другой;
  • HANDLER_IN - путь относительно корня к обработчику, вызываемому при смене у результата какого либо статуса на данный;
  • DEFAULT_VALUE - флаг установки статуса по умолчанию, допустимы следующие значения:
    • Y - статус будет устанавливаться;
    • N - статус не будет устанавливаться (по умолчанию).
  • arPERMISSION_VIEW* - массив ID групп пользователей, имеющих право "Просмотр результатов в данном статусе";
  • arPERMISSION_MOVE* - массив ID групп пользователей, имеющих право "Перевод результатов в данный статус";
  • arPERMISSION_EDIT* - массив ID групп пользователей, имеющих право "Редактирование результатов в данном статусе";
  • arPERMISSION_DELETE* - массив ID групп пользователей, имеющих право "Удаление результатов в данном статусе".

* - обязательно к заполнению.
* - в данных массивах может быть элемент со значением "0", означающий создателя результата.
status_id ID обновляемого статуса.
Параметр необязательный. По умолчанию - "false" (добавление нового статуса).
check_rights Флаг необходимости проверки прав текущего пользователя. Возможны следующие значения:
  • Y - права необходимо проверить;
  • N - право не нужно проверять.
Для обновления статуса, либо создания нового статуса необходимо иметь право [30] Полный доступ на форму указанную в fields["FORM_ID"].

Параметр необязательный. По умолчанию - "Y" (права необходимо проверить).

Смотрите также

Примеры использования

<?
$FORM_ID = 4; // ID веб-формы

$arFields = array(
	"FORM_ID"             => $FORM_ID,               // ID веб-формы
	"C_SORT"              => 100,                    // порядок сортировки
	"ACTIVE"              => "Y",                    // статус активен
	"TITLE"               => "Опубликовано",         // заголовок статуса
	"DESCRIPTION"         => "Окончательный статус", // описание статуса
	"CSS"                 => "statusgreen",          // CSS класс
	"HANDLER_OUT"         => "",                     // обработчик
	"HANDLER_IN"          => "",                     // обработчик
	"DEFAULT_VALUE"       => "N",                    // не по умолчанию
	"arPERMISSION_VIEW"   => array(2),               // право просмотра для всех
	"arPERMISSION_MOVE"   => array(),                // право перевода только админам
	"arPERMISSION_EDIT"   => array(),                // право редактирование для админам
	"arPERMISSION_DELETE" => array(),                // право удаления только админам
);

$NEW_ID = CFormStatus::Set($arFields);
if ($NEW_ID>0) echo "Успешно добавлен ID=".$NEW_ID;
else // ошибка
{
	// выводим текст ошибки
	global $strError;
	echo $strError;
}
?>


© «Битрикс», 2001-2024, «1С-Битрикс», 2024