Описание и параметры
CDBResult
CStopList::GetList(
string &by = "s_id",
string &order = "desc",
array filter = array(),
bool &is_filtered
)
Возвращает список записей стоп-листа.
Параметры метода
| Параметр | Описание |
|---|
| by | Поле для сортировки. Возможные значения:
- s_id - ID записи;
- s_date_start - время начала активности записи;
- s_date_end - время окончания активности записи ;
- s_site_id - ID сайта для которого действительна записи;
- s_active - флаг активности записи;
- s_save_statistic - флаг необходимости сохранять статистику по посетителю попавшему в стоп-лист;
- s_ip - IP адрес посетителя;
- s_mask - маска IP адреса посетителя;
- s_url_to - страница на которую приходит посетитель;
- s_url_from - ссылающаяся страница, с которой приходит посетитель.
|
| оrder | Порядок сортировки. Возможные значения:
- asc - по возрастанию;
- desc - по убыванию.
|
| filter | Массив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
- ID* - ID записи стоп-листа;
- ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение;
- DATE_START_1 - начальное значение интервала для поля "время начала активности записи";
- DATE_START_2 - конечное значение интервала для поля "время начала активности записи";
- DATE_END_1 - начальное значение интервала для поля "время окончания активности записи";
- DATE_END_2 - конечное значение интервала для поля "время окончания активности записи";
- ACTIVE - флаг активности записи, воможные значения:
- Y - запись активна;
- N - запись не активна.
- SAVE_STATISTIC - флаг необходимости сохранения статистики по посетителю попавшему в стоп-лист, воможные значения:
- Y - статистику сохранять;
- N - статистику не сохранять.
- IP_1* - октет 1 IP адреса;
- IP_1_EXACT_MATCH - если значение равно "N", то при фильтрации по IP_1 будет искаться вхождение;
- IP_2* - октет 2 IP адреса;
- IP_2_EXACT_MATCH - если значение равно "N", то при фильтрации по IP_2 будет искаться вхождение;
- IP_3* - октет 3 IP адреса;
- IP_3_EXACT_MATCH - если значение равно "N", то при фильтрации по IP_3 будет искаться вхождение;
- IP_4* - октет 4 IP адреса;
- IP_4_EXACT_MATCH - если значение равно "N", то при фильтрации по IP_4 будет искаться вхождение;
- URL_FROM* - ссылающаяся страница, с которой приходит посетитель;
- URL_FROM_EXACT_MATCH - если значение равно "Y", то при фильтрации по URL_FROM будет искаться точное совпадение;
- USER_AGENT* - UserAgent посетителя;
- USER_AGENT_EXACT_MATCH - если значение равно "Y", то при фильтрации по USER_AGENT будет искаться точное совпадение;
- MESSAGE* - текст сообщения которое будет выдано посетителю сайта, в случае его попадания под данную запись стоп-листа;
- MESSAGE_EXACT_MATCH - если значение равно "Y", то при фильтрации по MESSAGE будет искаться точное совпадение;
- COMMENTS* - административный комментарий, используется как правило для указания причин создания данной записи;
- COMMENTS_EXACT_MATCH - если значение равно "Y", то при фильтрации по COMMENTS будет искаться точное совпадение;
- URL_TO* - страница (или ее часть) на которую приходит посетитель;
- URL_TO_EXACT_MATCH - если значение равно "Y", то при фильтрации по URL_TO будет искаться точное совпадение;
- URL_REDIRECT* - страница на которую необходимо перенаправить посетителя после его попадания под данную запись стоп-листа;
- URL_REDIRECT_EXACT_MATCH - если значение равно "Y", то при фильтрации по URL_REDIRECT будет искаться точное совпадение;
- SITE_ID* - ID сайта для которого запись будет действительна; если значение не задано, то это означает что запись действительная для всех сайтов;
- SITE_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SITE_ID будет искаться вхождение.
* - допускается сложная логика |
| is_filtered | Флаг отфильтрованности результирующего списка. Если значение равно "true", то список был отфильтрован. |
Структура возвращаемой записи
Array
(
[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" - запись не активная по каким либо причинам (возможно истек срок действия, либо снят флаг активности)
)
Примеры использования
<?
// выберем записи стоп-листа с IP адресами 192.168.0.xxx
$arFilter = array(
"IP_1" => 192,
"IP_2" => 168,
"IP_3" => 0
);
// получим список записей
$rs = CStopList::GetList(
($by = "s_id"),
($order = "desc"),
$arFilter,
$is_filtered
);
// выведем все записи
while ($ar = $rs->Fetch())
{
echo "<pre>"; print_r($ar); echo "</pre>";
}
?>