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

GetList

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

record set
CAdvType::GetList(

 varchar &by,
 varchar &order,
 array arFilter=array(),
 boolean &is_filtered,
 char(1) CHECK_RIGHTS="Y"
);

Метод предназначен для получения списка типов баннеров. Метод нестатический.

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

Параметры Описание С версии
by Идентификатор, позволяющий задать имя поля для сортировки. Допустимы следующие значения:
  • s_sid - по символьному ID типа
  • s_date_modify - по дате модификации
  • s_modified_by - по ID пользователя, изменившего тип
  • s_date_create - по дате создания
  • s_created_by - по ID пользователя, создавшего тип
  • s_active - по флагу активности
  • s_name - по имени
  • s_banners - по количеству баннеров данного типа
  • s_description - по описанию
order Порядок сортировки. Допустимы следующие значения:
  • desc - по убыванию (значение по умолчанию)
  • asc - по возрастанию
arFilter Массив для фильтрации значений. Необязательный параметр. В массиве допустимы следующие индексы:
  • SID - символьный ID типа (допускается сложная логика)
  • SID_EXACT_MATCH - "Y" - при фильтрации по символьному ID типа будет искаться точное совпадение (по умолчанию); "N" - в противном случае будет искаться вхождение
  • DATE_MODIFY_1 - левая часть интервала для даты модификации типа
  • DATE_MODIFY_2 - правая часть интервала для даты модификации типа
  • ACTIVE - флаг активности типа ("Y" - активен; "N" - не активен)
  • NAME - имя типа (допускается сложная логика)
  • NAME_EXACT_MATCH - "Y" - при фильтрации по имени типа будет искаться точное совпадение; "N" - в противном случае будет искаться вхождение (по умолчанию)
  • DESCRIPTION - описание типа (допускается сложная логика)
  • DESCRIPTION_EXACT_MATCH - "Y" - при фильтрации по описанию типа будет искаться точное совпадение; "N" - в противном случае будет искаться вхождение (по умолчанию)
is_filtered Переменная, возвращающая true в том случае, если список типов отфильтрован по какому либо критерию; либо false в противном случае.
CHECK_RIGHTS Параметр проверяет уровень доступа к модулю Реклама (администратор рекламы, рекламодатель и т.д.) Если параметр определён как "N", то считается, что текущий пользователь обладает административными правами доступа к модулю Реклама. Если параметр пропущен либо равен "Y", то метод проверяет уровень доступа к контракту, которому принадлежит баннер. Необязательный параметр. 3.3.14

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

<?
$FilterArr = Array(
	"find_sid",
	"find_sid_exact_match",
	"find_date_modify_1", 
	"find_date_modify_2", 
	"find_active", 
	"find_name",
	"find_name_exact_match",
	"find_description", 
	"find_description_exact_match"
	);
if (strlen($set_filter)>0) InitFilterEx($FilterArr,"ADV_TYPE_LIST","set"); 
else InitFilterEx($FilterArr,"ADV_TYPE_LIST","get");
if (strlen($del_filter)>0) DelFilterEx($FilterArr,"ADV_TYPE_LIST");
InitBVar($find_sid_exact_match);
InitBVar($find_name_exact_match);
InitBVar($find_description_exact_match);
$arFilter = Array(
	"SID"					   => $find_sid,
	"SID_EXACT_MATCH"		   => $find_sid_exact_match,
	"DATE_MODIFY_1"			 => $find_date_modify_1, 
	"DATE_MODIFY_2"			 => $find_date_modify_2, 
	"ACTIVE"					=> $find_active, 
	"NAME"					  => $find_name,
	"NAME_EXACT_MATCH"		  => $find_name_exact_match,
	"DESCRIPTION"			   => $find_description,
	"DESCRIPTION_EXACT_MATCH"   => $find_description_exact_match,
	);
$rsAdvType = CAdvType::GetList($by, $order, $arFilter, $is_filtered, "Y");
?>

Пример массива, получаемого после Fetch одной строки выборки данного метода

<?
Array
(
	[SID] => TOP
	[ACTIVE] => Y
	[SORT] => 10
	[NAME] => Top banner
	[DESCRIPTION] => описание типа
	[DATE_CREATE] => 03.06.2004 17:27:00
	[DATE_MODIFY] => 03.06.2004 17:27:00
	[CREATED_BY] => 2
	[MODIFIED_BY] => 2
	[BANNER_COUNT] => 63
)
?>


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

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

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

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

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