Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Export
+ Граф наследования:Export:

Открытые члены

 configureActions ()
 
 dispatcherAction ()
 
 downloadAction ()
 
 exportAction ()
 
 uploadAction ()
 
 clearAction ()
 
 cancelAction ()
 
 purgeAction ()
 
 finishAction ()
 
- Открытые члены унаследованные от Controller
 __construct (Request $request=null)
 
 forward ($controller, string $actionName, array $parameters=null)
 
 getConfigurationOfActions ()
 
 getModuleId ()
 
 isLocatedUnderPsr4 ()
 
 getActionUri (string $actionName, array $params=[], bool $absolute=false)
 
 getUnsignedParameters ()
 
 getCurrentUser ()
 
 setCurrentUser (CurrentUser $currentUser)
 
 convertKeysToCamelCase ($data)
 
 listNameActions ()
 
 getAutoWiredParameters ()
 
 getPrimaryAutoWiredParameter ()
 
 getDefaultAutoWiredParameters ()
 
 getRequest ()
 
 getScope ()
 
 setScope ($scope)
 
 getSourceParametersList ()
 
 setSourceParametersList ($sourceParametersList)
 
 run ($actionName, array $sourceParametersList)
 
 finalizeResponse (Response $response)
 
 generateActionMethodName ($action)
 
 redirectTo ($url)
 
 getErrors ()
 
 getErrorByCode ($code)
 

Открытые атрибуты

const EXPORT_PATH = '/export/'
 
const EXPIRE_DAYS = 24
 
const ACTION_EXPORT = 'export'
 
const ACTION_UPLOAD = 'upload'
 
const ACTION_CANCEL = 'cancel'
 
const ACTION_FINISH = 'finish'
 
const ACTION_DOWNLOAD = 'download'
 
const ACTION_CLEAR = 'clear'
 
const ACTION_VOID = 'void'
 
const ACTION_PURGE = 'purge'
 
const STATUS_COMPLETED = 'COMPLETED'
 
const STATUS_PROGRESS = 'PROGRESS'
 
const EXPORT_TYPE_CSV = 'csv'
 
const EXPORT_TYPE_EXCEL = 'excel'
 
const KEEP_FILE_HOURS = 24
 
const ROWS_PER_PAGE = 100
 
const TIME_LIMIT = 20
 
- Открытые атрибуты унаследованные от Controller
const SCOPE_REST = 'rest'
 
const SCOPE_AJAX = 'ajax'
 
const SCOPE_CLI = 'cli'
 
const EVENT_ON_BEFORE_ACTION = 'onBeforeAction'
 
const EVENT_ON_AFTER_ACTION = 'onAfterAction'
 
const ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'
 
const ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'
 
const EXCEPTION_UNKNOWN_ACTION = 22002
 
- Открытые атрибуты унаследованные от Controllerable
const METHOD_ACTION_SUFFIX = 'Action'
 

Защищенные члены

 init ()
 
 processBeforeAction (Main\Engine\Action $action)
 
 keepFieldInProcess ($fieldName)
 
 preformAnswer ($action)
 
 preformExpectedDuration ()
 
 generateDownloadLink ()
 
 generateCloudLink ()
 
 checkCommonErrors ($action)
 
 checkCloudErrors ()
 
 findInitBucket (array $attributes)
 
 instanceBucket ()
 
 getBucketList ($filter=[])
 
 saveProgressParameters ()
 
 getProgressParameters ()
 
 clearProgressParameters ()
 
 getProgressParameterOptionName ()
 
 generateExportFileName ()
 
 getFileType ()
 
 generateTempDirPath ()
 
 generateUploadDir ()
 
 getSignedParameters ($componentName, array $params)
 
 decodeSignedParameters ($componentName, $signedParameters)
 
 writeTempFile ($data, $precedeUtf8Bom=true)
 
 dropTempFile ()
 
 getContentTempFile ()
 
 getSizeTempFile ()
 
 startTimer ($timeLimit=25)
 
 hasTimeLimitReached ()
 
- Защищенные члены унаследованные от Controller
 getFilePath ()
 
 processUnsignedParameters ()
 
 getSaltToUnsign ()
 
 writeToLogException (\Throwable $e)
 
 collectDebugInfo ()
 
 logDebugInfo ()
 
 prepareParams ()
 
 processBeforeAction (Action $action)
 
 shouldDecodePostData (Action $action)
 
 decodePostData ()
 
 triggerOnBeforeAction (Action $action)
 
 processAfterAction (Action $action, $result)
 
 triggerOnAfterAction (Action $action, $result)
 
 create ($actionName)
 
 buildActionInstance ($actionName, array $config)
 
 existsAction ($actionName)
 
 getDefaultPreFilters ()
 
 getDefaultPostFilters ()
 
 buildFilters (array $config=null)
 
 appendFilters (array $filters, array $filtersToAppend)
 
 removeFilters (array $filters, array $filtersToRemove)
 
 detachFilters (Action $action)
 
 detachPreFilters (Action $action)
 
 detachPostFilters (Action $action)
 
 getActionConfig ($actionName)
 
 setActionConfig ($actionName, array $config=null)
 
 runProcessingThrowable (\Throwable $throwable)
 
 runProcessingException (\Exception $e)
 
 runProcessingError (\Error $error)
 
 runProcessingBinderThrowable (BinderArgumentException $e)
 
 buildErrorFromException (\Exception $e)
 
 buildErrorFromPhpError (\Error $error)
 
 runProcessingIfUserNotAuthorized ()
 
 runProcessingIfInvalidCsrfToken ()
 
 addError (Error $error)
 
 addErrors (array $errors)
 

Защищенные данные

 $module = ''
 
 $componentName = ''
 
 $componentParameters = []
 
 $exportType
 
 $processToken
 
 $isNewProcess = true
 
 $fileName = ''
 
 $filePath = ''
 
 $fileSize = 0
 
 $fileType = 'application/csv'
 
 $processedItems = 0
 
 $totalItems = 0
 
 $pageSize = 0
 
 $lastExportedId = -1
 
 $bucket
 
 $bucketId = -1
 
 $uploadPath = ''
 
 $uploadedSize = 0
 
 $uploadedPart = 0
 
 $cloudMinChunkSize = 5 * 1024 * 1024
 
 $fieldToStoreInProcess
 
 $isBitrix24 = false
 
 $isCloudAvailable = false
 
 $isExportCompleted = false
 
 $isUploadFinished = false
 
 $timeStart = 0
 
 $stepCount = 0
 
 $useCloud = null
 
 $timeLimit = -1
 
 $hitStartTime = -1
 
 $timeLimitReached = false
 
- Защищенные данные унаследованные от Controller
 $errorCollection
 
 $request
 
Configurator $configurator
 

Дополнительные унаследованные члены

- Открытые статические члены унаследованные от Controller
static className ()
 
static getFullEventName ($eventName)
 

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

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

Методы

◆ cancelAction()

cancelAction ( )

Cancels exporting and uploading processes. Drops temporally and cloud files.

Возвращает
array

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

◆ checkCloudErrors()

checkCloudErrors ( )
protected

Checks for cloud errors.

Возвращает
bool - True if errors not exist.

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

◆ checkCommonErrors()

checkCommonErrors ( $action)
protected

Checks for common errors.

Аргументы
\Bitrix\Main\Engine\Action$actionAction.
Возвращает
bool - True if errors not exist.

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

◆ clearAction()

clearAction ( )

Drops temporally and cloud files.

Возвращает
array

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

◆ clearProgressParameters()

clearProgressParameters ( )
protected

Removes progress parameters.

Возвращает
void

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

◆ configureActions()

configureActions ( )

Action

Возвращает
array

Переопределяет метод предка Controller.

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

◆ decodeSignedParameters()

decodeSignedParameters ( $componentName,
$signedParameters )
protected

Sings and stores parameters.

Аргументы
string$componentNameComponent name.
string$signedParametersSigned parameters of component as string.
Возвращает
array
Исключения

Bitrix\Main\ArgumentTypeException

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

◆ dispatcherAction()

dispatcherAction ( )
Возвращает
array|Main\Engine\Response\AjaxJson

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

◆ downloadAction()

downloadAction ( )
Возвращает
Main\HttpResponse|void

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

◆ dropTempFile()

dropTempFile ( )
protected
Возвращает
void

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

◆ exportAction()

exportAction ( )

Performs exporting action.

Возвращает
array|Main\Engine\Response\AjaxJson

@global \CMain

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

◆ findInitBucket()

findInitBucket ( array $attributes)
protected

Finds and instantiates the cloud bucket for file attributes.

Аргументы
array$attributesFile attributes for bucket search.
Возвращает
bool

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

◆ finishAction()

finishAction ( )

Finishes exporting and uploading processes. Drops temporally.

Возвращает
array

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

◆ generateCloudLink()

generateCloudLink ( )
protected

Generate link to download exported file from cloud.

Возвращает
string

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

◆ generateDownloadLink()

generateDownloadLink ( )
protected

Generate link to download local exported temporally file.

Возвращает
string

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

◆ generateExportFileName()

generateExportFileName ( )
protected

Returns file name

Возвращает
string

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

◆ generateTempDirPath()

generateTempDirPath ( )
protected

Returns temporally directory

Возвращает
string

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

◆ generateUploadDir()

generateUploadDir ( )
protected

Returns path to upload

Возвращает
string

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

◆ getBucketList()

getBucketList ( $filter = [])
protected

Returns active cloud bucket list.

Аргументы
array$filterFilter params.
Возвращает
array

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

◆ getContentTempFile()

getContentTempFile ( )
protected
Возвращает
string

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

◆ getFileType()

getFileType ( )
protected

Returns file mime/type

Возвращает
string

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

◆ getProgressParameterOptionName()

getProgressParameterOptionName ( )
protected

Returns progress option name

Возвращает
string

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

◆ getProgressParameters()

getProgressParameters ( )
protected

Load progress parameters.

Возвращает
array

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

◆ getSignedParameters()

getSignedParameters ( $componentName,
array $params )
protected

Sings and returns parameters as string in format "{message}{separator}{signature}".

Аргументы
string$componentNameComponent name.
array$paramsParameters of component.
Возвращает
string
Исключения

Bitrix\Main\ArgumentTypeException

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

◆ getSizeTempFile()

getSizeTempFile ( )
protected
Возвращает
int

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

◆ hasTimeLimitReached()

hasTimeLimitReached ( )
protected

Tells true if time limit reached.

Возвращает
boolean

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

◆ init()

init ( )
protected

Initializes controller.

Возвращает
void

Переопределяет метод предка Controller.

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

◆ instanceBucket()

instanceBucket ( )
protected

Returns the cloud bucket for file attributes.

Возвращает
\CCloudStorageBucket

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

◆ keepFieldInProcess()

keepFieldInProcess ( $fieldName)
protected

Add name on filed to keep during in the process.

Аргументы
string$fieldNameField name.
Возвращает
self

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

◆ preformAnswer()

preformAnswer ( $action)
protected

Preforms action answer.

Аргументы
string$actionAction.
Возвращает
array

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

◆ preformExpectedDuration()

preformExpectedDuration ( )
protected

Preform expected duration message.

Возвращает
string

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

◆ processBeforeAction()

processBeforeAction ( Main\Engine\Action $action)
protected

Common operations before process action.

Аргументы
Main\Engine\Action$actionAction.
Возвращает
bool If method will return false, then action will not execute.

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

◆ purgeAction()

purgeAction ( )

Drops all outdated cloud files.

Возвращает
array

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

◆ saveProgressParameters()

saveProgressParameters ( )
protected

Save progress parameters.

Возвращает
void

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

◆ startTimer()

startTimer ( $timeLimit = 25)
protected

Start up timer.

Аргументы
int$timeLimitTime limit.
Возвращает
void

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

◆ uploadAction()

uploadAction ( )

Performs of the action uploading into the cloud.

Возвращает
array

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

◆ writeTempFile()

writeTempFile ( $data,
$precedeUtf8Bom = true )
protected
Аргументы
string$dataBytes to write.
boolean$precedeUtf8BomPrecede first bites with UTF8 BOM mark.
Возвращает
void

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

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

◆ $bucket

$bucket
protected

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

◆ $bucketId

$bucketId = -1
protected

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

◆ $cloudMinChunkSize

$cloudMinChunkSize = 5 * 1024 * 1024
protected

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

◆ $componentName

$componentName = ''
protected

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

◆ $componentParameters

$componentParameters = []
protected

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

◆ $exportType

$exportType
protected

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

◆ $fieldToStoreInProcess

$fieldToStoreInProcess
protected
Инициализатор
= array(
'exportType',
'fileName',
'filePath',
'fileSize',
'fileType',
'uploadedSize',
'uploadPath',
'uploadedPart',
'pageSize',
'processedItems',
'totalItems',
'lastExportedId',
'cloudChunkSize',
'bucketId',
'isExportCompleted',
'isUploadFinished',
'timeStart',
'stepCount',
'useCloud',
)

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

◆ $fileName

$fileName = ''
protected

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

◆ $filePath

$filePath = ''
protected

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

◆ $fileSize

$fileSize = 0
protected

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

◆ $fileType

$fileType = 'application/csv'
protected

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

◆ $hitStartTime

$hitStartTime = -1
protected

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

◆ $isBitrix24

$isBitrix24 = false
protected

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

◆ $isCloudAvailable

$isCloudAvailable = false
protected

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

◆ $isExportCompleted

$isExportCompleted = false
protected

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

◆ $isNewProcess

$isNewProcess = true
protected

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

◆ $isUploadFinished

$isUploadFinished = false
protected

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

◆ $lastExportedId

$lastExportedId = -1
protected

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

◆ $module

$module = ''
protected

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

◆ $pageSize

$pageSize = 0
protected

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

◆ $processedItems

$processedItems = 0
protected

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

◆ $processToken

$processToken
protected

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

◆ $stepCount

$stepCount = 0
protected

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

◆ $timeLimit

$timeLimit = -1
protected

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

◆ $timeLimitReached

$timeLimitReached = false
protected

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

◆ $timeStart

$timeStart = 0
protected

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

◆ $totalItems

$totalItems = 0
protected

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

◆ $uploadedPart

$uploadedPart = 0
protected

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

◆ $uploadedSize

$uploadedSize = 0
protected

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

◆ $uploadPath

$uploadPath = ''
protected

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

◆ $useCloud

$useCloud = null
protected

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

◆ ACTION_CANCEL

const ACTION_CANCEL = 'cancel'

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

◆ ACTION_CLEAR

const ACTION_CLEAR = 'clear'

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

◆ ACTION_DOWNLOAD

const ACTION_DOWNLOAD = 'download'

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

◆ ACTION_EXPORT

const ACTION_EXPORT = 'export'

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

◆ ACTION_FINISH

const ACTION_FINISH = 'finish'

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

◆ ACTION_PURGE

const ACTION_PURGE = 'purge'

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

◆ ACTION_UPLOAD

const ACTION_UPLOAD = 'upload'

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

◆ ACTION_VOID

const ACTION_VOID = 'void'

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

◆ EXPIRE_DAYS

const EXPIRE_DAYS = 24

How many day keep files in the cloud.

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

◆ EXPORT_PATH

const EXPORT_PATH = '/export/'

Where to store cloud files.

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

◆ EXPORT_TYPE_CSV

const EXPORT_TYPE_CSV = 'csv'

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

◆ EXPORT_TYPE_EXCEL

const EXPORT_TYPE_EXCEL = 'excel'

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

◆ KEEP_FILE_HOURS

const KEEP_FILE_HOURS = 24

How long to keep temporally files.

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

◆ ROWS_PER_PAGE

const ROWS_PER_PAGE = 100

Default limitation query result per page.

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

◆ STATUS_COMPLETED

const STATUS_COMPLETED = 'COMPLETED'

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

◆ STATUS_PROGRESS

const STATUS_PROGRESS = 'PROGRESS'

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

◆ TIME_LIMIT

const TIME_LIMIT = 20

@const int

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