Класс Structure

Открытые члены
	__construct ($context)
	getFolder ()
	saveContent ($type, $code, $content)
	getConfigurationFileList ()
	saveFile ($id, $additionalData=[])
	getFileList ()
	unpack ($fileInfo)
	unpackSmallFiles ($content)
	addFileList (array $filesInfo, array $files)
	setUnpackFilesFromDisk ($folderId, $storageParams)
	getUnpackFile ($id)
	addSmallFile ($info, $content)
	listSmallFile ()
	setArchiveName ($name)
	getArchiveName ()

Открытые статические члены
static	clearContentAgent ()

Открытые атрибуты
const	CODE_CONFIGURATION_FILES_LIST = 'CONFIGURATION_FILES_LIST'
const	CODE_FILES_LIST = 'FILES_LIST'
const	CODE_FILES_SMALL_LIST = 'FILES_SMALL_LIST'
const	CODE_UNPACK_FILE_PREFIX = 'UNPACK_FILE_'
const	CODE_CUSTOM_FILE = 'CUSTOM_FILE_'

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

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

Конструктор(ы)

__construct()

__construct

(

$context

)

Аргументы

$context

string

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

Методы

addFileList()

addFileList	(	array	$filesInfo,
		array	$files )

Adds files list to current context

Аргументы

array	$filesInfo
array	$files

Возвращает

bool

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

addSmallFile()

addSmallFile	(		$info,
			$content )

Saves smalls files on import.

Аргументы

$info
$content

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

clearContentAgent()

static clearContentAgent ( )

static

Agent delete old temp export files

Возвращает

string

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

getArchiveName()

getArchiveName

(

)

Return export name archive

Возвращает

string

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

getConfigurationFileList()

getConfigurationFileList

(

)

All files in current context

Возвращает

array|null

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

getFileList()

getFileList

(

)

All files in current context

Возвращает

array|null

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

getFolder()

getFolder

(

)

Create and/or return absolute path to temp folder

Возвращает

string|boolean

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

getUnpackFile()

getUnpackFile

(

$id

)

Get file from Disk work folder with external files

Аргументы

$id

Возвращает

bool|mixed

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

listSmallFile()

listSmallFile

(

)

Возвращает

array|mixed|null

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

saveContent()

saveContent	(		$type,
			$code,
			$content )

Save content to temp folder

Аргументы

$type	string
$code	string
$content	array|string

Возвращает

boolean

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

saveFile()

saveFile	(		$id,
			$additionalData = [] )

Аргументы

$id	integer file id from b_file
$additionalData	array any short data save with file

Возвращает

boolean

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

setArchiveName()

setArchiveName

(

$name

)

Set export archive name

Аргументы

$name

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

Возвращает

bool result of set new name

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

setUnpackFilesFromDisk()

setUnpackFilesFromDisk	(		$folderId,
			$storageParams )

Set Disk work folder with external files

Аргументы

$folderId
$storageParams

Возвращает

bool

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

unpack()

unpack

(

$fileInfo

)

Unzip the archive to a temporary folder

Аргументы

$fileInfo

array === $_FILES

Возвращает

boolean

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

unpackSmallFiles()

unpackSmallFiles

(

$content

)

Аргументы

$content

Возвращает

bool

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

Данные класса

CODE_CONFIGURATION_FILES_LIST

const CODE_CONFIGURATION_FILES_LIST = 'CONFIGURATION_FILES_LIST'

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

CODE_CUSTOM_FILE

const CODE_CUSTOM_FILE = 'CUSTOM_FILE_'

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

CODE_FILES_LIST

const CODE_FILES_LIST = 'FILES_LIST'

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

CODE_FILES_SMALL_LIST

const CODE_FILES_SMALL_LIST = 'FILES_SMALL_LIST'

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

CODE_UNPACK_FILE_PREFIX

const CODE_UNPACK_FILE_PREFIX = 'UNPACK_FILE_'

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