Bitrix API

Base extends ProviderBase

Class Base

Table of Contents

Constants

ERROR_DATA_NOT_FOUND  = 'ERROR_DATA_NOT_FOUND'
ERROR_DECODE_DATA  = 'ERROR_DECODE_DATA'

Methods

__construct()  : mixed
ProviderBase constructor.
addContent()  : bool
Adds content as file to configuration folder.
addFiles()  : array<string|int, mixed>
Adds files to configurations files folder.
deleteFolder()  : bool
Deletes folder by context
get()  : array<string|int, mixed>|null
Returns files content.
getContent()  : array<string|int, mixed>
Returns structured content for working
getFolder()  : mixed
Returns current folder.
getStorage()  : mixed
Returns using storage
listError()  : array<string|int, mixed>
Returns error list.
resetErrors()  : bool
Resets errors.
setFolderFilter()  : mixed
Sets filter for current folder.

Constants

ERROR_DATA_NOT_FOUND

public mixed ERROR_DATA_NOT_FOUND = 'ERROR_DATA_NOT_FOUND'

ERROR_DECODE_DATA

public mixed ERROR_DECODE_DATA = 'ERROR_DECODE_DATA'

Methods

__construct()

ProviderBase constructor.

public __construct(array<string|int, mixed> $setting) : mixed
Parameters
$setting : array<string|int, mixed>
Tags
throws
LoaderException
throws
SystemException

addContent()

Adds content as file to configuration folder.

public addContent(mixed $code, mixed $content[, mixed $type = false ]) : bool
Parameters
$code : mixed

string name of file

$content : mixed

string|array saving configuration data

$type : mixed = false

mixed type of configuration data

Return values
bool

addFiles()

Adds files to configurations files folder.

public addFiles(array<string|int, mixed> $files) : array<string|int, mixed>
Parameters
$files : array<string|int, mixed>

array files list

Return values
array<string|int, mixed>

deleteFolder()

Deletes folder by context

public deleteFolder() : bool
Return values
bool

get()

Returns files content.

public get(string $path, int $step) : array<string|int, mixed>|null
Parameters
$path : string
$step : int
Return values
array<string|int, mixed>|null

getContent()

Returns structured content for working

public getContent(mixed $path, int $step) : array<string|int, mixed>
Parameters
$path : mixed
$step : int
Return values
array<string|int, mixed>

getFolder()

Returns current folder.

public getFolder([bool $autoCreate = false ]) : mixed
Parameters
$autoCreate : bool = false

getStorage()

Returns using storage

public getStorage() : mixed

listError()

Returns error list.

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

resetErrors()

Resets errors.

public resetErrors() : bool
Return values
bool

setFolderFilter()

Sets filter for current folder.

public setFolderFilter(array<string|int, mixed> $filter) : mixed
Parameters
$filter : array<string|int, mixed>

        
On this page

Search results