Check

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

mixed
CStopList::Check(
	string test = "N",
	mixed params = false
)

Выполняет проверку на попадание текущего посетителя под условия записей стоп-листа. Данный метод автоматически вызывается в прологе на каждом хите.

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

Параметр	Описание
test	При управлении стоп-листом существует вероятность занести самого себя в стоп-лист. Для исключения подобных ситуаций, система сначала добавляет в стоп-лист тестовую запись, проверяет текущего посетителя на попадание в стоп-лист по этой тестовой записи и если посетитель не пападает под нее, то она удаляется. Если вызвать данный метод с параметром test="Y", она проверит попадание текущего посетителя только под тестовые записи стоп-листа. Если же метод вызывается с параметром test="N" (значение по умолчанию), то он будет проверять попадание посетителя уже под все записи стоп-листа, за исключением тестовых.
params	Здесь можно задать массив параметров для которых будет произведена проверка на попадание в стоп-лист. Ключами данного массива могут быть: IP - IP адрес в формате XXX.XXX.XXX.XXX; USER_AGENT - UserAgent (полный, либо его часть); URL_FROM - ссылающаяся страница; URL_TO - страница на которую приходит посетитель; SITE_ID - ID сайта.

Параметр

Описание

test

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

Если вызвать данный метод с параметром test="Y", она проверит попадание текущего посетителя только под тестовые записи стоп-листа. Если же метод вызывается с параметром test="N" (значение по умолчанию), то он будет проверять попадание посетителя уже под все записи стоп-листа, за исключением тестовых.

params

Здесь можно задать массив параметров для которых будет произведена проверка на попадание в стоп-лист. Ключами данного массива могут быть:

IP - IP адрес в формате XXX.XXX.XXX.XXX;
USER_AGENT - UserAgent (полный, либо его часть);
URL_FROM - ссылающаяся страница;
URL_TO - страница на которую приходит посетитель;
SITE_ID - ID сайта.

Возвращаемое значение

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

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

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

<?
// зададим параметры посетителя для которых мы хотим проверить попадание в стоп-лист
$arParams = array(
	"IP" => "192.168.0.1",
	"USER_AGENT" => "Firefox"
);

$record_id = CStopList::Check("N", $arParams);
if (intval($record_id)>0) 
	echo "Попадание в стоп-лист под параметры записи #".intval($record_id);
?>

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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх