Documentation TYPO3 par Ameos

SC_mod_tools_em_index Class Reference

Inheritance diagram for SC_mod_tools_em_index:

Inheritance graph
[legend]
Collaboration diagram for SC_mod_tools_em_index:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 init ()
 handleExternalFunctionValue ($MM_key='function', $MS_value=NULL)
 menuConfig ()
 main ()
 printContent ()
 extensionList_loaded ()
 extensionList_installed ()
 extensionList_import ()
 alterSettings ()
 importExtInfo ($extRepUid)
 importExtFromRep ($extRepUid, $loc, $uploadFlag=0, $directInput='', $recentTranslations=0, $incManual=0)
 showExtDetails ($extKey)
 updatesForm ($extKey, $extInfo, $notSilent=0, $script='', $addFields='')
 extDumpTables ($extKey, $extInfo)
 getFileListOfExtension ($extKey, $conf)
 extDelete ($extKey, $extInfo)
 extUpdateEMCONF ($extKey, $extInfo)
 extBackup ($extKey, $extInfo)
 extBackup_dumpDataTablesLine ($tablesArray, $extKey)
 extInformationArray ($extKey, $extInfo, $remote=0)
 extInformationArray_dbReq ($techInfo, $tableHeader=0)
 extInformationArray_dbInst ($dbInst, $current)
 getRepositoryUploadForm ($extKey, $extInfo)
 extensionListRowHeader ($trAttrib, $cells, $import=0)
 extensionListRow ($extKey, $extInfo, $cells, $bgColorClass='', $inst_list=array(), $import=0, $altLinkUrl='')
 wrapEmail ($str, $email)
 helpCol ($key)
 labelInfo ($str)
 extensionTitleIconHeader ($extKey, $extInfo, $align='top')
 removeButton ()
 installButton ()
 noImportMsg ()
 getInstalledExtensions ()
 getInstExtList ($path, &$list, &$cat, $type)
 getImportExtList ($listArr)
 setCat (&$cat, $listArrayPart, $extKey)
 makeDetailedExtensionAnalysis ($extKey, $extInfo, $validity=0)
 getClassIndexLocallangFiles ($absPath, $table_class_prefix, $extKey)
 modConfFileAnalysis ($confFilePath)
 serverExtensionMD5Array ($extKey, $conf)
 findMD5ArrayDiff ($current, $past)
 createDirsInPath ($dirs, $extDirPath)
 removeExtDirectory ($removePath, $removeContentOnly=0)
 clearAndMakeExtensionDir ($importedData, $type)
 removeCacheFiles ()
 extractDirsFromFileList ($files)
 getExtPath ($extKey, $type)
 writeTYPO3_MOD_PATH ($confFilePath, $type, $mP)
 writeNewExtensionList ($newExtList)
 writeTsStyleConfig ($extKey, $arr)
 updateLocalEM_CONF ($extKey, $extInfo)
 construct_ext_emconf_file ($extKey, $EM_CONF)
 makeUploadArray ($extKey, $conf)
 getSerializedLocalLang ($file, $content)
 addExtToList ($extKey, $instExtInfo)
 removeExtFromList ($extKey, $instExtInfo)
 removeRequiredExtFromListArr ($listArr)
 managesPriorities ($listArr, $instExtInfo)
 checkClearCache ($extKey, $extInfo)
 checkUploadFolder ($extKey, $extInfo)
 checkDBupdates ($extKey, $extInfo, $infoOnly=0)
 tsStyleConfigForm ($extKey, $extInfo, $output=0, $script='', $addFields='')
 dumpTableAndFieldStructure ($arr)
 dumpStaticTables ($tableList)
 dumpHeader ()
 dumpTableHeader ($table, $fieldKeyInfo, $dropTableIfExists=0)
 dumpTableContent ($table, $fieldStructure)
 getTableAndFieldStructure ($parts)
 fetchServerData ($repositoryUrl)
 decodeServerData ($externalData, $stat=array())
 decodeExchangeData ($str)
 makeUploadDataFromArray ($uploadArray, $local_gzcompress=-1)
 repTransferParams ()
 makeReturnUrl ()
 T3instID ()
 processRepositoryReturnData ($TER_CMD)
 listOrderTitle ($listOrder, $key)
 makeVersion ($v, $mode)
 renderVersion ($v, $raise='')
 ulFolder ($extKey)
 importAtAll ()
 importAsType ($type, $lockType='')
 deleteAsType ($type)
 getDocManual ($extension_key, $loc='')
 versionDifference ($v1, $v2, $div=1)
 first_in_array ($str, $array, $caseInsensitive=FALSE)
 includeEMCONF ($path, $_EXTKEY)

Public Attributes

 $versionDiffFactor = 1000
 $systemInstall = 0
 $repositoryUrl = ''
 $requiredExt = ''
 $maxUploadSize = 6024000
 $kbMax = 100
 $defaultCategories
 $categories
 $states
 $typeLabels
 $typeDescr
 $typePaths = Array()
 $typeBackPaths = Array()
 $typeRelPaths
 $remoteAccess
 $detailCols
 $fe_user
 $privacyNotice = 'When ever you interact with the online repository, server information is sent and stored in the repository for statistics. No personal information is sent, only identification of this TYPO3 install. If you want know exactly what is sent, look in typo3/tools/em/index.php, function repTransferParams()'
 $editTextExtensions = 'html,htm,txt,css,tmpl,inc,php,sql,conf,cnf,pl,pm,sh'
 $nameSpaceExceptions = 'beuser_tracking,design_components,impexp,static_file_edit,cms,freesite,quickhelp,classic_welcome,indexed_search,sys_action,sys_workflows,sys_todos,sys_messages,plugin_mgm,direct_mail,sys_stat,tt_address,tt_board,tt_calender,tt_guest,tt_links,tt_news,tt_poll,tt_rating,tt_products,setup,taskcenter,tsconfig_help,context_help,sys_note,tstemplate,lowlevel,install,belog,beuser,phpmyadmin,aboutmodules,imagelist,setup,taskcenter,sys_notepad,viewpage'
 $MCONF = array()
 $MOD_MENU = array()
 $MOD_SETTINGS = array()
 $doc
 $content
 $inst_keys = array()
 $gzcompress = 0
 $CMD = array()
 $listRemote

Detailed Description

Definition at line 191 of file index.php.


Member Function Documentation

SC_mod_tools_em_index::addExtToList extKey,
instExtInfo
 

Adds extension to extension list and returns new list. If -1 is returned, an error happend. Checks dependencies etc.

Parameters:
string Extension key
array Extension information array - information about installed extensions
Returns:
string New list of installed extensions or -1 if error
See also:
showExtDetails()

Definition at line 3284 of file index.php.

References t3lib_extMgm::isLoaded(), and t3lib_div::trimExplode().

Referenced by showExtDetails().

SC_mod_tools_em_index::alterSettings  ) 
 

Allows changing of settings

Returns:
void

Definition at line 868 of file index.php.

References $content, and t3lib_BEfunc::cshItem().

Referenced by main().

SC_mod_tools_em_index::checkClearCache extKey,
extInfo
 

Check if clear-cache should be performed, otherwise show form (for installation of extension) Shown only if the extension has the clearCacheOnLoad flag set.

Parameters:
string Extension key
array Extension information array
Returns:
string HTML output (if form is shown)

Definition at line 3450 of file index.php.

References t3lib_div::_POST(), and t3lib_div::makeInstance().

Referenced by showExtDetails().

SC_mod_tools_em_index::checkDBupdates extKey,
extInfo,
infoOnly = 0
 

Validates the database according to extension requirements Prints form for changes if any. If none, returns blank. If an update is ordered, empty is returned as well. DBAL compliant (based on Install Tool code)

Parameters:
string Extension key
array Extension information array
boolean If true, returns array with info.
Returns:
mixed If $infoOnly, returns array with information. Otherwise performs update.

Definition at line 3562 of file index.php.

References t3lib_div::_GP().

SC_mod_tools_em_index::checkUploadFolder extKey,
extInfo
 

Check if upload folder / "createDir" directories should be created.

Parameters:
string Extension key
array Extension information array
Returns:
string HTML content.

Definition at line 3477 of file index.php.

References t3lib_div::_POST(), t3lib_div::mkdir(), t3lib_div::trimExplode(), and t3lib_div::writeFile().

SC_mod_tools_em_index::clearAndMakeExtensionDir importedData,
type
 

Removes the current extension of $type and creates the base folder for the new one (which is going to be imported)

Parameters:
array Data for imported extension
string Extension installation scope (L,G,S)
Returns:
mixed Returns array on success (with extension directory), otherwise an error string.

Definition at line 2887 of file index.php.

References t3lib_div::mkdir().

Referenced by importExtFromRep().

SC_mod_tools_em_index::construct_ext_emconf_file extKey,
EM_CONF
 

Compiles the ext_emconf.php file

Parameters:
string Extension key
array EM_CONF array
Returns:
string PHP file content, ready to write to ext_emconf.php file

Definition at line 3138 of file index.php.

References t3lib_div::testInt().

Referenced by importExtFromRep().

SC_mod_tools_em_index::createDirsInPath dirs,
extDirPath
 

Creates directories in $extDirPath

Parameters:
array Array of directories to create relative to extDirPath, eg. "blabla", "blabla/blabla" etc...
string Absolute path to directory.
Returns:
mixed Returns false on success or an error string

Definition at line 2800 of file index.php.

References t3lib_div::mkdir(), and t3lib_div::trimExplode().

Referenced by importExtFromRep().

SC_mod_tools_em_index::decodeExchangeData str  ) 
 

Decodes extension upload array. This kind of data is when an extension is uploaded to TER

Parameters:
string Data stream
Returns:
mixed Array with result on success, otherwise an error string.

Definition at line 4005 of file index.php.

Referenced by importExtFromRep().

SC_mod_tools_em_index::decodeServerData externalData,
stat = array()
 

Decode server data This is information like the extension list, extension information etc., return data after uploads (new em_conf)

Parameters:
string Data stream from remove server
array Statistics array for request of external data
Returns:
mixed On success, returns an array with data array and stats array as key 0 and 1. Otherwise returns error string
See also:
fetchServerData(), processRepositoryReturnData()

Definition at line 3978 of file index.php.

SC_mod_tools_em_index::deleteAsType type  ) 
 

Returns true if extensions in scope, $type, can be deleted (or installed for that sake)

Parameters:
string Scope: "G" or "L"
Returns:
boolean True if possible.

Definition at line 4253 of file index.php.

SC_mod_tools_em_index::dumpHeader  ) 
 

Header comments of the SQL dump file

Returns:
string Table header

Definition at line 3809 of file index.php.

SC_mod_tools_em_index::dumpStaticTables tableList  ) 
 

Dump content for static tables

Parameters:
string Comma list of tables from which to dump content
Returns:
string Returns the content
See also:
dumpTableAndFieldStructure()

Definition at line 3780 of file index.php.

References t3lib_div::trimExplode().

SC_mod_tools_em_index::dumpTableAndFieldStructure arr  ) 
 

Makes a dump of the tables/fields definitions for an extension

Parameters:
array Array with table => field/key definition arrays in
Returns:
string SQL for the table definitions
See also:
dumpStaticTables()

Definition at line 3755 of file index.php.

SC_mod_tools_em_index::dumpTableContent table,
fieldStructure
 

Dump table content Is DBAL compliant, but the dump format is written as MySQL standard. If the INSERT statements should be imported in a DBMS using other quoting than MySQL they must first be translated. t3lib_sqlengine can parse these queries correctly and translate them somehow.

Parameters:
string Table name
array Field structure
Returns:
string SQL Content of dump (INSERT statements)

Definition at line 3865 of file index.php.

SC_mod_tools_em_index::dumpTableHeader table,
fieldKeyInfo,
dropTableIfExists = 0
 

Dump CREATE TABLE definition

Parameters:
string Table name
array Field and key information (as provided from Install Tool class!)
boolean If true, add "DROP TABLE IF EXISTS"
Returns:
string Table definition SQL

Definition at line 3826 of file index.php.

SC_mod_tools_em_index::extBackup extKey,
extInfo
 

Download extension as file / make backup

Parameters:
string Extension key
array Extension information array
Returns:
string HTML content

Definition at line 1677 of file index.php.

Referenced by showExtDetails().

SC_mod_tools_em_index::extBackup_dumpDataTablesLine tablesArray,
extKey
 

Link to dump of database tables

Parameters:
string Extension key
array Extension information array
Returns:
string HTML

Definition at line 1745 of file index.php.

SC_mod_tools_em_index::extDelete extKey,
extInfo
 

Delete extension from the file system

Parameters:
string Extension key
array Extension info array
Returns:
string Returns message string about the status of the operation

Definition at line 1626 of file index.php.

References t3lib_div::inList(), and t3lib_extMgm::isLoaded().

Referenced by showExtDetails().

SC_mod_tools_em_index::extDumpTables extKey,
extInfo
 

Creates view for dumping static tables and table/fields structures...

Parameters:
string Extension key
array Extension information array
Returns:
void

Definition at line 1508 of file index.php.

References t3lib_div::formatSize(), and t3lib_div::writeFile().

Referenced by showExtDetails().

SC_mod_tools_em_index::extensionList_import  ) 
 

Listing remote extensions from online repository

Returns:
void

Definition at line 707 of file index.php.

References $content, $repositoryUrl, t3lib_BEfunc::cshItem(), extensionListRow(), extensionListRowHeader(), fetchServerData(), getImportExtList(), getInstalledExtensions(), importAsType(), importAtAll(), importExtInfo(), t3lib_extMgm::isLoaded(), noImportMsg(), repTransferParams(), and versionDifference().

Referenced by main().

SC_mod_tools_em_index::extensionList_installed  ) 
 

Listing of available (installed) extensions

Returns:
void

Definition at line 637 of file index.php.

References $content, t3lib_BEfunc::cshItem(), extensionListRow(), extensionListRowHeader(), getInstalledExtensions(), and t3lib_extMgm::isLoaded().

Referenced by main().

SC_mod_tools_em_index::extensionList_loaded  ) 
 

Listing of loaded (installed) extensions

Returns:
void

Definition at line 599 of file index.php.

References $content, t3lib_BEfunc::cshItem(), extensionListRow(), extensionListRowHeader(), and getInstalledExtensions().

Referenced by main().

SC_mod_tools_em_index::extensionListRow extKey,
extInfo,
cells,
bgColorClass = '',
inst_list = array(),
import = 0,
altLinkUrl = ''
 

Prints a row with data for the various extension listings

Parameters:
string Extension key
array Extension information array
array Preset table cells, eg. install/uninstall icons.
string 

tag class

Parameters:
array Array with installed extension keys (as keys)
boolean If set, the list is coming from remote server.
string Alternative link URL
Returns:
string HTML

content

Definition at line 2065 of file index.php.

References t3lib_div::fixed_lgd(), t3lib_div::inList(), t3lib_extMgm::isLoaded(), t3lib_div::trimExplode(), and t3lib_div::view_array().

Referenced by extensionList_import(), extensionList_installed(), and extensionList_loaded().

SC_mod_tools_em_index::extensionListRowHeader trAttrib,
cells,
import = 0
 

Prints the header row for the various listings

Parameters:
string Attributes for the

tag

Parameters:
array Preset cells in the beginning of the row. Typically a blank cell with a clear-gif
boolean If set, the list is coming from remote server.
Returns:
string HTML

table row

Definition at line 2000 of file index.php.

Referenced by extensionList_import(), extensionList_installed(), and extensionList_loaded().

SC_mod_tools_em_index::extensionTitleIconHeader extKey,
extInfo,
align = 'top'
 

Returns a header for an extensions including icon if any

Parameters:
string Extension key
array Extension information array
string align-attribute value (for tag)
Returns:
string HTML; Extension title and image.

Definition at line 2229 of file index.php.

References t3lib_div::fixed_lgd().

Referenced by showExtDetails().

SC_mod_tools_em_index::extInformationArray extKey,
extInfo,
remote = 0
 

Prints a table with extension information in it.

Parameters:
string Extension key
array Extension information array
boolean If set, the information array shows information for a remote extension in TER, not a local one.
Returns:
string HTML content.

Definition at line 1773 of file index.php.

References t3lib_div::inList(), t3lib_extMgm::isLoaded(), and t3lib_div::view_array().

Referenced by importExtInfo(), and showExtDetails().

SC_mod_tools_em_index::extInformationArray_dbInst dbInst,
current
 

Double install warning.

Parameters:
string Double-install string, eg. "LG" etc.
string Current scope, eg. "L" or "G" or "S"
Returns:
string Message

Definition at line 1883 of file index.php.

SC_mod_tools_em_index::extInformationArray_dbReq techInfo,
tableHeader = 0
 

Returns HTML with information about database requirements

Parameters:
array Technical information array
boolean Table header displayed
Returns:
string HTML content.

Definition at line 1870 of file index.php.

SC_mod_tools_em_index::extractDirsFromFileList files  ) 
 

Extracts the directories in the $files array

Parameters:
array Array of files / directories
Returns:
array Array of directories from the input array.

Definition at line 2960 of file index.php.

Referenced by importExtFromRep().

SC_mod_tools_em_index::extUpdateEMCONF extKey,
extInfo
 

Update extension EM_CONF...

Parameters:
string Extension key
array Extension information array
Returns:
string HTML content.

Definition at line 1657 of file index.php.

Referenced by showExtDetails().

SC_mod_tools_em_index::fetchServerData repositoryUrl  ) 
 

Fetches data from the $repositoryUrl, un-compresses it, unserializes array and returns an array with the content if success.

Parameters:
string Request URL
Returns:
array Array with information and statistics.
See also:
importExtFromRep(), extensionList_import(), importExtInfo()

Definition at line 3948 of file index.php.

References t3lib_div::milliseconds().

Referenced by extensionList_import(), importExtFromRep(), and importExtInfo().

SC_mod_tools_em_index::findMD5ArrayDiff current,
past
 

Compares two arrays with MD5-hash values for analysis of which files has changed.

Parameters:
array Current values
array Past values
Returns:
array Affected files

Definition at line 2768 of file index.php.

SC_mod_tools_em_index::first_in_array str,
array,
caseInsensitive = FALSE
 

Returns true if the $str is found as the first part of a string in $array

Parameters:
string String to test with.
array Input array
boolean If set, the test is case insensitive
Returns:
boolean True if found.

Definition at line 4299 of file index.php.

SC_mod_tools_em_index::getClassIndexLocallangFiles absPath,
table_class_prefix,
extKey
 

Analyses the php-scripts of an available extension on server

Parameters:
string Absolute path to extension
string Prefix for tables/classes.
string Extension key
Returns:
array Information array.
See also:
makeDetailedExtensionAnalysis()

Definition at line 2644 of file index.php.

References t3lib_div::getAllFilesAndFoldersInPath(), t3lib_div::isFirstPartOfStr(), and t3lib_div::removePrefixPathFromList().

SC_mod_tools_em_index::getDocManual extension_key,
loc = ''
 

Returns true if the doc/manual.sxw should be returned

Parameters:
string Extension key
string Extension install type (L, G, S)
Returns:
boolean Returns true if either the TYPO3_CONF_VARS flag for always including manuals are set OR if the manual is ALREADY found for the extension in question.

Definition at line 4271 of file index.php.

SC_mod_tools_em_index::getExtPath extKey,
type
 

Returns the absolute path where the extension $extKey is installed (based on 'type' (SGL))

Parameters:
string Extension key
string Install scope type: L, G, S
Returns:
string Returns the absolute path to the install scope given by input $type variable. It is checked if the path is a directory. Slash is appended.

Definition at line 2986 of file index.php.

Referenced by showExtDetails().

SC_mod_tools_em_index::getFileListOfExtension extKey,
conf
 

Returns file-listing of an extension

Parameters:
string Extension key
array Extension information array
Returns:
string HTML table.

Definition at line 1575 of file index.php.

References t3lib_div::getAllFilesAndFoldersInPath(), t3lib_div::inList(), and t3lib_div::split_fileref().

Referenced by showExtDetails().

SC_mod_tools_em_index::getImportExtList listArr  ) 
 

Maps remote extensions information into $cat/$list arrays for listing

Parameters:
array List of extensions from remote repository
Returns:
array List array and category index as key 0 / 1 in an array.

Definition at line 2348 of file index.php.

References t3lib_div::formatSize().

Referenced by extensionList_import(), and importExtInfo().

SC_mod_tools_em_index::getInstalledExtensions  ) 
 

Returns the list of available (installed) extensions

Returns:
array Array with two arrays, list array (all extensions with info) and category index
See also:
getInstExtList()

Definition at line 2287 of file index.php.

Referenced by extensionList_import(), extensionList_installed(), extensionList_loaded(), importExtFromRep(), and showExtDetails().

SC_mod_tools_em_index::getInstExtList path,
&$  list,
&$  cat,
type
 

Gathers all extensions in $path

Parameters:
string Absolute path to local, global or system extensions
array Array with information for each extension key found. Notice: passed by reference
array Categories index: Contains extension titles grouped by various criteria.
string Path-type: L, G or S
Returns:
void "Returns" content by reference private
See also:
getInstalledExtensions()

Definition at line 2314 of file index.php.

References t3lib_div::get_dirs(), and t3lib_div::getFilesInDir().

SC_mod_tools_em_index::getRepositoryUploadForm extKey,
extInfo
 

Prints the upload form for extensions

Parameters:
string Extension key
array Extension information array
Returns:
string HTML content.

Definition at line 1902 of file index.php.

Referenced by showExtDetails().

SC_mod_tools_em_index::getSerializedLocalLang file,
content
 

Include a locallang file and return the $LOCAL_LANG array serialized.

Parameters:
string Absolute path to locallang file to include.
string Old content of a locallang file (keeping the header content)
Returns:
array Array with header/content as key 0/1
See also:
makeUploadArray()

Definition at line 3250 of file index.php.

SC_mod_tools_em_index::getTableAndFieldStructure parts  ) 
 

Gets th