Bitrix API

Structure

Table of Contents

Constants

CODE_CONFIGURATION_FILES_LIST  = 'CONFIGURATION_FILES_LIST'
CODE_CUSTOM_FILE  = 'CUSTOM_FILE_'
CODE_FILES_LIST  = 'FILES_LIST'
CODE_FILES_SMALL_LIST  = 'FILES_SMALL_LIST'
CODE_UNPACK_FILE_PREFIX  = 'UNPACK_FILE_'

Methods

__construct()  : mixed
addFileList()  : bool
Adds files list to current context
addSmallFile()  : mixed
Saves smalls files on import.
clearContentAgent()  : string
Agent delete old temp export files
getArchiveName()  : string
Return export name archive
getConfigurationFileList()  : array<string|int, mixed>|null
All files in current context
getFileList()  : array<string|int, mixed>|null
All files in current context
getFolder()  : string|bool
Create and/or return absolute path to temp folder
getUnpackFile()  : bool|mixed
Get file from Disk work folder with external files
listSmallFile()  : array<string|int, mixed>|mixed|null
saveContent()  : bool
Save content to temp folder
saveFile()  : bool
setArchiveName()  : bool
Set export archive name
setUnpackFilesFromDisk()  : bool
Set Disk work folder with external files
unpack()  : bool
Unzip the archive to a temporary folder
unpackSmallFiles()  : bool

Constants

CODE_CONFIGURATION_FILES_LIST

public mixed CODE_CONFIGURATION_FILES_LIST = 'CONFIGURATION_FILES_LIST'

CODE_CUSTOM_FILE

public mixed CODE_CUSTOM_FILE = 'CUSTOM_FILE_'

CODE_FILES_LIST

public mixed CODE_FILES_LIST = 'FILES_LIST'

CODE_FILES_SMALL_LIST

public mixed CODE_FILES_SMALL_LIST = 'FILES_SMALL_LIST'

CODE_UNPACK_FILE_PREFIX

public mixed CODE_UNPACK_FILE_PREFIX = 'UNPACK_FILE_'

Methods

__construct()

public __construct(mixed $context) : mixed
Parameters
$context : mixed

string

addFileList()

Adds files list to current context

public addFileList(array<string|int, mixed> $filesInfo, array<string|int, mixed> $files) : bool
Parameters
$filesInfo : array<string|int, mixed>
$files : array<string|int, mixed>
Return values
bool

addSmallFile()

Saves smalls files on import.

public addSmallFile(mixed $info, mixed $content) : mixed
Parameters
$info : mixed
$content : mixed

clearContentAgent()

Agent delete old temp export files

public static clearContentAgent() : string
Return values
string

getArchiveName()

Return export name archive

public getArchiveName() : string
Return values
string

getConfigurationFileList()

All files in current context

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

getFileList()

All files in current context

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

getFolder()

Create and/or return absolute path to temp folder

public getFolder() : string|bool
Return values
string|bool

getUnpackFile()

Get file from Disk work folder with external files

public getUnpackFile(mixed $id) : bool|mixed
Parameters
$id : mixed
Return values
bool|mixed

listSmallFile()

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

saveContent()

Save content to temp folder

public saveContent(mixed $type, mixed $code, mixed $content) : bool
Parameters
$type : mixed

string

$code : mixed

string

$content : mixed

array|string

Return values
bool

saveFile()

public saveFile(mixed $id[, mixed $additionalData = [] ]) : bool
Parameters
$id : mixed

integer file id from b_file

$additionalData : mixed = []

array any short data save with file

Return values
bool

setArchiveName()

Set export archive name

public setArchiveName(mixed $name) : bool
Parameters
$name : mixed

string [a-zA-Z0-9_] new name archive

Return values
bool —

result of set new name

setUnpackFilesFromDisk()

Set Disk work folder with external files

public setUnpackFilesFromDisk(mixed $folderId, mixed $storageParams) : bool
Parameters
$folderId : mixed
$storageParams : mixed
Return values
bool

unpack()

Unzip the archive to a temporary folder

public unpack(mixed $fileInfo) : bool
Parameters
$fileInfo : mixed

array === $_FILES

Return values
bool

unpackSmallFiles()

public unpackSmallFiles(mixed $content) : bool
Parameters
$content : mixed
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results