Documentation TYPO3 par Ameos

tx_impexp Class Reference

List of all members.

Public Member Functions

 init ($dontCompress=0, $mode='')
 setHeaderBasics ()
 setCharset ($charset)
 setMetaData ($title, $description, $notes, $packager_username, $packager_name, $packager_email)
 addThumbnail ($imgFilepath)
 setPageTree ($idH)
 unsetExcludedSections ($idH)
 flatInversePageTree ($idH, $a=array())
 flatInversePageTree_pid ($idH, $a=array(), $pid=-1)
 export_addRecord ($table, $row, $relationLevel=0)
 export_addDBRelations ($relationLevel=0)
 export_addDBRelations_registerRelation ($fI, &$addR, $tokenID='')
 export_addFilesFromRelations ()
 export_addFile ($fI, $recordRef='', $fieldname='')
 getRelations ($table, $row)
 getRelations_flexFormCallBack ($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2, $structurePath)
 getRelations_procFiles ($value, $conf, $uid)
 getRelations_procDB ($value, $conf, $uid)
 flatDBrels ($dbrels)
 flatSoftRefs ($dbrels)
 destPathFromUploadFolder ($folder)
 compileMemoryToFileContent ($type='')
 createXML ()
 doOutputCompress ()
 addFilePart ($data, $compress=FALSE)
 importData ($pid)
 writeRecords_pages ($pid)
 writeRecords_pages_order ($pid)
 writeRecords_records ($pid)
 writeRecords_records_order ($mainPid)
 addSingle ($table, $uid, $pid)
 addToMapId ($substNEWwithIDs)
 getNewTCE ()
 unlinkTempFiles ()
 setRelations ()
 setRelations_db ($itemArray)
 import_addFileNameToBeCopied ($fI)
 setFlexFormRelations ()
 remapListedDBRecords_flexFormCallBack ($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2, $path)
 processSoftReferences ()
 processSoftReferences_flexFormCallBack ($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2, $path)
 processSoftReferences_substTokens ($tokenizedContent, $softRefCfgs, $table, $uid)
 processSoftReferences_saveFile ($relFileName, $cfg, $table, $uid)
 processSoftReferences_saveFile_createRelFile ($origDirPrefix, $fileName, $fileID, $table, $uid)
 writeFileVerify ($fileName, $fileID, $bypassMountCheck=FALSE)
 checkOrCreateDir ($dirPrefix)
 verifyFolderAccess ($dirPrefix, $noAlternative=FALSE)
 loadFile ($filename, $all=0)
 getNextFilePart ($fd, $unserialize=0, $name='')
 loadContent ($filecontent)
 getNextContentPart ($filecontent, &$pointer, $unserialize=0, $name='')
 loadInit ()
 fixCharsets ()
 displayContentOverview ()
 traversePageTree ($pT, &$lines, $preCode='')
 traversePageRecords ($pT, &$lines)
 traverseAllRecords ($pT, &$lines)
 singleRecordLines ($table, $uid, &$lines, $preCode, $checkImportInPidRecord=0)
 addRelations ($rels, &$lines, $preCode, $recurCheck=array(), $htmlColorClass='')
 addFiles ($rels, &$lines, $preCode, $htmlColorClass='', $tokenID='')
 checkDokType ($checkTable, $doktype)
 renderControls ($r)
 softrefSelector ($cfg)
 isTableStatic ($table)
 inclRelation ($table)
 isExcluded ($table, $uid)
 includeSoftref ($tokenID)
 isReferenceField ($conf)
 checkPID ($pid)
 dontIgnorePid ($table, $uid)
 doesRecordExist ($table, $uid, $fields='')
 getRecordPath ($pid)
 renderSelectBox ($prefix, $value, $optValues)
 compareRecords ($databaseRecord, $importRecord, $table, $inverseDiff=FALSE)
 getRTEoriginalFilename ($string)
getFileProcObj ()
 error ($msg)
 printErrorLog ()

Public Attributes

 $showStaticRelations = FALSE
 $fileadminFolderName = 'fileadmin'
 $mode = ''
 $update = FALSE
 $doesImport = FALSE
 $display_import_pid_record = ''
 $suggestedInsertUids = array()
 $import_mode = array()
 $global_ignore_pid = FALSE
 $force_all_UIDS = FALSE
 $showDiff = FALSE
 $allowPHPScripts = FALSE
 $enableLogging = FALSE
 $softrefInputValues = array()
 $fileIDMap = array()
 $maxFileSize = 1000000
 $maxRecordSize = 1000000
 $maxExportSize = 10000000
 $relOnlyTables = array()
 $relStaticTables = array()
 $excludeMap = array()
 $softrefCfg = array()
 $extensionDependencies = array()
 $dontCompress = 0
 $includeExtFileResources = 0
 $extFileResourceExtensions = 'html,htm,css'
 $import_mapId = array()
 $import_newId = array()
 $import_newId_pids = array()
 $import_data = array()
 $errorLog = array()
 $cache_getRecordPath = array()
 $checkPID_cache = array()
 $compress = 0
 $dat = array()
 $fileProcObj = ''

Detailed Description

Definition at line 202 of file class.tx_impexp.php.


Member Function Documentation

tx_impexp::addFilePart data,
compress = FALSE
 

Returns a content part for a filename being build.

Parameters:
array Data to store in part
boolean Compress file?
Returns:
string Content stream.

Definition at line 1352 of file class.tx_impexp.php.

tx_impexp::addFiles rels,
&$  lines,
preCode,
htmlColorClass = '',
tokenID = ''
 

Add file relation entries for a record's rels-array

Parameters:
array Array of file IDs
array Output lines array (is passed by reference and modified)
string Pre-HTML code
string Alternative HTML color class to use.
string Token ID if this is a softreference (in which case it only makes sense with a single element in the $rels array!)
Returns:
void private
See also:
singleRecordLines()

Definition at line 3045 of file class.tx_impexp.php.

References t3lib_div::split_fileref().

tx_impexp::addRelations rels,
&$  lines,
preCode,
recurCheck = array(),
htmlColorClass = ''
 

Add DB relations entries for a record's rels-array

Parameters:
array Array of relations
array Output lines array (is passed by reference and modified)
string Pre-HTML code
array Recursivity check stack
string Alternative HTML color class to use.
Returns:
void private
See also:
singleRecordLines()

Definition at line 2980 of file class.tx_impexp.php.

tx_impexp::addSingle table,
uid,
pid
 

Adds a single record to the $importData array. Also copies files to tempfolder. However all File/DB-references and flexform field contents are set to blank for now! That is done with setRelations() later

Parameters:
string Table name (from import memory)
integer Record UID (from import memory)
integer Page id
Returns:
void
See also:
writeRecords()

Definition at line 1618 of file class.tx_impexp.php.

tx_impexp::addThumbnail imgFilepath  ) 
 

Sets a thumbnail image to the exported file

Parameters:
string Filename reference, gif, jpg, png. Absolute path.
Returns:
void

Definition at line 355 of file class.tx_impexp.php.

tx_impexp::addToMapId substNEWwithIDs  ) 
 

Registers the substNEWids in memory.

Parameters:
array $substNEWwithIDs from tcemain to be merged into internal mapping variable in this object
Returns:
void
See also:
writeRecords()

Definition at line 1692 of file class.tx_impexp.php.

References error().

tx_impexp::checkDokType checkTable,
doktype
 

Verifies that a table is allowed on a certain doktype of a page

Parameters:
string Table name to check
integer doktype value.
Returns:
boolean True if OK

Definition at line 3163 of file class.tx_impexp.php.

References t3lib_div::trimExplode().

tx_impexp::checkOrCreateDir dirPrefix  ) 
 

Returns true if directory exists and if it doesn't it will create directory and return true if that succeeded.

Parameters:
string Directory to create. Having a trailing slash. Must be in fileadmin/. Relative to PATH_site
Returns:
boolean True, if directory exists (was created)

Definition at line 2364 of file class.tx_impexp.php.

References error(), t3lib_div::getFileAbsFileName(), and t3lib_div::mkdir().

Referenced by processSoftReferences_saveFile_createRelFile().

tx_impexp::checkPID pid  ) 
 

Checking if a PID is in the webmounts of the user

Parameters:
integer Page ID to check
Returns:
boolean True if OK

Definition at line 3344 of file class.tx_impexp.php.

Referenced by export_addRecord().

tx_impexp::compareRecords databaseRecord,
importRecord,
table,
inverseDiff = FALSE
 

Compares two records, the current database record and the one from the import memory. Will return HTML code to show any differences between them!

Parameters:
array Database record, all fields (new values)
array Import memorys record for the same table/uid, all fields (old values)
string The table name of the record
boolean Inverse the diff view (switch red/green, needed for pre-update difference view)
Returns:
string HTML

Definition at line 3425 of file class.tx_impexp.php.

References t3lib_BEfunc::getProcessedValue(), and t3lib_div::makeInstance().

tx_impexp::compileMemoryToFileContent type = ''  ) 
 

This compiles and returns the data content for an exported file

Parameters:
string Type of output; "xml" gives xml, otherwise serialized array, possibly compressed.
Returns:
string The output file stream

Definition at line 1223 of file class.tx_impexp.php.

tx_impexp::createXML  ) 
 

Creates XML string from input array

Returns:
string XML content

Definition at line 1249 of file class.tx_impexp.php.

tx_impexp::destPathFromUploadFolder folder  ) 
 

Returns destination path to an upload folder given by $folder

Parameters:
string Folder relative to PATH_site
Returns:
string Input folder prefixed with PATH_site. No checking for existence is done. Output must be a folder without trailing slash.

Definition at line 1198 of file class.tx_impexp.php.

tx_impexp::displayContentOverview  ) 
 

Displays an overview of the header-content.

Returns:
string HTML content

Definition at line 2631 of file class.tx_impexp.php.

References t3lib_extMgm::isLoaded().

tx_impexp::doesRecordExist table,
uid,
fields = ''
 

Checks if the record exists

Parameters:
string Table name
integer UID of record
string Field list to select. Default is "uid,pid"
Returns:
array Result of t3lib_BEfunc::getRecord() which means the record if found, otherwise false

Definition at line 3374 of file class.tx_impexp.php.

References t3lib_BEfunc::getRecord().

tx_impexp::dontIgnorePid table,
uid
 

Checks if the position of an updated record is configured to be corrected. This can be disabled globally and changed for elements individually.

Parameters:
string Table name
integer Uid or record
Returns:
boolean True if the position of the record should be updated to match the one in the import structure

Definition at line 3361 of file class.tx_impexp.php.

tx_impexp::doOutputCompress  ) 
 

Returns true if the output should be compressed.

Returns:
boolean True if compression is possible AND requested.

Definition at line 1341 of file class.tx_impexp.php.

tx_impexp::error msg  ) 
 

Sets error message in the internal error log

Parameters:
string Error message
Returns:
void

Definition at line 3542 of file class.tx_impexp.php.

Referenced by addToMapId(), checkOrCreateDir(), export_addDBRelations(), export_addFile(), export_addFilesFromRelations(), export_addRecord(), fixCharsets(), getNextContentPart(), getNextFilePart(), import_addFileNameToBeCopied(), loadFile(), processSoftReferences_saveFile(), processSoftReferences_saveFile_createRelFile(), setFlexFormRelations(), setRelations(), setRelations_db(), unlinkTempFiles(), and writeFileVerify().

tx_impexp::export_addDBRelations relationLevel = 0  ) 
 

This analyses 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 an empty array. In principle it should not allow to infinite recursivity, but you better set a limit... Call this BEFORE the ext_addFilesFromRelations (so files from added relations are also included of course)

Parameters:
integer Recursion level
Returns:
array overview of relations found and added: Keys [table]:[uid], values array with table and id
See also:
export_addFilesFromRelations()

Definition at line 540 of file class.tx_impexp.php.

References error(), export_addDBRelations_registerRelation(), export_addRecord(), t3lib_BEfunc::getRecord(), and includeSoftref().

tx_impexp::export_addDBRelations_registerRelation fI,
&$  addR,
tokenID = ''
 

Helper function for export_addDBRelations()

Parameters:
array Array with table/id keys to add
array Add array, passed by reference to be modified
string Softref Token ID, if applicable.
Returns:
void
See also:
export_addDBRelations()

Definition at line 644 of file class.tx_impexp.php.

References inclRelation(), includeSoftref(), isExcluded(), and isTableStatic().

Referenced by export_addDBRelations().

tx_impexp::export_addFile fI,
recordRef = '',
fieldname = ''
 

Adds a files content to the export memory

Parameters:
array 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 If the file is related to a record, this is the id on the form [table]:[id]. Information purposes only.
string If the file is related to a record, this is the field name it was related to. Information purposes only.
Returns:
void

Definition at line 769 of file class.tx_impexp.php.

References error(), getRTEoriginalFilename(), and t3lib_div::inList().

Referenced by export_addFilesFromRelations().

tx_impexp::export_addFilesFromRelations  ) 
 

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

Returns:
void
See also:
export_addDBRelations()

Definition at line 668 of file class.tx_impexp.php.

References error(), export_addFile(), t3lib_div::getFileAbsFileName(), and includeSoftref().

tx_impexp::export_addRecord table,
row,
relationLevel = 0
 

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

Parameters:
string Table name
array Record row.
integer (Internal) if the record is added as a relation, this is set to the "level" it was on.
Returns:
void

Definition at line 490 of file class.tx_impexp.php.

References checkPID(), error(), t3lib_div::fixed_lgd_cs(), flatDBrels(), flatSoftRefs(), t3lib_div::formatSize(), t3lib_BEfunc::getRecordTitle(), and getRelations().

Referenced by export_addDBRelations().

tx_impexp::fixCharsets  ) 
 

Fix charset of import memory if different from system charset

Returns:
void
See also:
loadInit()

Definition at line 2576 of file class.tx_impexp.php.

References error().

Referenced by loadInit().

tx_impexp::flatDBrels dbrels  ) 
 

DB relations flattend to 1-dim array. The list will be unique, no table/uid combination will appear twice.

Parameters:
array 2-dim Array of database relations organized by table key
Returns:
array 1-dim array where entries are table:uid and keys are array with table/id

Definition at line 1124 of file class.tx_impexp.php.

Referenced by export_addRecord().

tx_impexp::flatInversePageTree idH,
a = array()
 

Recursively flattening the idH array (for setPageTree() function)

Parameters:
array Page uid hierarchy
array Accumulation array of pages (internal, don't set from outside)
Returns:
array Array with uid-uid pairs for all pages in the page tree.
See also:
flatInversePageTree_pid()

Definition at line 428 of file class.tx_impexp.php.

Referenced by setPageTree().

tx_impexp::flatInversePageTree_pid idH,
a = array(),
pid = -1
 

Recursively flattening the idH array (for setPageTree() function), setting PIDs as values

Parameters:
array Page uid hierarchy
array Accumulation array of pages (internal, don't set from outside)
integer PID value (internal)
Returns:
array Array with uid-pid pairs for all pages in the page tree.
See also:
flatInversePageTree()

Definition at line 451 of file class.tx_impexp.php.

tx_impexp::flatSoftRefs dbrels  ) 
 

Soft References flattend to 1-dim array.

Parameters:
array 2-dim Array of database relations organized by table key
Returns:
array 1-dim 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 1150 of file class.tx_impexp.php.

Referenced by export_addRecord().

& tx_impexp::getFileProcObj  ) 
 

Returns file processing object, initialized only once.

Returns:
object File processor object

Definition at line 3509 of file class.tx_impexp.php.

References t3lib_div::makeInstance().

Referenced by processSoftReferences_saveFile(), processSoftReferences_saveFile_createRelFile(), verifyFolderAccess(), and writeFileVerify().

tx_impexp::getNewTCE  ) 
 

Returns a new $TCE object

Returns:
object $TCE object

Definition at line 1712 of file class.tx_impexp.php.

References t3lib_div::makeInstance().

Referenced by processSoftReferences(), setFlexFormRelations(), and setRelations().

tx_impexp::getNextContentPart filecontent,
&$  pointer,
unserialize = 0,
name = ''
 

Returns the next content part from the $filecontent

Parameters:
string File content string
integer File pointer (where to read from)
boolean If set, the returned content is unserialized into an array, otherwise you get the raw string
string For error messages this indicates the section of the problem.
Returns:
string Data string

Definition at line 2535 of file class.tx_impexp.php.

References error().

Referenced by loadContent().

tx_impexp::getNextFilePart fd,
unserialize = 0,
name = ''
 

Returns the next content part form the fileresource (t3d), $fd

Parameters:
pointer File pointer
boolean If set, the returned content is unserialized into an array, otherwise you get the raw string
string For error messages this indicates the section of the problem.
Returns:
string Data string private
See also:
loadFile()

Definition at line 2490 of file class.tx_impexp.php.

References error().

Referenced by loadFile().

tx_impexp::getRecordPath pid  ) 
 

Returns the page title path of a PID value. Results are cached internally

Parameters:
integer Record PID to check
Returns:
string The path for the input PID

Definition at line 3384 of file class.tx_impexp.php.

References t3lib_BEfunc::getRecordPath().

tx_impexp::getRelations table,
row
 

Returns relation information for a $table/$row-array Traverses all fields in input row which are configured in TCA/columns It looks for hard relations to files and records in the TCA types "select" and "group"

Parameters:
string Table
array Row from table
Returns:
array Array with information about relations
See also:
export_addRecord()

Definition at line 897 of file class.tx_impexp.php.

Referenced by export_addRecord().

tx_impexp::getRelations_flexFormCallBack pParams,
dsConf,
dataValue,
dataValue_ext1,
dataValue_ext2,
structurePath
 

Callback function for traversing the FlexForm structure in relation to finding file and DB references!

Parameters:
array Array of parameters in num-indexes: table, uid, field
array TCA field configuration (from Data Structure XML)
string The value of the flexForm field
string Not used.
string Not used.
string Path of where in the data structure this element is.
Returns:
array Result array with key "value" containing the value of the processing.
See also:
t3lib_TCEmain::checkValue_flex_procInData_travDS()

Definition at line 1004 of file class.tx_impexp.php.

tx_impexp::getRelations_procDB value,
conf,
uid
 

Check field configuration if it is a DB relation field and extract DB relations if any

Parameters:
string Field value
array Field configuration array of type "TCA/columns"
integer Field uid
Returns:
array If field type is OK it will return an array with the database relations. Else false

Definition at line 1103 of file class.tx_impexp.php.

tx_impexp::getRelations_procFiles value,
conf,
uid
 

Check field configuration if it is a file relation field and extract file relations if any

Parameters:
string Field value
array Field configuration array of type "TCA/columns"
integer Field uid
Returns:
array If field type is OK it will return an array with the files inside. Else false

Definition at line 1053 of file class.tx_impexp.php.

tx_impexp::getRTEoriginalFilename string  ) 
 

Creates the original file name for a copy-RTE image (magic type)

Parameters:
string RTE copy filename, eg. "RTEmagicC_user_pm_icon_01.gif.gif"
Returns:
string RTE original filename, eg. "RTEmagicP_user_pm_icon_01.gif". IF the input filename was NOT prefixed RTEmagicC_ as RTE images would be, nothing is returned!

Definition at line 3492 of file class.tx_impexp.php.

References t3lib_div::isFirstPartOfStr().

Referenced by export_addFile(), and processSoftReferences_saveFile().

tx_impexp::import_addFileNameToBeCopied fI  ) 
 

Writes the file from import array to temp dir and returns the filename of it.

Parameters:
array 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"
Returns:
string Absolute filename of the temporary filename of the file. In ->alternativeFileName the original name is set.

Definition at line 1845 of file class.tx_impexp.php.

References error(), t3lib_div::tempnam(), and t3lib_div::writeFile().

Referenced by remapListedDBRecords_flexFormCallBack(), and setRelations().

tx_impexp::importData pid  ) 
 

Imports the internal data array to $pid.

Parameters:
integer Page ID in which to import the content
Returns:
void ...

Definition at line 1385 of file class.tx_impexp.php.

tx_impexp::inclRelation table  ) 
 

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

Parameters:
string Table name
Returns:
boolean True, if table is marked static

Definition at line 3297 of file class.tx_impexp.php.

Referenced by export_addDBRelations_registerRelation().

tx_impexp::includeSoftref tokenID  ) 
 

Returns true if soft reference should be included in exported file.

Parameters:
string Token ID for soft reference
Returns:
boolean True if softreference media should be included

Definition at line 3324 of file class.tx_impexp.php.

References t3lib_div::inList().

Referenced by export_addDBRelations(), export_addDBRelations_registerRelation(), and export_addFilesFromRelations().

tx_impexp::init dontCompress = 0,
mode = ''
 

Init the object, both import and export

Parameters:
boolean If set, compression in t3d files is disabled
string Mode of usage, either "import" or "export"
Returns:
void

Definition at line 265 of file class.tx_impexp.php.

References $dontCompress, and $mode.

tx_impexp::isExcluded table,
uid
 

Returns true if the element should be excluded as static record.

Parameters:
string Table name
integer UID value
Returns:
boolean True, if table is marked static

Definition at line 3312 of file class.tx_impexp.php.

Referenced by export_addDBRelations_registerRelation(), and setRelations_db().

tx_impexp::isReferenceField conf  ) 
 

Returns true if the TCA/columns field type is a DB reference field

Parameters:
array config array for TCA/columns field
Returns:
boolean True if DB reference field (group/db or select with foreign-table)

Definition at line 3334 of file class.tx_impexp.php.

tx_impexp::isTableStatic table  ) 
 

Returns true if the input table name is to be regarded as a static relation (that is, not exported etc).

Parameters:
string Table name
Returns:
boolean True, if table is marked static

Definition at line 3283 of file class.tx_impexp.php.

Referenced by export_addDBRelations_registerRelation(), and setRelations_db().

tx_impexp::loadContent filecontent  ) 
 

Loads T3D file content into the $this->dat array (This function can be used to test the output strings from ->compileMemoryToFileContent())

Parameters:
string File content
Returns:
void

Definition at line 2517 of file class.tx_impexp.php.

References getNextContentPart(), and loadInit().

tx_impexp::loadFile filename,
all = 0
 

Loads the header section/all of the $filename into memory

Parameters:
string Filename, absolute
boolean If set, all information is loaded (header, records and files). Otherwise the default is to read only the header information
Returns:
boolean True if the operation went well

Definition at line 2447 of file class.tx_impexp.php.

References error(), getNextFilePart(), loadInit(), and t3lib_div::xml2array().

tx_impexp::loadInit  ) 
 

Setting up the object based on the recently loaded ->dat array

Returns:
void

Definition at line 2560 of file class.tx_impexp.php.

References fixCharsets().

Referenced by loadContent(), and loadFile().

tx_impexp::printErrorLog  ) 
 

Returns a table with the error-messages.

Returns:
string HTML print of error log

Definition at line 3551 of file class.tx_impexp.php.

References t3lib_div::view_array().

tx_impexp::processSoftReferences  ) 
 

Processing of soft references

Returns:
void

Definition at line 1993 of file class.tx_impexp.php.

References t3lib_BEfunc::getFlexFormDS(), getNewTCE(), t3lib_BEfunc::getRecord(), t3lib_div::loadTCA(), t3lib_div::makeInstance(), processSoftReferences_flexFormCallBack(), processSoftReferences_substTokens(), and t3lib_div::xml2array().

tx_impexp::processSoftReferences_flexFormCallBack pParams,
dsConf,
dataValue,
dataValue_ext1,
dataValue_ext2,
path
 

Callback function for traversing the FlexForm structure in relation to remapping softreference relations

Parameters:
array Set of parameters in numeric array: table, uid, field
array TCA config for field (from Data Structure of course)
string Field value (from FlexForm XML)
string Not used
string Not used
string Path of where the data structure where the element is found
Returns:
array Array where the "value" key carries the value.
See also:
setFlexFormRelations()

Definition at line 2084 of file class.tx_impexp.php.

References processSoftReferences_substTokens().

Referenced by processSoftReferences().

tx_impexp::processSoftReferences_saveFile relFileName,
cfg,
table,
uid
 

Process a soft reference file

Parameters:
string Old Relative filename
array soft reference configuration array
string Table for which the processing occurs
string UID of record from table
Returns:
string New relative filename (value to insert instead of the softref token)

Definition at line 2187 of file class.tx_impexp.php.

References $fileProcObj, error(), t3lib_div::getFileAbsFileName(), getFileProcObj(), getRTEoriginalFilename(), t3lib_div::isFirstPartOfStr(), processSoftReferences_saveFile_createRelFile(), and writeFileVerify().

Referenced by processSoftReferences_substTokens().

tx_impexp::processSoftReferences_saveFile_createRelFile origDirPrefix,
fileName,
fileID,
table,
uid
 

Create file in directory and return the new (unique) filename

Parameters:
string Directory prefix, relative, with trailing slash
string Filename (without path)
string File ID from import memory
string Table for which the processing occurs
string UID of record from table
Returns:
string New relative filename, if any

Definition at line 2248 of file class.tx_impexp.php.

References $fileProcObj, checkOrCreateDir(), error(), t3lib_div::getFileAbsFileName(), getFileProcObj(), t3lib_div::isFirstPartOfStr(), t3lib_div::mkdir(), t3lib_div::resolveBackPath(), verifyFolderAccess(), t3lib_div::writeFile(), and writeFileVerify().

Referenced by processSoftReferences_saveFile().

tx_impexp::processSoftReferences_substTokens tokenizedContent,
softRefCfgs,
table,
uid
 

Substition of softreference tokens

Parameters:
string Content of field with soft reference tokens in.
array Soft reference configurations
string Table for which the processing occurs
string UID of record from table
Returns:
string The input content with tokens substituted according to entries in softRefCfgs

Definition at line 2123 of file class.tx_impexp.php.

References t3lib_BEfunc::getRecord(), processSoftReferences_saveFile(), and t3lib_div::testInt().

Referenced by processSoftReferences(), and processSoftReferences_flexFormCallBack().

tx_impexp::remapListedDBRecords_flexFormCallBack pParams,
dsConf,
dataValue,
dataValue_ext1,
dataValue_ext2,
path
 

Callback function for traversing the FlexForm structure in relation to remapping database relations

Parameters:
array Set of parameters in numeric array: table, uid, field
array TCA config for field (from Data Structure of course)
string Field value (from FlexForm XML)
string Not used
string Not used
string Path of where the data structure of the element is found
Returns:
array Array where the "value" key carries the value.
See also:
setFlexFormRelations()

Definition at line 1951 of file class.tx_impexp.php.

References import_addFileNameToBeCopied(), and setRelations_db().

Referenced by setFlexFormRelations().

tx_impexp::renderControls r  ) 
 

Render input controls for import or export

Parameters:
array Configuration for element
boolean Set if export situation
Returns:
string HTML

Definition at line 3179 of file class.tx_impexp.php.

tx_impexp::renderSelectBox prefix,
value,
optValues
 

Makes a selector-box from optValues

Parameters:
string Form element name
string Current value
array Options to display (key/value pairs)
Returns:
string HTML select element

Definition at line 3401 of file class.tx_impexp.php.

tx_impexp::setCharset charset  ) 
 

Set charset

Parameters:
string Charset for the content in the export. During import the character set will be converted if the target system uses another charset.
Returns:
void

Definition at line 320 of file class.tx_impexp.php.

tx_impexp::setFlexFormRelations  ) 
 

After all DB relations has been set in the end of the import (see setRelations()) then it is time to correct all relations inside of FlexForm fields. The reason for doing this after is that the setting of relations may affect (quite often!) which data structure is used for the flexforms field!

Returns:
void
See also:
setRelations()

Definition at line 1868 of file class.tx_impexp.php.

References $dat, error(), t3lib_BEfunc::getFlexFormDS(), getNewTCE(), t3lib_BEfunc::getRecord(), t3lib_div::loadTCA(), t3lib_div::makeInstance(), remapListedDBRecords_flexFormCallBack(), and t3lib_div::xml2array().

tx_impexp::setHeaderBasics  ) 
 

Set header basics

Returns:
void

Definition at line 296 of file class.tx_impexp.php.

tx_impexp::setMetaData title,
description,
notes,
packager_username,
packager_name,
packager_email
 

Sets meta data

Parameters:
string Title of the export
string Description of the export
string Notes about the contents
string Backend Username of the packager (the guy making the export)
string Real name of the packager
string Email of the packager
Returns:
void

Definition at line 335 of file class.tx_impexp.php.

tx_impexp::setPageTree idH  ) 
 

Sets the page-tree array in the export header and returns the array in a flattened version

Parameters:
array Hierarchy of ids, the page tree: array([uid] => array("uid" => [uid], "subrow" => array(.....)), [uid] => ....)
Returns:
array The hierarchical page tree converted to a one-dimensional list of pages

Definition at line 393 of file class.tx_impexp.php.

References flatInversePageTree(), and unsetExcludedSections().

tx_impexp::setRelations  ) 
 

At the end of the import process all file and DB relations should be set properly (that is relations to imported records are all re-created so imported records are correctly related again) Relations in flexform fields are processed in setFlexFormRelations() after this function

Returns:
void
See also:
setFlexFormRelations()

Definition at line 1764 of file class.tx_impexp.php.

References $dat, error(), getNewTCE(), import_addFileNameToBeCopied(), and setRelations_db().

tx_impexp::setRelations_db itemArray  ) 
 

Maps relations for database

Parameters:
array Array of item sets (table/uid) from a dbAnalysis object
Returns:
array Array with values [table]_[uid]. These values have the regular tcemain-input group/select type which means they will automatically be processed into a uid-list or MM relations.

Definition at line 1818 of file class.tx_impexp.php.

References error(), isExcluded(), and isTableStatic().

Referenced by remapListedDBRecords_flexFormCallBack(), and setRelations().

tx_impexp::singleRecordLines table,
uid,
&$  lines,
preCode,
checkImportInPidRecord = 0
 

Add entries for a single record

Parameters:
string Table name
integer Record uid
array Output lines array (is passed by reference and modified)
string Pre-HTML code
boolean If you want import validation, you can set this so it checks if the import can take place on the specified page.
Returns:
void

Definition at line 2823 of file class.tx_impexp.php.

References t3lib_div::fixed_lgd_cs(), and t3lib_div::inList().

tx_impexp::softrefSelector cfg  ) 
 

Selectorbox with export options for soft references

Parameters:
array softref configuration array. An export box is shown only if a substitution scheme is found for the soft reference.
Returns:
string Selector box HTML

Definition at line 3207 of file class.tx_impexp.php.

tx_impexp::traverseAllRecords pT,
&$  lines
 

Go through ALL records (if the pages are displayed first, those will not be amoung these!)

Parameters:
array Page tree array with uid/subrow (from ->dat[header][pagetree]
array Output lines array (is passed by reference and modified)
Returns:
void

Definition at line 2801 of file class.tx_impexp.php.

tx_impexp::traversePageRecords pT,
&$  lines
 

Go through remaining pages (not in tree)

Parameters:
array Page tree array with uid/subrow (from ->dat[header][pagetree]
array Output lines array (is passed by reference and modified)
Returns:
void

Definition at line 2774 of file class.tx_impexp.php.

tx_impexp::traversePageTree pT,
&$  lines,
preCode = ''
 

Go through page tree for display

Parameters:
array Page tree array with uid/subrow (from ->dat[header][pagetree]
array Output lines array (is passed by reference and modified)
string Pre-HTML code
Returns:
void

Definition at line 2739 of file class.tx_impexp.php.

tx_impexp::unlinkTempFiles  ) 
 

Cleaning up all the temporary files stored in typo3temp/ folder

Returns:
void

Definition at line 1726 of file class.tx_impexp.php.

References error(), t3lib_div::isFirstPartOfStr(), and t3lib_div::unlink_tempfile().

tx_impexp::unsetExcludedSections idH  ) 
 

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

Parameters:
array Page uid hierarchy
Returns:
array Modified input array private
See also:
setPageTree()

Definition at line 406 of file class.tx_impexp.php.

Referenced by setPageTree().

tx_impexp::verifyFolderAccess dirPrefix,
noAlternative = FALSE
 

Verifies that the input path (relative to PATH_site) is found in the backend users filemounts. If it doesn't it will try to find another relative filemount for the user and return an alternative path prefix for the file.

Parameters:
string Path relative to PATH_site
boolean If set, Do not look for alternative path! Just return false
Returns:
string If a path is available that will be returned, otherwise false.

Definition at line 2397 of file class.tx_impexp.php.

References $fileProcObj, getFileProcObj(), and t3lib_div::isFirstPartOfStr().

Referenced by processSoftReferences_saveFile_createRelFile().

tx_impexp::writeFileVerify fileName,
fileID,
bypassMountCheck = FALSE
 

Writes a file from the import memory having $fileID to file name $fileName which must be an absolute path inside PATH_site

Parameters:
string Absolute filename inside PATH_site to write to
string File ID from import memory
boolean Bypasses the checking against filemounts - only for RTE files!
Returns:
boolean Returns true if it went well. Notice that the content of the file is read again, and md5 from import memory is validated.

Definition at line 2337 of file class.tx_impexp.php.

References $fileProcObj, error(), t3lib_div::getFileAbsFileName(), getFileProcObj(), t3lib_div::split_fileref(), and t3lib_div::writeFile().

Referenced by processSoftReferences_saveFile(), and processSoftReferences_saveFile_createRelFile().

tx_impexp::writeRecords_pages pid  ) 
 

Writing pagetree/pages to database:

Parameters:
integer PID in which to import. If the operation is an update operation, the root of the page tree inside will be moved to this PID unless it is the same as the root page from the import
Returns:
void
See also:
writeRecords_records()

Definition at line 1426 of file class.tx_impexp.php.

tx_impexp::writeRecords_pages_order pid  ) 
 

Organize all updated pages in page tree so they are related like in the import file Only used for updates and when $this->dat['header']['pagetree'] is an array.

Parameters:
integer Page id in which to import
Returns:
void private
See also:
writeRecords_pages(), writeRecords_records_order()

Definition at line 1481 of file class.tx_impexp.php.

tx_impexp::writeRecords_records pid  ) 
 

Write all database records except pages (writtein in writeRecords_pages())

Parameters:
integer Page id in which to import
Returns:
void
See also:
writeRecords_pages()

Definition at line 1519 of file class.tx_impexp.php.

tx_impexp::writeRecords_records_order mainPid  ) 
 

Organize all updated record to their new positions. Only used for updates

Parameters:
integer Main PID into which we import.
Returns:
void private
See also:
writeRecords_records(), writeRecords_pages_order()

Definition at line 1569 of file class.tx_impexp.php.


The documentation for this class was generated from the following file:


Généré par TYPO3 Ameos avec  doxygen 1.4.6