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

GetList

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

record set
CAdvBanner::GetList(
 varchar &by,
 varchar &order,
 array arFilter=array(),
 boolean &is_filtered,
 char(1) CHECK_RIGHTS="Y"
);

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

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

ПараметрыОписание
byИдентификатор, позволяющий задать имя поля для сортировки. Допустимы следующие значения:
  • s_id - по ID
  • s_lamp - по индикатору
  • s_name - по имени баннера
  • s_type_sid - по типу баннера
  • s_contract_id - по ID контракта
  • s_group_sid - по имени группы
  • s_show_count - по количеству показов
  • s_max_show_count - по максимальному количеству показов
  • s_date_last_show - по дате последнего показа
  • s_click_count - по количеству кликов на баннер
  • s_max_click_count - по максимальному количеству кликов
  • s_date_last_click - по дате последнего клика
  • s_active - по флагу активности
  • s_weight - по весу баннера
  • s_status_sid - по статусу баннера
  • s_date_show_from - по дате начала показов
  • s_date_show_to - по дате окончания показов
  • s_ctr - по CTR баннера
orderПорядок сортировки. Допустимы следующие значения:
  • desc - по убыванию (значение по умолчанию)
  • asc - по возрастанию
arFilterМассив для фильтрации значений. Необязательный параметр. В массиве допустимы следующие индексы:
  • * ID - ID баннера
  • ID_EXACT_MATCH - "Y" - при фильтрации по ID баннера будет искаться точное совпадение (по умолчанию); "N" - в противном случае будет искаться вхождение
  • ACTIVE - активность, значения Y/N
  • LAMP - значение индикатора: "red", "green"
  • LANG - двухсимвольный идентификатор языковой части сайта в которой будет показываться баннер
  • SHOW_COUNT_1 - левая часть интервала для числа показов
  • SHOW_COUNT_2 - правая часть интервала для числа показов
  • CLICK_COUNT_1 - левая часть интервала для числа кликов
  • CLICK_COUNT_2 - правая часть интервала для числа кликов
  • CTR_1 - левая часть интервала для CTR баннера
  • CTR_2 - правая часть интервала для CTR баннера
  • * GROUP - имя группы баннера
  • GROUP_EXACT_MATCH - "Y" - при фильтрации по имени группы будет искаться точное совпадение; "N" - в противном случае будет искаться вхождение (по умолчанию)
  • * STATUS_SID - символьный код статуса; символьный код статуса может принимать следующие значения:
    • PUBLISHED - баннер подтвержден и опубликован
    • READY - баннер на рассмотрении
    • REJECTED - баннер отклонен
  • * CONTRACT_ID - ID контракта
  • CONTRACT_ID_EXACT_MATCH - "Y" - при фильтрации по ID контракта будет искаться точное совпадение (по умолчанию); "N" - в противном случае будет искаться вхождение
  • * CONTRACT - ID, имя, описание контракта
  • CONTRACT_EXACT_MATCH - "Y" - при фильтрации по ID, имени, описанию контракта будет искаться точное совпадение; "N" - в противном случае будет искаться вхождение (по умолчанию)
  • * TYPE_SID - символьный код типа баннера
  • TYPE_SID_EXACT_MATCH - "Y" - при фильтрации по символьному коду типа баннера будет искаться точное совпадение (по умолчанию); "N" - в противном случае будет искаться вхождение
  • * NAME - имя баннера
  • NAME_EXACT_MATCH - "Y" - при фильтрации по имени баннера будет искаться точное совпадение; "N" - в противном случае будет искаться вхождение (по умолчанию)
  • * CODE - код баннера
  • CODE_EXACT_MATCH - "Y" - при фильтрации по коду баннера будет искаться точное совпадение; "N" - в противном случае будет искаться вхождение (по умолчанию)
  • * COMMENTS - комментарий к баннеру
  • COMMENTS_EXACT_MATCH - "Y" - при фильтрации по комментарию к баннеру будет искаться точное совпадение; "N" - в противном случае будет искаться вхождение (по умолчанию)
  • SITE - для фильтрации по сайтам.
is_filteredПеременная, возвращающая true в том случае, если список баннеров отфильтрован по какому-либо критерию; либо false в противном случае.
CHECK_RIGHTSПараметр проверяет уровень доступа к модулю Реклама (администратор рекламы, рекламодатель и т.д.). Если параметр определён как "N", то считается, что текущий пользователь обладает административными правами доступа к модулю Реклама. Если параметр пропущен либо равен "Y", то функция проверяет уровень доступа к модулю. Необязательный параметр.

* - допускается сложная логика и использование логических операторов Облегчайте поиск информации вместе с логическими операторами. Система допускает использование пяти видов логических операторов. Давайте их рассмотрим.

Подробнее ... в курсе Администратор.Базовый.

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

<?
$FilterArr = Array(
	"find_id",
	"find_id_exact_match",
	"find_lamp",
	"find_lang",
	"find_show_count_1",
	"find_show_count_2",
	"find_click_count_1",
	"find_click_count_2",
	"find_ctr_1",
	"find_ctr_2",
	"find_contract_id",
	"find_contract",
	"find_contract_exact_match",
	"find_group",
	"find_group_exact_match",
	"find_status_sid",
	"find_type_sid",
	"find_type",
	"find_type_exact_match",
	"find_name",
	"find_name_exact_match",
	"find_code",
	"find_code_exact_match",
	"find_comments",
	"find_comments_exact_match"
	);
if (strlen($set_filter)>0) InitFilterEx($FilterArr,"ADV_BANNER_LIST","set"); 
else InitFilterEx($FilterArr,"ADV_BANNER_LIST","get");
if (strlen($del_filter)>0) DelFilterEx($FilterArr,"ADV_BANNER_LIST");
InitBVar($find_id_exact_match);
InitBVar($find_status_exact_match);
InitBVar($find_group_exact_match);
InitBVar($find_contract_exact_match);
InitBVar($find_type_exact_match);
InitBVar($find_name_exact_match);
InitBVar($find_code_exact_match);
InitBVar($find_comments_exact_match);
$arFilter = Array(
	"ID"					=> $find_id,
	"ID_EXACT_MATCH"		=> $find_id_exact_match,
	"LAMP"				  => $find_lamp,
	"LANG"				  => $find_lang,
	"SHOW_COUNT_1"		  => $find_show_count_1,
	"SHOW_COUNT_2"		  => $find_show_count_2,
	"CLICK_COUNT_1"		 => $find_click_count_1,
	"CLICK_COUNT_2"		 => $find_click_count_2,
	"CTR_1"				 => $find_ctr_1,
	"CTR_2"				 => $find_ctr_2,
	"GROUP"				 => $find_group,
	"GROUP_EXACT_MATCH"	 => $find_group_exact_match,
	"STATUS_SID"			=> $find_status_sid,
	"CONTRACT_ID"		   => $find_contract_id,
	"CONTRACT"			  => $find_contract,
	"CONTRACT_EXACT_MATCH"  => $find_contract_exact_match,
	"TYPE_SID"			  => $find_type_sid,
	"TYPE"				  => $find_type,
	"TYPE_EXACT_MATCH"	  => $find_type_exact_match,
	"NAME"				  => $find_name,
	"NAME_EXACT_MATCH"	  => $find_name_exact_match,
	"CODE"				  => $find_code,
	"CODE_EXACT_MATCH"	  => $find_code_exact_match,
	"COMMENTS"			  => $find_comments,
	"COMMENTS_EXACT_MATCH"  => $find_comments_exact_match
	);
$rsBanners = CAdvBanner::GetList($by, $order, $arFilter, $is_filtered, "N");
$rsBanners->NavStart(20);
$rsBanners->NavPrint("Баннеры");
while($arBanner = $rsBanners->NavNext(true, "f_"))
{
	echo "<pre>"; print_r($arBanner); echo "</pre>";
}
?>

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

<?
Array
(
	[LAMP] => green
	[ID] => 88
	[CONTRACT_ID] => 1
	[TYPE_SID] => TOP
	[GROUP_SID] => 
	[STATUS_SID] => PUBLISHED
	[STATUS_COMMENTS] =>
	[NAME] =>
	[ACTIVE] => Y
	[LID] => 
	[WEIGHT] => 100
	[MAX_SHOW_COUNT] => 300
	[MAX_CLICK_COUNT] => 100
	[SHOW_COUNT] => 102
	[CLICK_COUNT] => 4
	[IMAGE_ID] => 1032
	[IMAGE_ALT] =>
	[URL] => http://www.1c-bitrix.ru?banner_param=<code>#EVENT_GID#</code>
	[URL_TARGET] => _parent
	[CODE] => <TABLE class=smalltext cellSpacing=0 cellPadding=0 width=145>
<TR>
<TD></TD>
<TD>
<DIV align=center>
<A class=righthead href="/ru/partners/partnership.php">Партнёрская программа</A>
</DIV>
</TD></TR>
<TR>
<TD></TD>
<TD height=8></TD></TR>
<TR>
<TD width=5></TD>
<TD vAlign=bottom>
<DIV align=center>
<A href="/ru/partners/partnership.php">
<IMG height=95 src="/images/advert/free.gif" width=100 border=0></A>
</DIV></TD></TR>
<TR>
<TD></TD>
<TD height=5></TD></TR>
<TR>
<TD></TD>
<TD>Разработчики сайтов и интеграторы получают:<BR>
<B><FONT class=smalltext>
<IMG height=8 src="/images/list_bullet.gif" width=8>
</FONT></B> 
<FONT color=#ff5a31>скидки до 50%</FONT> <BR>
<B><FONT class=smalltext>
<IMG height=8 src="/images/list_bullet.gif" width=8>
</FONT></B> 
<FONT color=#ff5a31>бесплатную копиию</FONT>
</TD></TR>
<TR>
<TD></TD>
<TD height=5></TD></TR>
<TR>
<TD></TD>
<TD>
<DIV align=right>
<A class=bottomlinks href="/ru/partners/partnership.php">Подробнее</A>
<IMG height=7 src="/images/main_button_more_3.gif" width=7>
</DIV></TD></TR></TABLE>
	[CODE_TYPE] => html
	[STAT_EVENT_1] => 
	[STAT_EVENT_2] => 
	[STAT_EVENT_3] => 
	[FOR_NEW_GUEST] => 
	[COMMENTS] => 
	[CREATED_BY] => 2
	[MODIFIED_BY] => 2
	[CTR] => 3.92
	[DATE_LAST_SHOW] => 24.06.2004 17:39:50
	[DATE_LAST_CLICK] => 24.06.2004 14:47:53
	[DATE_SHOW_FROM] => 10.06.2004
	[DATE_SHOW_TO] => 07.07.2007
	[DATE_CREATE] => 10.06.2004 11:25:59
	[DATE_MODIFY] => 24.06.2004 14:33:56
	[CONTRACT_NAME] => Default
	[TYPE_NAME] => Top banner
)
?>


© «Битрикс», 2001-2022, «1С-Битрикс», 2022
Наверх