Inheritance diagram for TYPO3\CMS\Impexp\Export:

Public Member Functions
	__construct ()

	process ()

	setPageTree (array $pageTree)

	setRecordTypesIncludeFields (array $recordTypesIncludeFields)

	exportAddRecord (string $table, array $row, int $relationLevel=0)

	fixFileIdInRelations (array &$relations)

	removeRedundantSoftRefsInRelations (array &$relations)

string	render ()

	saveToFile ()

	getExportFileName ()

	setExportFileName (string $exportFileName)

	getOrGenerateExportFileNameWithFileExtension ()

	getExportFileType ()

	setExportFileType (string $exportFileType)

	getSupportedFileTypes ()

	getTitle ()

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getNotes ()

	setNotes (string $notes)

	getRecord ()

	setRecord (array $record)

	getList ()

	setList (array $list)

	getLevels ()

	setLevels (int $levels)

	getTables ()

	setTables (array $tables)

	getRelOnlyTables ()

	setRelOnlyTables (array $relOnlyTables)

	getTreeHTML ()

	isIncludeExtFileResources ()

	setIncludeExtFileResources (bool $includeExtFileResources)

	setSaveFilesOutsideExportFile (bool $saveFilesOutsideExportFile)

	isSaveFilesOutsideExportFile ()

‪Public Member Functions inherited from ‪TYPO3\CMS\Impexp\ImportExport
array	renderPreview ()

	addFiles (array $relations, array &$lines, int $indent, string $tokenID='')

	getFileadminFolderName ()

	getOrCreateTemporaryFolderName ()

	removeTemporaryFolderName ()

	getOrCreateDefaultImportExportFolder ()

	removeDefaultImportExportFolder ()

	hasErrors ()

	getPid ()

	setPid (int $pid)

	setExcludeDisabledRecords (bool $excludeDisabledRecords)

	isExcludeDisabledRecords ()

	getExcludeMap ()

	setExcludeMap (array $excludeMap)

	getSoftrefCfg ()

	setSoftrefCfg (array $softrefCfg)

	getExtensionDependencies ()

	setExtensionDependencies (array $extensionDependencies)

	isShowStaticRelations ()

	setShowStaticRelations (bool $showStaticRelations)

	getRelStaticTables ()

	setRelStaticTables (array $relStaticTables)

	getErrorLog ()

	setErrorLog (array $errorLog)

	isUpdate ()

	setUpdate (bool $update)

	getImportMode ()

	setImportMode (array $importMode)

	isGlobalIgnorePid ()

	setGlobalIgnorePid (bool $globalIgnorePid)

	isForceAllUids ()

	setForceAllUids (bool $forceAllUids)

	isShowDiff ()

	setShowDiff (bool $showDiff)

	getSoftrefInputValues ()

	setSoftrefInputValues (array $softrefInputValues)

	getMode ()

	setMode (string $mode)

	getImportMapId ()

	setImportMapId (array $importMapId)

	getDat ()

Public Attributes
const	LEVELS_RECORDS_ON_THIS_PAGE = -2

const	LEVELS_EXPANDED_TREE = -1

const	LEVELS_INFINITE = 999

const	FILETYPE_XML = 'xml'

const	FILETYPE_T3D = 't3d'

const	FILETYPE_T3DZ = 't3d_compressed'

Protected Member Functions
	initializeExport ()

	setHeaderBasics ()

	setMetaData ()

	removeExcludedPagesFromPageTree (array &$pageTree)

	setRecordTypeIncludeFields (string $table, array $fields)

string	getExcludePagesClause ()

	addRecordsForPid (int $pid, array $tables)

Result	execListQueryPid (int $pid, string $table)

bool	isPageInWebMount (int $pid)

array	filterRecordFields (string $table, array $row)

array	flatDbRelations (array $relations)

array	flatSoftRefs (array $relations)

int	exportAddRecordsFromRelations (int $relationLevel=0)

	exportAddRecordsFromRelationsPushRelation (array $recordData, array &$addRecords, string $tokenID='')

bool	inclRelation (string $table)

	exportAddFilesFromRelations ()

	exportAddFile (array $fileData, string $recordRef='', string $field='')

	exportAddFilesFromSysFilesRecords ()

	exportAddSysFile (array $fileData)

string	createXML ()

string	addFilePart (string $data)

	generateExportFileName ()

	getFileExtensionByFileType ()

‪Protected Member Functions inherited from ‪TYPO3\CMS\Impexp\ImportExport
	fetchStorages ()

	traversePageTree (array $pageTree, array &$lines, int $indent=0)

bool	isRecordDisabled (string $table, int $uid)

	excludePageAndRecords (int $pageUid, array $page)

	traversePageRecords (array $pageTree, array &$lines)

	traverseAllRecords (array $pageTree, array &$lines)

	addGeneralErrorsByTable (string $table)

	addRecord (string $table, int $uid, array &$lines, int $indent, bool $checkImportInPidRecord=false)

	addRelations (array $relations, array &$lines, int $indent, array $recursionCheck=[])

	addSoftRefs (array $softrefs, array &$lines, int $indent)

	renderIndent (int $indent)

bool	checkDokType (string $table, int $dokType)

string	renderControls (array $line)

string	renderRecordExcludeCheckbox (string $recordRef)

string	renderSoftRefImportTextField (array $softref)

string	renderSoftRefExportSelector (array $softref)

string	renderImportModeSelector (string $table, int $uid, bool $doesRecordExist)

string	renderSelectBox (string $name, string $value, array $options)

	createTemporaryFolderName ()

	createDefaultImportExportFolder ()

string	resolveStoragePath (string $dirPrefix, bool $checkAlternatives=true)

	flatInversePageTree (array $pageTree, array &$list, int $pid=-1)

bool	isTableStatic (string $table)

bool	isRecordExcluded (string $table, int $uid)

bool	isSoftRefIncluded (string $tokenID)

array null	getRecordFromDatabase (string $table, int $uid, string $fields='uid, pid')

string	getRecordPath (int $pid)

string	compareRecords (array $databaseRecord, array $importRecord, string $table, bool $inverse=false)

DiffUtility	getDiffUtility ()

ExtendedFileUtility	getFileProcObj ()

StorageRepository	getStorageRepository ()

	addError (string $message)

	getBackendUser ()

	getLanguageService ()

	getPidRecord ()

Protected Attributes
string	$mode = 'export'

string	$title = ''

string	$description = ''

string	$notes = ''

array	$record = array( )

array	$list = array( )

int	$levels = 0

array	$tables = array( )

array	$relOnlyTables = array( )

string	$treeHTML = ''

bool	$includeExtFileResources = true

string	$extFileResourceExtensions = 'html,htm,css'

array	$recordTypesIncludeFields = array( )

array	$defaultRecordIncludeFields = array( 'uid', 'pid' )

bool	$saveFilesOutsideExportFile = false

string	$exportFileName = ''

string	$exportFileType = self::FILETYPE_XML

array	$supportedFileTypes = array( )

bool	$compressionAvailable = false

array	$pageInWebMountCache = array( )

‪Protected Attributes inherited from ‪TYPO3\CMS\Impexp\ImportExport
string	$mode = ''

string	$permsClause

int	$pid = -1

array	$pidRecord = null

bool	$showStaticRelations = false

bool	$update = false

bool	$doesImport = false

array	$importMode = array( )

bool	$globalIgnorePid = false

bool	$forceAllUids = false

bool	$showDiff = false

array	$softrefInputValues = array( )

array	$fileIdMap = array( )

array	$relStaticTables = array( )

array	$excludeMap = array( )

array	$softrefCfg = array( )

array	$extensionDependencies = array( )

array	$importMapId = array( )

array	$errorLog = array( )

array	$cacheGetRecordPath = array( )

array	$dat = array( )

ExtendedFileUtility	$fileProcObj

DiffUtility	$diffUtility

array	$remainHeader = array( )

LanguageService	$lang

IconFactory	$iconFactory

string	$fileadminFolderName = ''

string	$temporaryFolderName = null

Folder	$defaultImportExportFolder = null

bool	$excludeDisabledRecords = false

ResourceStorage[]	$storages = array( )

ResourceStorage[]	$storagesAvailableForImport = array( )

ResourceStorage	$defaultStorage = null

StorageRepository	$storageRepository

Detailed Description

T3D file Export library (TYPO3 Record Document)

This class is not considered part of the public TYPO3 API.

Definition at line 50 of file Export.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Impexp\Export::__construct ( )

The constructor

Reimplemented from TYPO3\CMS\Impexp\ImportExport.

Definition at line 159 of file Export.php.

Member Function Documentation

◆ addFilePart()

string TYPO3\CMS\Impexp\Export::addFilePart ( string $data )

protected

Returns a content part for a filename being build.

Parameters

string $data ‪Data to store in part

Returns: ‪string Content stream.

Definition at line 1282 of file Export.php.

References TYPO3\CMS\Impexp\Export\FILETYPE_T3DZ.

Referenced by TYPO3\CMS\Impexp\Export\render().

◆ addRecordsForPid()

TYPO3\CMS\Impexp\Export::addRecordsForPid	(	int	$pid,
		array	$tables
	)

protected

Adds records to the export object for a specific page id.

Parameters

int	$pid	‪Page id for which to select records to add
array	$tables	‪Array of table names to select from

Definition at line 412 of file Export.php.

References $GLOBALS, TYPO3\CMS\Impexp\Export\$record, TYPO3\CMS\Impexp\Export\$tables, TYPO3\CMS\Impexp\Export\execListQueryPid(), TYPO3\CMS\Impexp\Export\exportAddRecord(), and TYPO3\CMS\Impexp\ImportExport\getBackendUser().

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ createXML()

string TYPO3\CMS\Impexp\Export::createXML ( )

protected

Creates XML string from input array

Returns: ‪string XML content

Definition at line 1182 of file Export.php.

References TYPO3\CMS\Core\Serializer\Typo3XmlParserOptions\ROOT_NODE_NAME.

Referenced by TYPO3\CMS\Impexp\Export\render().

◆ execListQueryPid()

Result TYPO3\CMS\Impexp\Export::execListQueryPid	(	int	$pid,
		string	$table
	)

protected

Selects records from table / pid

Parameters

int	$pid	‪Page ID to select from
string	$table	‪Table to select from

Returns: ‪Result Query statement

Definition at line 437 of file Export.php.

References $GLOBALS, TYPO3\CMS\Impexp\ImportExport\$pid, TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Database\Query\QueryHelper\parseOrderBy().

Referenced by TYPO3\CMS\Impexp\Export\addRecordsForPid(), and TYPO3\CMS\Impexp\Export\process().

◆ exportAddFile()

TYPO3\CMS\Impexp\Export::exportAddFile	(	array	$fileData,
		string	$recordRef = `''`,
		string	$field = `''`
	)

protected

This adds the file to the export

‪either as content or external file

Parameters

array	$fileData	‪File information with three keys: "filename" = filename without path, "ID_absFile" = absolute filepath to the file (including the filename), "ID" = md5 hash of "ID_absFile". "relFileName" is optional for files attached to records, but mandatory for soft referenced files (since the relFileName determines where such a file should be stored!)
string	$recordRef	‪If the file is related to a record, this is the id of the form [table]:[id]. Information purposes only.
string	$field	‪If the file is related to a record, this is the field name it was related to. Information purposes only.

Definition at line 972 of file Export.php.

References $GLOBALS, TYPO3\CMS\Impexp\ImportExport\addError(), TYPO3\CMS\Core\Utility\PathUtility\basename(), TYPO3\CMS\Core\Utility\PathUtility\dirname(), TYPO3\CMS\Impexp\ImportExport\getFileadminFolderName(), TYPO3\CMS\Impexp\ImportExport\getOrCreateTemporaryFolderName(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

Referenced by TYPO3\CMS\Impexp\Export\exportAddFilesFromRelations().

◆ exportAddFilesFromRelations()

TYPO3\CMS\Impexp\Export::exportAddFilesFromRelations ( )

protected

This adds all files in relations. Call this method AFTER adding all records including relations.

See also: ‪exportAddRecordsFromRelations()

Definition at line 874 of file Export.php.

References TYPO3\CMS\Impexp\Export\$record, TYPO3\CMS\Impexp\ImportExport\addError(), TYPO3\CMS\Core\Utility\PathUtility\basename(), TYPO3\CMS\Impexp\Export\exportAddFile(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), and TYPO3\CMS\Impexp\ImportExport\isSoftRefIncluded().

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ exportAddFilesFromSysFilesRecords()

TYPO3\CMS\Impexp\Export::exportAddFilesFromSysFilesRecords ( )

protected

This adds all files from sys_file records

Definition at line 1090 of file Export.php.

References TYPO3\CMS\Impexp\Export\exportAddSysFile().

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ exportAddRecord()

TYPO3\CMS\Impexp\Export::exportAddRecord	(	string	$table,
		array	$row,
		int	$relationLevel = `0`
	)

Adds the record $row from $table. No checking for relations done here. Pure data.

Parameters

string	$table	‪Table name
array	$row	‪Record row.
int	$relationLevel	‪(Internal) if the record is added as a relation, this is set to the "level" it was on.

Definition at line 483 of file Export.php.

References TYPO3\CMS\Impexp\ImportExport\addError(), TYPO3\CMS\Impexp\Export\filterRecordFields(), TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Impexp\Export\fixFileIdInRelations(), TYPO3\CMS\Impexp\Export\flatDbRelations(), TYPO3\CMS\Impexp\Export\flatSoftRefs(), TYPO3\CMS\Impexp\Export\isPageInWebMount(), TYPO3\CMS\Impexp\ImportExport\isRecordDisabled(), TYPO3\CMS\Impexp\ImportExport\isRecordExcluded(), and TYPO3\CMS\Impexp\Export\removeRedundantSoftRefsInRelations().

Referenced by TYPO3\CMS\Impexp\Export\addRecordsForPid(), TYPO3\CMS\Impexp\Export\exportAddRecordsFromRelations(), and TYPO3\CMS\Impexp\Export\process().

◆ exportAddRecordsFromRelations()

int TYPO3\CMS\Impexp\Export::exportAddRecordsFromRelations ( int $relationLevel = 0 )

protected

This analyzes the existing added records, finds all database relations to records and adds these records to the export file. This function can be called repeatedly until it returns zero added records. In principle it should not allow to infinite recursion, but you better set a limit... Call this BEFORE the exportAddFilesFromRelations (so files from added relations are also included of course)

Parameters

int $relationLevel ‪Recursion level

Returns: ‪int number of records from relations found and added

See also: ‪exportAddFilesFromRelations()

Definition at line 738 of file Export.php.

References TYPO3\CMS\Impexp\Export\$record, TYPO3\CMS\Impexp\ImportExport\addError(), TYPO3\CMS\Impexp\Export\exportAddRecord(), TYPO3\CMS\Impexp\Export\exportAddRecordsFromRelationsPushRelation(), and TYPO3\CMS\Impexp\ImportExport\isSoftRefIncluded().

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ exportAddRecordsFromRelationsPushRelation()

TYPO3\CMS\Impexp\Export::exportAddRecordsFromRelationsPushRelation	(	array	$recordData,
		array &	$addRecords,
		string	$tokenID = `''`
	)

protected

Helper function for exportAddRecordsFromRelations()

Parameters

array	$recordData	‪Record of relation with table/id key to add to $addRecords
array	$addRecords	‪Records of relations which are already marked as to be added to the export
string	$tokenID	‪Soft reference token ID, if applicable.

See also: ‪exportAddRecordsFromRelations()

Definition at line 841 of file Export.php.

References $GLOBALS, TYPO3\CMS\Impexp\Export\inclRelation(), TYPO3\CMS\Impexp\ImportExport\isRecordExcluded(), TYPO3\CMS\Impexp\ImportExport\isSoftRefIncluded(), and TYPO3\CMS\Impexp\ImportExport\isTableStatic().

Referenced by TYPO3\CMS\Impexp\Export\exportAddRecordsFromRelations().

◆ exportAddSysFile()

TYPO3\CMS\Impexp\Export::exportAddSysFile ( array $fileData )

protected

This adds the file from a sys_file record to the export

‪either as content or external file

Exceptions

Definition at line 1107 of file Export.php.

References TYPO3\CMS\Impexp\ImportExport\addError().

Referenced by TYPO3\CMS\Impexp\Export\exportAddFilesFromSysFilesRecords().

◆ filterRecordFields()

array TYPO3\CMS\Impexp\Export::filterRecordFields	(	string	$table,
		array	$row
	)

protected

If include fields for a specific record type are set, the data are filtered out with fields are not included in the fields. Used in tests only.

Parameters

string	$table	‪The record type to be filtered
array	$row	‪The data to be filtered

Returns: ‪array The filtered record row

Definition at line 552 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\exportAddRecord().

◆ fixFileIdInRelations()

TYPO3\CMS\Impexp\Export::fixFileIdInRelations ( array & $relations )

This changes the file reference ID from a hash based on the absolute file path (coming from ReferenceIndex) to a hash based on the relative file path.

Public access for testing purpose only.

Parameters

array $relations

Definition at line 579 of file Export.php.

References TYPO3\CMS\Core\Core\Environment\getPublicPath(), and TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

Referenced by TYPO3\CMS\Impexp\Export\exportAddRecord().

◆ flatDbRelations()

array TYPO3\CMS\Impexp\Export::flatDbRelations ( array $relations )

protected

Database relations flattened to 1-dimensional array. The list will be unique, no table/uid combination will appear twice.

Parameters

array $relations ‪2-dimensional array of database relations organized by table key

Returns: ‪array 1-dimensional array where entries are table:uid and keys are array with table/id

Definition at line 655 of file Export.php.

References TYPO3\CMS\Impexp\Export\$list.

Referenced by TYPO3\CMS\Impexp\Export\exportAddRecord().

◆ flatSoftRefs()

array TYPO3\CMS\Impexp\Export::flatSoftRefs ( array $relations )

protected

Soft references flattened to 1-dimensional array.

Parameters

array $relations ‪2-dimensional array of database relations organized by table key

Returns: ‪array 1-dimensional array where entries are arrays with properties of the soft link found and keys are a unique combination of field, spKey, structure path if applicable and token ID

Definition at line 683 of file Export.php.

References TYPO3\CMS\Impexp\Export\$list, and TYPO3\CMS\Core\Core\Environment\getPublicPath().

Referenced by TYPO3\CMS\Impexp\Export\exportAddRecord().

◆ generateExportFileName()

TYPO3\CMS\Impexp\Export::generateExportFileName ( )

protected

Definition at line 1351 of file Export.php.

References TYPO3\CMS\Impexp\Export\$exportFileName, TYPO3\CMS\Impexp\Export\$levels, TYPO3\CMS\Impexp\Export\getList(), and TYPO3\CMS\Impexp\Export\getRecord().

Referenced by TYPO3\CMS\Impexp\Export\getOrGenerateExportFileNameWithFileExtension().

◆ getDescription()

TYPO3\CMS\Impexp\Export::getDescription ( )

Definition at line 1430 of file Export.php.

References TYPO3\CMS\Impexp\Export\$description.

◆ getExcludePagesClause()

string TYPO3\CMS\Impexp\Export::getExcludePagesClause ( )

protected

Filter page IDs by traversing the exclude map, finding all excluded pages (if any) and making an AND NOT IN statement for the select clause.

Returns: ‪string AND where clause part to filter out page uids.

Definition at line 390 of file Export.php.

References TYPO3\CMS\Webhooks\Message\$uid.

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ getExportFileName()

TYPO3\CMS\Impexp\Export::getExportFileName ( )

Definition at line 1328 of file Export.php.

References TYPO3\CMS\Impexp\Export\$exportFileName.

◆ getExportFileType()

TYPO3\CMS\Impexp\Export::getExportFileType ( )

Definition at line 1370 of file Export.php.

References TYPO3\CMS\Impexp\Export\$exportFileType.

◆ getFileExtensionByFileType()

TYPO3\CMS\Impexp\Export::getFileExtensionByFileType ( )

protected

Definition at line 1407 of file Export.php.

References TYPO3\CMS\Impexp\Export\FILETYPE_T3D, TYPO3\CMS\Impexp\Export\FILETYPE_T3DZ, and TYPO3\CMS\Impexp\Export\FILETYPE_XML.

Referenced by TYPO3\CMS\Impexp\Export\getOrGenerateExportFileNameWithFileExtension().

◆ getLevels()

TYPO3\CMS\Impexp\Export::getLevels ( )

Definition at line 1470 of file Export.php.

References TYPO3\CMS\Impexp\Export\$levels.

◆ getList()

TYPO3\CMS\Impexp\Export::getList ( )

Definition at line 1460 of file Export.php.

References TYPO3\CMS\Impexp\Export\$list.

Referenced by TYPO3\CMS\Impexp\Export\generateExportFileName().

◆ getNotes()

TYPO3\CMS\Impexp\Export::getNotes ( )

Definition at line 1440 of file Export.php.

References TYPO3\CMS\Impexp\Export\$notes.

◆ getOrGenerateExportFileNameWithFileExtension()

TYPO3\CMS\Impexp\Export::getOrGenerateExportFileNameWithFileExtension ( )

Definition at line 1339 of file Export.php.

References TYPO3\CMS\Impexp\Export\$exportFileName, TYPO3\CMS\Impexp\Export\generateExportFileName(), and TYPO3\CMS\Impexp\Export\getFileExtensionByFileType().

Referenced by TYPO3\CMS\Impexp\Controller\ExportController\getDownload(), and TYPO3\CMS\Impexp\Export\saveToFile().

◆ getRecord()

TYPO3\CMS\Impexp\Export::getRecord ( )

Definition at line 1450 of file Export.php.

References TYPO3\CMS\Impexp\Export\$record.

Referenced by TYPO3\CMS\Impexp\Export\generateExportFileName().

◆ getRelOnlyTables()

TYPO3\CMS\Impexp\Export::getRelOnlyTables ( )

Definition at line 1490 of file Export.php.

References TYPO3\CMS\Impexp\Export\$relOnlyTables.

◆ getSupportedFileTypes()

TYPO3\CMS\Impexp\Export::getSupportedFileTypes ( )

Definition at line 1393 of file Export.php.

References TYPO3\CMS\Impexp\Export\$supportedFileTypes, TYPO3\CMS\Impexp\Export\FILETYPE_T3D, TYPO3\CMS\Impexp\Export\FILETYPE_T3DZ, and TYPO3\CMS\Impexp\Export\FILETYPE_XML.

Referenced by TYPO3\CMS\Impexp\Controller\ExportController\getFileSelectOptions(), and TYPO3\CMS\Impexp\Export\setExportFileType().

◆ getTables()

TYPO3\CMS\Impexp\Export::getTables ( )

Definition at line 1480 of file Export.php.

References TYPO3\CMS\Impexp\Export\$tables.

◆ getTitle()

TYPO3\CMS\Impexp\Export::getTitle ( )

Definition at line 1420 of file Export.php.

References TYPO3\CMS\Impexp\Export\$title.

◆ getTreeHTML()

TYPO3\CMS\Impexp\Export::getTreeHTML ( )

Definition at line 1500 of file Export.php.

References TYPO3\CMS\Impexp\Export\$treeHTML.

◆ inclRelation()

bool TYPO3\CMS\Impexp\Export::inclRelation ( string $table )

protected

Returns TRUE if the input table name is to be included as relation

Parameters

string $table ‪Table name

Returns: ‪bool TRUE, if table is marked static

Definition at line 861 of file Export.php.

References $GLOBALS, and TYPO3\CMS\Impexp\ImportExport\getBackendUser().

Referenced by TYPO3\CMS\Impexp\Export\exportAddRecordsFromRelationsPushRelation().

◆ initializeExport()

TYPO3\CMS\Impexp\Export::initializeExport ( )

protected

Initialize all settings for the export

Definition at line 262 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ isIncludeExtFileResources()

TYPO3\CMS\Impexp\Export::isIncludeExtFileResources ( )

Definition at line 1505 of file Export.php.

References TYPO3\CMS\Impexp\Export\$includeExtFileResources.

◆ isPageInWebMount()

bool TYPO3\CMS\Impexp\Export::isPageInWebMount ( int $pid )

protected

Checking if a page is in the web mounts of the user

Parameters

int $pid ‪Page ID to check

Returns: ‪bool TRUE if OK

Definition at line 535 of file Export.php.

References TYPO3\CMS\Impexp\ImportExport\$pid, and TYPO3\CMS\Impexp\ImportExport\getBackendUser().

Referenced by TYPO3\CMS\Impexp\Export\exportAddRecord().

◆ isSaveFilesOutsideExportFile()

TYPO3\CMS\Impexp\Export::isSaveFilesOutsideExportFile ( )

Definition at line 1526 of file Export.php.

References TYPO3\CMS\Impexp\Export\$saveFilesOutsideExportFile.

◆ process()

TYPO3\CMS\Impexp\Export::process ( )

Process configuration

Definition at line 172 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Tests\Functional\Export\PagesAndTtContentWithImagesTest\compileExportPagesAndRelatedTtContentWithImages().

◆ removeExcludedPagesFromPageTree()

TYPO3\CMS\Impexp\Export::removeExcludedPagesFromPageTree ( array & $pageTree )

protected

Removes entries in the page tree which are found in ->excludeMap[]

Parameters

array $pageTree ‪Hierarchy of ids, the page tree

Definition at line 339 of file Export.php.

References TYPO3\CMS\Impexp\ImportExport\$pid, and TYPO3\CMS\Impexp\ImportExport\isRecordExcluded().

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ removeRedundantSoftRefsInRelations()

TYPO3\CMS\Impexp\Export::removeRedundantSoftRefsInRelations ( array & $relations )

Relations could contain db relations to sys_file records. Some configuration combinations of TCA and SoftReferenceIndex create also soft reference relation entries for the identical file. This results in double included files, one in array "files" and one in array "file_fal". This function checks the relations for this double inclusions and removes the redundant soft reference relation.

Public access for testing purpose only.

Parameters

array $relations

Definition at line 620 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\exportAddRecord().

◆ render()

string TYPO3\CMS\Impexp\Export::render ( )

This compiles and returns the data content for an exported file

‪"xml" gives xml
‪"t3d" and "t3d_compressed" gives serialized array, possibly compressed

Returns: ‪string The output file stream

Definition at line 1159 of file Export.php.

References TYPO3\CMS\Impexp\Export\addFilePart(), and TYPO3\CMS\Impexp\Export\createXML().

Referenced by TYPO3\CMS\Impexp\Controller\ExportController\getDownload(), and TYPO3\CMS\Impexp\Export\saveToFile().

◆ saveToFile()

TYPO3\CMS\Impexp\Export::saveToFile ( )

Exceptions

InsufficientFolderWritePermissionsException

Definition at line 1294 of file Export.php.

References TYPO3\CMS\Core\Resource\Folder\checkActionPermission(), TYPO3\CMS\Impexp\ImportExport\getOrCreateDefaultImportExportFolder(), TYPO3\CMS\Impexp\ImportExport\getOrCreateTemporaryFolderName(), TYPO3\CMS\Impexp\Export\getOrGenerateExportFileNameWithFileExtension(), TYPO3\CMS\Impexp\ImportExport\removeTemporaryFolderName(), TYPO3\CMS\Impexp\Export\render(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Impexp\Controller\ExportController\saveExportToFile().

◆ setDescription()

TYPO3\CMS\Impexp\Export::setDescription ( string $description )

Definition at line 1435 of file Export.php.

References TYPO3\CMS\Impexp\Export\$description, and TYPO3\CMS\Redirects\Message\description.

◆ setExportFileName()

TYPO3\CMS\Impexp\Export::setExportFileName ( string $exportFileName )

Definition at line 1333 of file Export.php.

References TYPO3\CMS\Impexp\Export\$exportFileName.

◆ setExportFileType()

TYPO3\CMS\Impexp\Export::setExportFileType ( string $exportFileType )

Definition at line 1375 of file Export.php.

References TYPO3\CMS\Impexp\Export\$exportFileType, TYPO3\CMS\Impexp\Export\$supportedFileTypes, and TYPO3\CMS\Impexp\Export\getSupportedFileTypes().

◆ setHeaderBasics()

TYPO3\CMS\Impexp\Export::setHeaderBasics ( )

protected

Set header basics

Definition at line 273 of file Export.php.

References TYPO3\CMS\Impexp\ImportExport\$excludeMap, TYPO3\CMS\Impexp\ImportExport\$extensionDependencies, TYPO3\CMS\Impexp\ImportExport\$relStaticTables, and TYPO3\CMS\Impexp\ImportExport\$softrefCfg.

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ setIncludeExtFileResources()

TYPO3\CMS\Impexp\Export::setIncludeExtFileResources ( bool $includeExtFileResources )

Definition at line 1510 of file Export.php.

References TYPO3\CMS\Impexp\Export\$includeExtFileResources.

◆ setLevels()

TYPO3\CMS\Impexp\Export::setLevels ( int $levels )

Definition at line 1475 of file Export.php.

References TYPO3\CMS\Impexp\Export\$levels.

Referenced by TYPO3\CMS\Impexp\Tests\Functional\Export\PagesAndTtContentWithImagesTest\compileExportPagesAndRelatedTtContentWithImages().

◆ setList()

TYPO3\CMS\Impexp\Export::setList ( array $list )

Definition at line 1465 of file Export.php.

References TYPO3\CMS\Impexp\Export\$list.

◆ setMetaData()

TYPO3\CMS\Impexp\Export::setMetaData ( )

protected

Sets meta data

Definition at line 300 of file Export.php.

References TYPO3\CMS\Impexp\Export\$description, $GLOBALS, TYPO3\CMS\Impexp\Export\$notes, TYPO3\CMS\Impexp\Export\$title, and TYPO3\CMS\Impexp\ImportExport\getBackendUser().

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ setNotes()

TYPO3\CMS\Impexp\Export::setNotes ( string $notes )

Definition at line 1445 of file Export.php.

References TYPO3\CMS\Impexp\Export\$notes.

◆ setPageTree()

TYPO3\CMS\Impexp\Export::setPageTree ( array $pageTree )

Sets the page-tree array in the export header

Parameters

array $pageTree ‪Hierarchy of ids, the page tree: array([uid] => array("uid" => [uid], "subrow" => array(.....)), [uid] => ....)

Definition at line 329 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\process().

◆ setRecord()

TYPO3\CMS\Impexp\Export::setRecord ( array $record )

Definition at line 1455 of file Export.php.

References TYPO3\CMS\Impexp\Export\$record.

◆ setRecordTypeIncludeFields()

TYPO3\CMS\Impexp\Export::setRecordTypeIncludeFields	(	string	$table,
		array	$fields
	)

protected

Sets the fields of a record type to be included in the export. Used in tests only.

Parameters

string	$table	‪The record type
array	$fields	‪The fields to be included

Definition at line 379 of file Export.php.

References $fields.

Referenced by TYPO3\CMS\Impexp\Export\setRecordTypesIncludeFields().

◆ setRecordTypesIncludeFields()

TYPO3\CMS\Impexp\Export::setRecordTypesIncludeFields ( array $recordTypesIncludeFields )

Sets the fields of record types to be included in the export. Used in tests only.

Parameters

array $recordTypesIncludeFields ‪The key is the record type, the value is an array of fields to be included in the export.

Exceptions

Exception ‪if an array value is not type of array

Definition at line 362 of file Export.php.

References $fields, TYPO3\CMS\Impexp\Export\$recordTypesIncludeFields, and TYPO3\CMS\Impexp\Export\setRecordTypeIncludeFields().

Referenced by TYPO3\CMS\Impexp\Tests\Functional\Export\PagesAndTtContentWithImagesTest\compileExportPagesAndRelatedTtContentWithImages().

◆ setRelOnlyTables()

TYPO3\CMS\Impexp\Export::setRelOnlyTables ( array $relOnlyTables )

Definition at line 1495 of file Export.php.

References TYPO3\CMS\Impexp\Export\$relOnlyTables.

Referenced by TYPO3\CMS\Impexp\Tests\Functional\Export\PagesAndTtContentWithImagesTest\compileExportPagesAndRelatedTtContentWithImages().

◆ setSaveFilesOutsideExportFile()

TYPO3\CMS\Impexp\Export::setSaveFilesOutsideExportFile ( bool $saveFilesOutsideExportFile )

Option to enable having the files not included in the export file. The files are saved to a temporary folder instead.

See also: ‪ImportExport::getOrCreateTemporaryFolderName()

Definition at line 1521 of file Export.php.

References TYPO3\CMS\Impexp\Export\$saveFilesOutsideExportFile.

◆ setTables()

TYPO3\CMS\Impexp\Export::setTables ( array $tables )

Definition at line 1485 of file Export.php.

References TYPO3\CMS\Impexp\Export\$tables.

Referenced by TYPO3\CMS\Impexp\Tests\Functional\Export\PagesAndTtContentWithImagesTest\compileExportPagesAndRelatedTtContentWithImages().

◆ setTitle()

TYPO3\CMS\Impexp\Export::setTitle ( string $title )

Definition at line 1425 of file Export.php.

References TYPO3\CMS\Impexp\Export\$title.

Member Data Documentation

◆ $compressionAvailable

bool TYPO3\CMS\Impexp\Export::$compressionAvailable = false

protected

Definition at line 148 of file Export.php.

◆ $defaultRecordIncludeFields

array TYPO3\CMS\Impexp\Export::$defaultRecordIncludeFields = array( 'uid', 'pid' )

protected

Default array of fields to be included in the export

Definition at line 128 of file Export.php.

◆ $description

string TYPO3\CMS\Impexp\Export::$description = ''

protected

Definition at line 70 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\getDescription(), TYPO3\CMS\Impexp\Export\setDescription(), and TYPO3\CMS\Impexp\Export\setMetaData().

◆ $exportFileName

string TYPO3\CMS\Impexp\Export::$exportFileName = ''

protected

Definition at line 136 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\generateExportFileName(), TYPO3\CMS\Impexp\Export\getExportFileName(), TYPO3\CMS\Impexp\Export\getOrGenerateExportFileNameWithFileExtension(), and TYPO3\CMS\Impexp\Export\setExportFileName().

◆ $exportFileType

string TYPO3\CMS\Impexp\Export::$exportFileType = self::FILETYPE_XML

protected

Definition at line 140 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\getExportFileType(), and TYPO3\CMS\Impexp\Export\setExportFileType().

◆ $extFileResourceExtensions

string TYPO3\CMS\Impexp\Export::$extFileResourceExtensions = 'html,htm,css'

protected

Files with external media (HTML/css style references inside)

Definition at line 113 of file Export.php.

◆ $includeExtFileResources

bool TYPO3\CMS\Impexp\Export::$includeExtFileResources = true

protected

If set, HTML file resources are included.

Definition at line 107 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\isIncludeExtFileResources(), and TYPO3\CMS\Impexp\Export\setIncludeExtFileResources().

◆ $levels

int TYPO3\CMS\Impexp\Export::$levels = 0

protected

Definition at line 86 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\generateExportFileName(), TYPO3\CMS\Impexp\Export\getLevels(), TYPO3\CMS\Impexp\Tests\Functional\Export\ExportPageTreeViewTest\printTreeSucceeds(), and TYPO3\CMS\Impexp\Export\setLevels().

◆ $list

array TYPO3\CMS\Impexp\Export::$list = array( )

protected

Definition at line 82 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\flatDbRelations(), TYPO3\CMS\Impexp\Export\flatSoftRefs(), TYPO3\CMS\Impexp\Export\getList(), and TYPO3\CMS\Impexp\Export\setList().

◆ $mode

string TYPO3\CMS\Impexp\Export::$mode = 'export'

protected

Definition at line 62 of file Export.php.

◆ $notes

string TYPO3\CMS\Impexp\Export::$notes = ''

protected

Definition at line 74 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\getNotes(), TYPO3\CMS\Impexp\Export\setMetaData(), and TYPO3\CMS\Impexp\Export\setNotes().

◆ $pageInWebMountCache

array TYPO3\CMS\Impexp\Export::$pageInWebMountCache = array( )

protected

Cache for checks if page is in user web mounts.

Definition at line 154 of file Export.php.

◆ $record

array TYPO3\CMS\Impexp\Export::$record = array( )

protected

Definition at line 78 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\addRecordsForPid(), TYPO3\CMS\Impexp\Export\exportAddFilesFromRelations(), TYPO3\CMS\Impexp\Export\exportAddRecordsFromRelations(), TYPO3\CMS\Impexp\Export\getRecord(), TYPO3\CMS\Impexp\Export\process(), and TYPO3\CMS\Impexp\Export\setRecord().

◆ $recordTypesIncludeFields

array TYPO3\CMS\Impexp\Export::$recordTypesIncludeFields = array( )

protected

The key is the record type (e.g. 'be_users'), the value is an array of fields to be included in the export.

Used in tests only.

Definition at line 122 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Tests\Functional\Export\PagesAndTtContentWithImagesTest\compileExportPagesAndRelatedTtContentWithImages(), TYPO3\CMS\Impexp\Tests\Functional\Export\IrreTutorialRecordsTest\exportIrreRecords(), and TYPO3\CMS\Impexp\Export\setRecordTypesIncludeFields().

◆ $relOnlyTables

array TYPO3\CMS\Impexp\Export::$relOnlyTables = array( )

protected

Add table names here which are THE ONLY ones which will be included into export if found as relations. '_ALL' will allow all tables.

Definition at line 97 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\getRelOnlyTables(), and TYPO3\CMS\Impexp\Export\setRelOnlyTables().

◆ $saveFilesOutsideExportFile

bool TYPO3\CMS\Impexp\Export::$saveFilesOutsideExportFile = false

protected

Definition at line 132 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\isSaveFilesOutsideExportFile(), and TYPO3\CMS\Impexp\Export\setSaveFilesOutsideExportFile().

◆ $supportedFileTypes

array TYPO3\CMS\Impexp\Export::$supportedFileTypes = array( )

protected

Definition at line 144 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\getSupportedFileTypes(), and TYPO3\CMS\Impexp\Export\setExportFileType().

◆ $tables

array TYPO3\CMS\Impexp\Export::$tables = array( )

protected

Definition at line 90 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\addRecordsForPid(), TYPO3\CMS\Impexp\Export\getTables(), and TYPO3\CMS\Impexp\Export\setTables().

◆ $title

string TYPO3\CMS\Impexp\Export::$title = ''

protected

Definition at line 66 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\getTitle(), TYPO3\CMS\Impexp\Export\setMetaData(), and TYPO3\CMS\Impexp\Export\setTitle().

◆ $treeHTML

string TYPO3\CMS\Impexp\Export::$treeHTML = ''

protected

Definition at line 101 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\getTreeHTML().

◆ FILETYPE_T3D

const TYPO3\CMS\Impexp\Export::FILETYPE_T3D = 't3d'

Definition at line 57 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Tests\Functional\Command\ExportCommandTest\exportCommandPassesArgumentsToExportObject(), TYPO3\CMS\Impexp\Export\getFileExtensionByFileType(), TYPO3\CMS\Impexp\Export\getSupportedFileTypes(), TYPO3\CMS\Impexp\Tests\Functional\ExportTest\saveT3dToFileSucceeds(), and TYPO3\CMS\Impexp\Tests\Unit\ExportTest\setExportFileTypeSucceedsWithSupportedFileTypeProvider().

◆ FILETYPE_T3DZ

const TYPO3\CMS\Impexp\Export::FILETYPE_T3DZ = 't3d_compressed'

Definition at line 58 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\addFilePart(), TYPO3\CMS\Impexp\Export\getFileExtensionByFileType(), TYPO3\CMS\Impexp\Export\getSupportedFileTypes(), TYPO3\CMS\Impexp\Tests\Functional\ExportTest\saveT3dCompressedToFileSucceeds(), and TYPO3\CMS\Impexp\Tests\Unit\ExportTest\setExportFileTypeSucceedsWithSupportedFileTypeProvider().

◆ FILETYPE_XML

const TYPO3\CMS\Impexp\Export::FILETYPE_XML = 'xml'

Definition at line 56 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Export\getFileExtensionByFileType(), TYPO3\CMS\Impexp\Export\getSupportedFileTypes(), and TYPO3\CMS\Impexp\Tests\Unit\ExportTest\setExportFileTypeSucceedsWithSupportedFileTypeProvider().

◆ LEVELS_EXPANDED_TREE

const TYPO3\CMS\Impexp\Export::LEVELS_EXPANDED_TREE = -1

Definition at line 53 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Command\ExportCommand\configure(), TYPO3\CMS\Impexp\Controller\ExportController\getPageLevelSelectOptions(), and TYPO3\CMS\Impexp\Tests\Functional\Export\ExportPageTreeViewTest\printTreeSucceedsDataProvider().

◆ LEVELS_INFINITE

const TYPO3\CMS\Impexp\Export::LEVELS_INFINITE = 999

Definition at line 54 of file Export.php.

Referenced by TYPO3\CMS\Impexp\View\ExportPageTreeView\buildTreeByExpandedState(), TYPO3\CMS\Impexp\Command\ExportCommand\configure(), TYPO3\CMS\Impexp\Controller\ExportController\getPageLevelSelectOptions(), TYPO3\CMS\Impexp\Tests\Functional\ImportExportTest\importExportPingPongSucceeds(), TYPO3\CMS\Impexp\Tests\Functional\ExportTest\renderPreviewForExportOfPageAndRecords(), and TYPO3\CMS\Impexp\Tests\Functional\ExportTest\renderPreviewForExportOfPageAndRecordsWithSoftRefs().

◆ LEVELS_RECORDS_ON_THIS_PAGE

const TYPO3\CMS\Impexp\Export::LEVELS_RECORDS_ON_THIS_PAGE = -2

Definition at line 52 of file Export.php.

Referenced by TYPO3\CMS\Impexp\Command\ExportCommand\configure(), TYPO3\CMS\Impexp\Tests\Functional\Command\ExportCommandTest\exportCommandPassesArgumentsToExportObject(), and TYPO3\CMS\Impexp\Controller\ExportController\getPageLevelSelectOptions().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFilePart()

◆ addRecordsForPid()

◆ createXML()

◆ execListQueryPid()

◆ exportAddFile()

◆ exportAddFilesFromRelations()

◆ exportAddFilesFromSysFilesRecords()

◆ exportAddRecord()

◆ exportAddRecordsFromRelations()

◆ exportAddRecordsFromRelationsPushRelation()

◆ exportAddSysFile()

◆ filterRecordFields()

◆ fixFileIdInRelations()

◆ flatDbRelations()

◆ flatSoftRefs()

◆ generateExportFileName()

◆ getDescription()

◆ getExcludePagesClause()

◆ getExportFileName()

◆ getExportFileType()

◆ getFileExtensionByFileType()

◆ getLevels()

◆ getList()

◆ getNotes()

◆ getOrGenerateExportFileNameWithFileExtension()

◆ getRecord()

◆ getRelOnlyTables()

◆ getSupportedFileTypes()

◆ getTables()

◆ getTitle()

◆ getTreeHTML()

◆ inclRelation()

◆ initializeExport()

◆ isIncludeExtFileResources()

◆ isPageInWebMount()

◆ isSaveFilesOutsideExportFile()

◆ process()

◆ removeExcludedPagesFromPageTree()

◆ removeRedundantSoftRefsInRelations()

◆ render()

◆ saveToFile()

◆ setDescription()

◆ setExportFileName()

◆ setExportFileType()

◆ setHeaderBasics()

◆ setIncludeExtFileResources()

◆ setLevels()

◆ setList()

◆ setMetaData()

◆ setNotes()

◆ setPageTree()

◆ setRecord()

◆ setRecordTypeIncludeFields()

◆ setRecordTypesIncludeFields()

◆ setRelOnlyTables()

◆ setSaveFilesOutsideExportFile()

◆ setTables()

◆ setTitle()

Member Data Documentation

◆ $compressionAvailable

◆ $defaultRecordIncludeFields

◆ $description

◆ $exportFileName

◆ $exportFileType

◆ $extFileResourceExtensions

◆ $includeExtFileResources

◆ $levels

◆ $list

◆ $mode

◆ $notes

◆ $pageInWebMountCache

◆ $record