Класс DataProvider

Граф наследования:DataProvider:

Открытые члены
	getSettings ()
	getID ()
	prepareFields ()
	prepareFieldData ($fieldID)
	prepareFieldHtml (Field $field)
	prepareListFilterParam (array &$filter, $fieldID)
	prepareFilterValue (array $rawFilterValue)

Защищенные члены
	createField ($fieldID, array $params=null)

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

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

Методы

createField()

createField ( $fieldID, array $params = null )

protected

Create filter field.

Аргументы

string	$fieldID	Field ID.
array | null	$params	Field parameters (optional).

Возвращает

Field

Переопределяется в EntityDataProvider и EntityUFDataProvider.

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

getID()

getID

(

)

Get ID.

Возвращает

string

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

getSettings()

getSettings ( )

abstract

Get Settings

Возвращает

Settings

Переопределяется в AgentContractDataProvider, ContractorDataProvider, DocumentDataProvider, StoreDataProvider, ElementDataProvider, PropertyFilterProvider, EntityUFDataProvider, TabletDataProvider, UserDataProvider, UserToGroupDataProvider и WorkgroupDataProvider.

prepareFieldData()

prepareFieldData ( $fieldID )

abstract

Prepare complete field data for specified field.

Аргументы

string

$fieldID

Field ID.

Возвращает

array|null

Переопределяется в AgentContractDataProvider, ContractorDataProvider, DocumentDataProvider, ProductDataProvider, StoreDataProvider, ElementDataProvider, PropertyFilterProvider, EntityUFDataProvider, TabletDataProvider, UserDataProvider, UserToGroupDataProvider и WorkgroupDataProvider.

prepareFieldHtml()

prepareFieldHtml

(

Field

$field

)

Prepare Field additional HTML.

Аргументы

Field

$field

Field.

Возвращает

string

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

prepareFields()

prepareFields ( )

abstract

Prepare field list.

Возвращает

Field[]

Переопределяется в AgentContractDataProvider, ContractorDataProvider, DocumentDataProvider, ProductDataProvider, StoreDataProvider, ElementDataProvider, PropertyFilterProvider, EntityUFDataProvider, TabletDataProvider, UserDataProvider, UserToGroupDataProvider и WorkgroupDataProvider.

prepareFilterValue()

prepareFilterValue

(

array

$rawFilterValue

)

Prepare ui filter value to be suitable for corresponding entity getList

Аргументы

array

$rawFilterValue

Возвращает

array

Переопределяется в ProductDataProvider, ElementDataProvider и PropertyFilterProvider.

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

prepareListFilterParam()

prepareListFilterParam	(	array &	$filter,
			$fieldID )

Prepare field parameter for specified field.

Аргументы

array	$filter	Filter params.
string	$fieldID	Field ID.

Возвращает

void

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

---

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

• C:/bitrix/modules/main/lib/filter/dataprovider.php