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

GetByID

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

CDBResult
CStopList::GetByID(
	int record_id
)

Возвращает данные по записи стоп-листа.

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

Параметр Описание
record_id ID записи сто-листа.

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

Структура возвращаемой записи

Array
(
	[ID] => ID записи
	[TIMESTAMP_X] => время изменения
	[DATE_START] => время с которого запись начинает действовать
	[DATE_END] => время после которого действие записи заканчивается
	[ACTIVE] => "Y" - запись активна; "N" - запись не активна
	[SAVE_STATISTIC] => "Y" - сохранять статистику по посетителю, попавшему в стоп-лист; "N" - не сохранять подобную статистику
	[IP_1] => октет 1 IP адреса
	[IP_2] => октет 2 IP адреса
	[IP_3] => октет 3 IP адреса
	[IP_4] => октет 4 IP адреса
	[MASK_1] => маска для октета 1 IP адреса
	[MASK_2] => маска для октета 2 IP адреса
	[MASK_3] => маска для октета 3 IP адреса
	[MASK_4] => маска для октета 4 IP адреса
	[USER_AGENT] => UserAgent посетителя
	[USER_AGENT_IS_NULL] => "Y" - UserAgent посетителя не задан (пустой); "N" - UserAgent посетителя задан (значение по умолчанию)
	[URL_TO] => страница (или ее часть), на которую приходит посетитель
	[URL_FROM] => ссылающаяся страница (или ее часть), с которой приходит посетитель
	[MESSAGE] => текст сообщения, которое будет выдано посетителю сайта, в случае его попадания под данную запись стоп-листа
	[MESSAGE_LID] => язык сообщения задаваемого в поле [MESSAGE]
	[URL_REDIRECT] => страница, на которую необходимо перенаправить посетителя после его попадания под данную запись стоп-листа
	[COMMENTS] => административный комментарий; используется, как правило, для указания причин создания данной записи
	[TEST] => "Y" - данная запись является тестовой; "N" - данная запись не тестовая (см. метод CStopList::Check)
	[SITE_ID] => ID сайта, для которого запись будет действительна; если значение не задано, то это означает, что запись действительная для всех сайтов
	[LAMP] => "green" - запись активна и работает; "red" - запись по каким либо причинам не активна (возможно истек срок действия, либо снят флаг активности)
)

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

<?
$stop_id = 1;
if ($rs = CStopList::GetByID($stop_id))
{
	$ar = $rs->Fetch();
	// выведем параметры записи стоп-листа
	echo "<pre>"; print_r($ar); echo "</pre>";
}
?>


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх