Класс CAdminFilter

Открытые члены
	__construct ($id, $popup=false, $arExtraParams=array())
	SetDefaultRows ($rows)
	AddPreset ($arFields)
	Begin ()
	Buttons ($aParams=false)
	End ()

Открытые статические члены
static	SetDefaultRowsOption ($filterId, $rows)
static	AddPresetToBase ($arFields)
static	Add ($arFields)
static	Delete ($ID)
static	Update ($ID, $arFields)
static	GetList ($aSort=array(), $arFilter=Array(), $getCommon=true)
static	UnEscape ()

Поля данных
	$id
const	SESS_PARAMS_NAME = "main.adminFilter"

Подробное описание

См. определение в файле admin_filter.php строка 12

Конструктор(ы)

__construct()

__construct	(		$id,
			$popup = false,
			$arExtraParams = array() )

См. определение в файле admin_filter.php строка 25

Методы

Add()

Add ( $arFields )

static

См. определение в файле admin_filter.php строка 374

AddPreset()

AddPreset

(

$arFields

)

Sets new filter tab with collection of fields and values This function must be called on admin page with the filter initialization. For example: $oFilter->AddPreset(array( "ID" => "preset1", "NAME" => "Test filter", "SORT" => 100, "SORT_FIELD" => array ("name" => "asc"), "FIELDS" => array( "find_name"=>"Smith", "find_id"=>"15" ) ));

Аргументы

array

$arFields

= array( "ID" => filter id, "NAME" => filter name, "SORT" = > filter sorting order. Default value - 100, for presets - 50; "SORT_FIELD" => array("Table column name" => "sort order"), "FIELDS" => array( "field1_name" => "field1_value", "field2_name" => "field2_value", ... ) )

Возвращает

bool

См. определение в файле admin_filter.php строка 291

AddPresetToBase()

AddPresetToBase ( $arFields )

static

См. определение в файле admin_filter.php строка 354

Begin()

Begin

(

)

См. определение в файле admin_filter.php строка 564

Buttons()

Buttons

(

$aParams = false

)

Аргументы

bool | array

$aParams

См. определение в файле admin_filter.php строка 599

Delete()

Delete ( $ID )

static

См. определение в файле admin_filter.php строка 395

End()

End

(

)

См. определение в файле admin_filter.php строка 650

GetList()

GetList ( $aSort = array(), $arFilter = Array(), $getCommon = true )

static

См. определение в файле admin_filter.php строка 439

SetDefaultRows()

SetDefaultRows

(

$rows

)

Sets default rows, witch will be shown to user when he comes to page for the first time/ This function must be called on admin page with the filter initialization. For example: $oFilter->SetDefaultRows("find_created, find_menu_id");

Аргументы

str	rows - rows identificators separated by commas ("rowid_1, rowid_2, ...")

Возвращает

bool

См. определение в файле admin_filter.php строка 230

SetDefaultRowsOption()

SetDefaultRowsOption ( $filterId, $rows )

static

См. определение в файле admin_filter.php строка 248

UnEscape()

UnEscape ( )

static

См. определение в файле admin_filter.php строка 852

Update()

Update ( $ID, $arFields )

static

См. определение в файле admin_filter.php строка 402

Поля

$id

$id

См. определение в файле admin_filter.php строка 14

SESS_PARAMS_NAME

const SESS_PARAMS_NAME = "main.adminFilter"

См. определение в файле admin_filter.php строка 23

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/main/interface/admin_filter.php