Bitrix API

ArrayDataProvider extends DataProvider implements Iterator, Countable

Table of Contents

Interfaces

Iterator
Countable

Constants

FIELD_TYPE_DATE  = 'DATE'
FIELD_TYPE_IMAGE  = 'IMAGE'
FIELD_TYPE_NAME  = 'NAME'
FIELD_TYPE_PHONE  = 'PHONE'
FIELD_TYPE_STAMP  = 'STAMP'
FIELD_TYPE_TEXT  = 'TEXT'
INDEX_PLACEHOLDER  = 'INDEX'
NUMBER_PLACEHOLDER  = 'NUMBER'

Methods

__construct()  : mixed
addItem()  : int
count()  : int
current()  : mixed
deleteItemByIndex()  : ArrayDataProvider
getAdditionalDocumentInfo()  : array<string|int, mixed>
getFields()  : array<string|int, mixed>
getItemByIndex()  : mixed
getItemKey()  : string
getLangPhrasesPath()  : string|null
Returns path to the directory where files with language phrases are placed
getOptions()  : array<string|int, mixed>
getParentProvider()  : DataProvider
getSource()  : mixed
getValue()  : mixed
Returns value by its name.
hasAccess()  : bool
isLoaded()  : bool
isPrintable()  : Result
isRootProvider()  : bool
key()  : string|int|null
next()  : void
replaceItem()  : ArrayDataProvider
rewind()  : void
setParentProvider()  : $this
valid()  : bool

Constants

FIELD_TYPE_PHONE

public mixed FIELD_TYPE_PHONE = 'PHONE'

FIELD_TYPE_STAMP

public mixed FIELD_TYPE_STAMP = 'STAMP'

Methods

__construct()

public __construct(array<string|int, mixed> $source[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$source : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
ArgumentTypeException

addItem()

public addItem(mixed $item) : int
Parameters
$item : mixed
Return values
int

getAdditionalDocumentInfo()

public getAdditionalDocumentInfo(Document $document) : array<string|int, mixed>
Parameters
$document : Document
Return values
array<string|int, mixed>

getFields()

public getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getItemByIndex()

public getItemByIndex(int $index) : mixed
Parameters
$index : int

getLangPhrasesPath()

Returns path to the directory where files with language phrases are placed

public getLangPhrasesPath() : string|null
Return values
string|null

getOptions()

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getValue()

Returns value by its name.

public getValue(string $name) : mixed
Parameters
$name : string

hasAccess()

public hasAccess(mixed $userId) : bool
Parameters
$userId : mixed
Return values
bool

isRootProvider()

public isRootProvider() : bool
Return values
bool

setParentProvider()

public setParentProvider(mixed $parentProvider) : $this
Parameters
$parentProvider : mixed
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results