Bitrix API

DataProviderManager

Table of Contents

Constants

MAX_DEPTH_LEVEL_ROOT_PROVIDERS  = 2

Methods

__construct()  : mixed
checkDataProviderAccess()  : bool
checkProviderName()  : bool
Returns true if $providerClassName is a valid DataProvider.
createDataProvider()  : DataProvider|null
Try to create new DataProvider instance from $fieldDescription on $value.
getContext()  : Context
getCulture()  : Culture
getDataProvider()  : DataProvider|null
Creates new DataProvider on $value with $options.
getDataProviderRegionPhrases()  : void
getDataProviderValue()  : DataProvider|false|mixed
Resolve and executes callback from VALUE in field with $placeholder
getDefaultTemplateFields()  : array<string|int, mixed>
getInstance()  : DataProviderManager
getLangPhraseValue()  : null|string
getList()  : array<string|int, mixed>
Get list of available DataProviders, filtered by $params
getProviderField()  : bool|array<string|int, mixed>
getProviderFields()  : array<string|int, mixed>
Returns single-level array with all fields of a $parentDataProvider.
getProviderPlaceholders()  : array<string|int, mixed>
Returns all possible placeholders for DataProvider.
getRegion()  : string
getRegionLanguageId()  : string
getRegionPhrases()  : array<string|int, mixed>
getValueFromList()  : mixed
isProviderArray()  : bool
Returns true if provider accepts array as main $value.
prepareValue()  : Value|mixed
resetContext()  : self
Resets global context to its previous value (before the last self::setContext call)
setContext()  : DataProviderManager
setRegion()  : $this
setSubstitutionProviders()  : DataProviderManager
valueToPlaceholder()  : string
Form a valid placeholder for $value.

Constants

Methods

checkProviderName()

Returns true if $providerClassName is a valid DataProvider.

public static checkProviderName(string $providerClassName[, string $moduleId = null ]) : bool

Module with this class should be included before this check.

Parameters
$providerClassName : string
$moduleId : string = null
Return values
bool

createDataProvider()

Try to create new DataProvider instance from $fieldDescription on $value.

public createDataProvider(array<string|int, mixed> $fieldDescription[, mixed $value = null ][, DataProvider|null $parentDataProvider = null ][, string $placeholder = null ]) : DataProvider|null
Parameters
$fieldDescription : array<string|int, mixed>
$value : mixed = null
$parentDataProvider : DataProvider|null = null
$placeholder : string = null
Return values
DataProvider|null

getDataProvider()

Creates new DataProvider on $value with $options.

public getDataProvider(string $providerClassName, mixed $value[, array<string|int, mixed> $options = [] ][, DataProvider $parentDataProvider = null ]) : DataProvider|null

If DataProvider with the same $value, $options and class exists in cache - returns it.

Parameters
$providerClassName : string
$value : mixed
$options : array<string|int, mixed> = []
$parentDataProvider : DataProvider = null
Return values
DataProvider|null

getDataProviderRegionPhrases()

public getDataProviderRegionPhrases(string $providerClassName, mixed $region[, array<string|int, mixed> &$loadedProviders = [] ][, array<string|int, mixed> $field = [] ]) : void
Parameters
$providerClassName : string
$region : mixed
$loadedProviders : array<string|int, mixed> = []
$field : array<string|int, mixed> = []

getDefaultTemplateFields()

public getDefaultTemplateFields(mixed $providerClassName[, array<string|int, mixed> $placeholders = [] ][, array<string|int, mixed> $mainProviderOptions = [] ][, bool $isAddRootGroups = true ][, bool $isCopyFields = false ]) : array<string|int, mixed>
Parameters
$providerClassName : mixed
$placeholders : array<string|int, mixed> = []
$mainProviderOptions : array<string|int, mixed> = []
$isAddRootGroups : bool = true
$isCopyFields : bool = false
Return values
array<string|int, mixed>

getList()

Get list of available DataProviders, filtered by $params

public getList([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getProviderField()

public getProviderField(DataProvider $dataProvider, string $placeholder) : bool|array<string|int, mixed>
Parameters
$dataProvider : DataProvider
$placeholder : string
Return values
bool|array<string|int, mixed>

getProviderFields()

Returns single-level array with all fields of a $parentDataProvider.

public getProviderFields(DataProvider $parentDataProvider[, array<string|int, mixed>|bool $placeholders = [] ][, bool $isCopyFields = false ][, array<string|int, mixed> $chain = [] ][, array<string|int, mixed> $group = [] ][, bool $isArray = false ][, array<string|int, mixed> $providers = [] ][, bool $stopRecursion = false ]) : array<string|int, mixed>

Key - path from field names like PROVIDER.PROVIDER.FIELD Value - field description (VALUE, TITLE, TYPE)

Parameters
$parentDataProvider : DataProvider
$placeholders : array<string|int, mixed>|bool = []
$isCopyFields : bool = false
$chain : array<string|int, mixed> = []
$group : array<string|int, mixed> = []
$isArray : bool = false
$providers : array<string|int, mixed> = []
$stopRecursion : bool = false
Return values
array<string|int, mixed>

getProviderPlaceholders()

Returns all possible placeholders for DataProvider.

public getProviderPlaceholders(string $providerClassName[, array<string|int, mixed> $placeholders = [] ][, array<string|int, mixed> $options = [] ][, bool $isCopyFields = false ]) : array<string|int, mixed>
Parameters
$providerClassName : string
$placeholders : array<string|int, mixed> = []
$options : array<string|int, mixed> = []
$isCopyFields : bool = false
Return values
array<string|int, mixed>

getRegionPhrases()

public getRegionPhrases(mixed $region) : array<string|int, mixed>
Parameters
$region : mixed
Return values
array<string|int, mixed>

getValueFromList()

public getValueFromList(array<string|int, mixed>|mixed $values[, bool $firstAsDefault = false ]) : mixed
Parameters
$values : array<string|int, mixed>|mixed
$firstAsDefault : bool = false

isProviderArray()

Returns true if provider accepts array as main $value.

public isProviderArray(mixed $providerClassName) : bool
Parameters
$providerClassName : mixed
Return values
bool

prepareValue()

public prepareValue(mixed $value[, array<string|int, mixed> $fieldDescription = [] ]) : Value|mixed
Parameters
$value : mixed
$fieldDescription : array<string|int, mixed> = []
Return values
Value|mixed

resetContext()

Resets global context to its previous value (before the last self::setContext call)

public final resetContext() : self
Return values
self

setRegion()

public setRegion(mixed $region) : $this
Parameters
$region : mixed
Return values
$this

valueToPlaceholder()

Form a valid placeholder for $value.

public valueToPlaceholder(string $value) : string

For example DATA_PROVIDER.FIELD => DataProviderField

Parameters
$value : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results