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 ()
 translationHandling ()
 updateTranslation ($extKey, $lang, $mirrorURL)
 installTranslationsForExtension ($extKey, $mirrorURL)
 unzip ($file, $path)
 importExtInfo ($extKey, $version='')
 fetchMetaData ($metaType)
 getMirrorURL ()
 installExtension ($extKey, $version=null, $mode=EM_INSTALL_VERSION_MIN)
 refreshGlobalExtList ()
 importExtFromRep ($extKey, $version, $loc, $uploadFlag=0, $dontDelete=0, $directInput='')
 showExtDetails ($extKey)
 requestInstallExtensions ($extList)
 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 ()
 depToString ($dep, $type='depends')
 stringToDep ($dep)
 getInstalledExtensions ()
 getInstExtList ($path, &$list, &$cat, $type)
 fixEMCONF ($emConf)
 splitVersionRange ($ver)
 prepareImportExtList ()
 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, $dontDelete=0)
 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)
 arrayToCode ($array, $level=0)
 makeUploadArray ($extKey, $conf)
 getSerializedLocalLang ($file, $content)
 addExtToList ($extKey, $instExtInfo)
 checkDependencies ($extKey, $conf, $instExtInfo)
 removeExtFromList ($extKey, $instExtInfo)
 removeRequiredExtFromListArr ($listArr)
 managesPriorities ($listArr, $instExtInfo)
 checkClearCache ($extInfo)
 checkUploadFolder ($extKey, $extInfo)
 checkDBupdates ($extKey, $extInfo, $infoOnly=0)
 forceDBupdates ($extKey, $extInfo)
 tsStyleConfigForm ($extKey, $extInfo, $output=0, $script='', $addFields='')
 dumpTableAndFieldStructure ($arr)
 dumpStaticTables ($tableList)
 dumpHeader ()
 dumpTableHeader ($table, $fieldKeyInfo, $dropTableIfExists=0)
 dumpTableContent ($table, $fieldStructure)
 getTableAndFieldStructure ($parts)
 uploadExtensionToTER ($em)
 listOrderTitle ($listOrder, $key)
 makeVersion ($v, $mode)
 renderVersion ($v, $raise='')
 ulFolder ($extKey)
 importAtAll ()
 importAsType ($type, $lockType='')
 deleteAsType ($type)
 versionDifference ($v1, $v2, $div=1)
 first_in_array ($str, $array, $caseInsensitive=FALSE)
 includeEMCONF ($path, $_EXTKEY)
 searchExtension ($extKey, $row)

Public Attributes

 $versionDiffFactor = 1
 $systemInstall = 0
 $requiredExt = ''
 $maxUploadSize = 31457280
 $kbMax = 500
 $doPrintContent = true
 $defaultCategories
 $categories
 $states
 $stateColors
 $typeLabels
 $typeDescr
 $typePaths = Array()
 $typeBackPaths = Array()
 $typeRelPaths
 $detailCols
 $fe_user
 $privacyNotice = 'When you interact with the online repository, server information may be sent and stored in the repository for statistics.'
 $editTextExtensions = 'html,htm,txt,css,tmpl,inc,php,sql,conf,cnf,pl,pm,sh,xml,ChangeLog'
 $nameSpaceExceptions = 'beuser_tracking,design_components,impexp,static_file_edit,cms,freesite,quickhelp,classic_welcome,indexed_search,sys_action,sys_workflows,sys_todos,sys_messages,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,adodb'
 $MCONF = array()
 $MOD_MENU = array()
 $MOD_SETTINGS = array()
 $doc
 $content
 $inst_keys = array()
 $gzcompress = 0
 $terConnection
 $CMD = array()
 $listRemote
 $lookUpStr

Detailed Description

Definition at line 195 of file class.em_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 3949 of file class.em_index.php.

Referenced by installExtension(), and showExtDetails().

SC_mod_tools_em_index::alterSettings  ) 
 

Allows changing of settings

Returns:
void

Definition at line 920 of file class.em_index.php.

References $content, and fetchMetaData().

Referenced by main().

SC_mod_tools_em_index::arrayToCode array,
level = 0
 

Enter description here...

Parameters:
unknown_type $array
unknown_type $lines
unknown_type $level
Returns:
unknown

Definition at line 3822 of file class.em_index.php.

SC_mod_tools_em_index::checkClearCache 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 4224 of file class.em_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 4336 of file class.em_index.php.

References t3lib_div::_GP().

SC_mod_tools_em_index::checkDependencies extKey,
conf,
instExtInfo
 

Enter description here...

Parameters:
string $extKey
array $conf
array $instExtInfo
Returns:
array

Definition at line 3980 of file class.em_index.php.

Referenced by importExtFromRep(), and showExtDetails().

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 4251 of file class.em_index.php.

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

SC_mod_tools_em_index::clearAndMakeExtensionDir importedData,
type,
dontDelete = 0
 

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)
boolean If set, nothing will be deleted (neither directory nor files)
Returns:
mixed Returns array on success (with extension directory), otherwise an error string.

Definition at line 3541 of file class.em_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 3791 of file class.em_index.php.

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 3460 of file class.em_index.php.

References t3lib_div::mkdir_deep().

Referenced by importExtFromRep().

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 4938 of file class.em_index.php.

SC_mod_tools_em_index::depToString dep,
type = 'depends'
 

Checks whether the passed dependency is TER2-style (array) and returns a single string for displaying the dependencies.

It leaves out all version numbers and the "php" and "typo3" dependencies, as they are implicit and of no interest without the version number.

Parameters:
mixed $dep Either a string or an array listing dependencies.
string $type The dependency type to list if $dep is an array
Returns:
string A simple dependency list for display

Definition at line 2861 of file class.em_index.php.

SC_mod_tools_em_index::dumpHeader  ) 
 

Header comments of the SQL dump file

Returns:
string Table header

Definition at line 4640 of file class.em_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 4611 of file class.em_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 4586 of file class.em_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 4699 of file class.em_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 4657 of file class.em_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 2347 of file class.em_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 2394 of file class.em_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 2296 of file class.em_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 2175 of file class.em_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 752 of file class.em_index.php.

References $content, t3lib_BEfunc::cshItem(), extensionListRow(), extensionListRowHeader(), fetchMetaData(), getInstalledExtensions(), importAsType(), importAtAll(), importExtInfo(), t3lib_extMgm::isLoaded(), noImportMsg(), prepareImportExtList(), and versionDifference().

Referenced by main().

SC_mod_tools_em_index::extensionList_installed  ) 
 

Listing of available (installed) extensions

Returns:
void

Definition at line 680 of file class.em_index.php.

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

Referenced by main().

SC_mod_tools_em_index::extensionList_loaded  ) 
 

Listing of loaded (installed) extensions

Returns:
void

Definition at line 625 of file class.em_index.php.

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

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 2658 of file class.em_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 2597 of file class.em_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 2815 of file class.em_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 2422 of file class.em_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 2517 of file class.em_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 2504 of file class.em_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 3605 of file class.em_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 2327 of file class.em_index.php.

Referenced by showExtDetails().

SC_mod_tools_em_index::fetchMetaData metaType  ) 
 

Fetches metadata and stores it to the corresponding place. This includes the mirror list, extension XML files.

Parameters:
string Type of data to fetch: (mirrors)
boolean If true the method doesn't produce any output
Returns:
void

Definition at line 1380 of file class.em_index.php.

References $content, getMirrorURL(), t3lib_BEfunc::getModuleData(), t3lib_div::getURL(), t3lib_div::tempnam(), t3lib_div::unlink_tempfile(), and t3lib_div::writeFile().

Referenced by alterSettings(), extensionList_import(), getMirrorURL(), and installExtension().

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 3428 of file class.em_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 4971 of file class.em_index.php.

References t3lib_div::isFirstPartOfStr().

SC_mod_tools_em_index::fixEMCONF emConf  ) 
 

Fixes an old style ext_emconf.php array by adding constraints if needed and removing deprecated keys

Parameters:
array $emConf
Returns:
array

Definition at line 2968 of file class.em_index.php.

Referenced by importExtFromRep().

SC_mod_tools_em_index::forceDBupdates extKey,
extInfo
 

Updates the database according to extension requirements DBAL compliant (based on Install Tool code)

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

Definition at line 4433 of file class.em_index.php.

Referenced by installExtension().

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 3305 of file class.em_index.php.

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

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 3631 of file class.em_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 2242 of file class.em_index.php.

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

Referenced by showExtDetails().

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 2910 of file class.em_index.php.

Referenced by extensionList_import(), extensionList_installed(), extensionList_loaded(), importExtFromRep(), installExtension(), 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 2937 of file class.em_index.php.

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

SC_mod_tools_em_index::getMirrorURL  ) 
 

Returns the base URL for the slected or a random mirror.

Returns:
string The URL for the selected or a random mirror

Definition at line 1439 of file class.em_index.php.

References fetchMetaData().

Referenced by fetchMetaData(), installExtension(), main(), and translationHandling().

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 2536 of file class.em_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 3913 of file class.em_index.php.

SC_mod_tools_em_index::getTableAndFieldStructure parts  ) 
 

Gets the table and field structure from database. Which fields and which tables are determined from the ext_tables.sql file

Parameters:
string Array with table.field values
Returns:
array Array of tables and fields splitted.

Definition at line 4734 of file class.em_index.php.

SC_mod_tools_em_index::handleExternalFunctionValue MM_key = 'function',
MS_value = NULL
 

This function is a copy of the same function in t3lib_SCbase with one modification: In contrast to t3lib_SCbase::handleExternalFunctionValue() this function merges the $this->extClassConf array instead of overwriting it. That was necessary for including the Kickstarter as a submodule into the 'singleDetails' selectorbox as well as in the main 'function' selectorbox.

Parameters:
string Mod-setting array key
string Mod setting value, overriding the one in the key
Returns:
void
See also:
t3lib_SCbase::handleExternalFunctionValue()

Reimplemented from t3lib_SCbase.

Definition at line 419 of file class.em_index.php.

References t3lib_SCbase::getExternalItemConfig().

Referenced by init().

SC_mod_tools_em_index::helpCol key  ) 
 

Returns help text if applicable.

Parameters:
string Help text key
Returns:
string HTML table cell

Definition at line 2787 of file class.em_index.php.

References t3lib_BEfunc::helpText(), and t3lib_BEfunc::helpTextIcon().

SC_mod_tools_em_index::importAsType type,
lockType = ''
 

Reports back if installation in a certain scope is possible.

Parameters:
string Scope: G, L, S
string Extension lock-type (eg. "L" or "G")
Returns:
boolean True if installation is allowed.

Definition at line 4916 of file class.em_index.php.

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

SC_mod_tools_em_index::importAtAll  ) 
 

Returns true if global OR local installation of extensions is allowed/possible.

Returns:
boolean Returns true if global OR local installation of extensions is allowed/possible.

Definition at line 4905 of file class.em_index.php.

Referenced by extensionList_import(), and importExtInfo().

SC_mod_tools_em_index::importExtFromRep extKey,
version,
loc,
uploadFlag = 0,
dontDelete = 0,
directInput = ''
 

Imports an extensions from the online repository NOTICE: in version 4.0 this changed from "importExtFromRep_old($extRepUid,$loc,$uploadFlag=0,$directInput='',$recentTranslations=0,$incManual=0,$dontDelete=0)"

Parameters:
string Extension key
string Version
string Install scope: "L" or "G" or "S"
boolean If true, extension is uploaded as file
boolean If true, extension directory+files will not be deleted before writing the new ones. That way custom files stored in the extension folder will be kept.
array Direct input array (like from kickstarter)
Returns:
string Return false on success, returns error message if error.

Definition at line 1624 of file class.em_index.php.

References $content, checkDependencies(), clearAndMakeExtensionDir(), construct_ext_emconf_file(), createDirsInPath(), extractDirsFromFileList(), fixEMCONF(), getInstalledExtensions(), importAsType(), t3lib_extMgm::isLoaded(), removeCacheFiles(), serverExtensionMD5Array(), t3lib_div::trimExplode(), t3lib_div::unlink_tempfile(), updatesForm(), t3lib_div::upload_to_tempfile(), t3lib_div::writeFile(), and writeTYPO3_MOD_PATH().

Referenced by installExtension(), and main().

SC_mod_tools_em_index::importExtInfo extKey,
version = ''
 

Returns detailed info about an extension in the online repository

Parameters:
string Extension repository uid + optional "private key": [uid]-[key].
[type] $version: ...
Returns:
void

Definition at line 1323 of file class.em_index.php.

References $content, extInformationArray(), importAsType(), importAtAll(), noImportMsg(), and prepareImportExtList().

Referenced by extensionList_import(), and main().

SC_mod_tools_em_index::includeEMCONF path,
_EXTKEY
 

Returns the $EM_CONF array from an extensions ext_emconf.php file

Parameters:
string Absolute path to EMCONF file.
string Extension key.
Returns:
array EMconf array values.

Definition at line 4989 of file class.em_index.php.

SC_mod_tools_em_index::init  ) 
 

Standard init function of a module.

Returns:
void

Reimplemented from t3lib_SCbase.

Definition at line 339 of file class.em_index.php.

References t3lib_div::_GP(), handleExternalFunctionValue(), t3lib_div::makeInstance(), menuConfig(), and t3lib_div::trimExplode().

SC_mod_tools_em_index::installButton  ) 
 

Returns image for "install"

Returns:
string tag

Definition at line 2839 of file class.em_index.php.

SC_mod_tools_em_index::installExtension extKey,
version = null,
mode = EM_INSTALL_VERSION_MIN
 

Installs (activates) an extension

For $mode use the three constants EM_INSTALL_VERSION_MIN, EM_INSTALL_VERSION_MAX, EM_INSTALL_VERSION_STRICT

If an extension is loaded or imported already and the version requirement is matched, it will not be fetched from the repository. This means, if you use EM_INSTALL_VERSION_MIN, you will not always get the latest version of an extension!

Parameters:
string $extKey The extension key to install
string $version A version number that should be installed
int $mode If a version is requested, this determines if it is the min, max or strict version requested
Returns:
[type] ...
Todo:
Make the method able to handle needed interaction somehow (unmatched dependencies)

Definition at line 1477 of file class.em_index.php.

References addExtToList(), fetchMetaData(), forceDBupdates(), getInstalledExtensions(), getMirrorURL(), importExtFromRep(), installTranslationsForExtension(), t3lib_extMgm::isLoaded(), t3lib_extMgm::isLocalconfWritable(), refreshGlobalExtList(), and writeNewExtensionList().

SC_mod_tools_em_index::installTranslationsForExtension extKey,
mirrorURL
 

Install translations for all selected languages for an extension

Parameters:
string $extKey The extension key to install the translations for
string $mirrorURL Mirror URL to fetch data from
Returns:
mixed true on success, error string on fauilure

Definition at line 1264 of file class.em_index.php.

References t3lib_div::mkdir_deep(), unzip(), and t3lib_div::writeFile().

Referenced by installExtension(), and main().

SC_mod_tools_em_index::labelInfo str  ) 
 

Returns title and style attribute for mouseover help text.

Parameters:
string Help text.
Returns:
string title="" attribute prepended with a single space

Definition at line 2803 of file class.em_index.php.

SC_mod_tools_em_index::listOrderTitle listOrder,
key
 

Returns subtitles for the extension listings

Parameters:
string List order type
string Key value
Returns:
string output.

Definition at line 4822 of file class.em_index.php.

SC_mod_tools_em_index::main  ) 
 

Main function for Extension Manager module.

Returns:
void

Definition at line 513 of file class.em_index.php.

References alterSettings(), extensionList_import(), extensionList_installed(), extensionList_loaded(), t3lib_SCbase::extObjContent(), t3lib_BEfunc::getFuncMenu(), getMirrorURL(), importExtFromRep(), importExtInfo(), t3lib_div::inList(), installTranslationsForExtension(), requestInstallExtensions(), showExtDetails(), and translationHandling().

Referenced by showExtDetails().

SC_mod_tools_em_index::makeDetailedExtensionAnalysis extKey,
extInfo,
validity = 0
 

Perform a detailed, technical analysis of the available extension on server! Includes all kinds of verifications Takes some time to process, therfore use with care, in particular in listings.

Parameters:
string Extension key
array Extension information
boolean If set, checks for validity of classes etc.
Returns:
array Information in an array.

Definition at line 3123 of file class.em_index.php.

References t3lib_extMgm::addModule(), t3lib_extMgm::addPageTSConfig(), t3lib_extMgm::addPItoST43(), t3lib_extMgm::addPlugin(), t3lib_extMgm::addTypoScriptConstants(), t3lib_extMgm::addTypoScriptSetup(), t3lib_extMgm::addUserTSConfig(), t3lib_div::get_dirs(), t3lib_extMgm::insertModuleFunction(), t3lib_div::isFirstPartOfStr(), t3lib_extMgm::isLoaded(), t3lib_div::loadTCA(), and t3lib_div::trimExplode().

SC_mod_tools_em_index::makeUploadArray extKey,
conf
 

Make upload array out of extension

Parameters:
string Extension key
array Extension information array
Returns:
mixed Returns array with extension upload array on success, otherwise an error string.

Definition at line 3844 of file class.em_index.php.

SC_mod_tools_em_index::makeVersion v,
mode
 

Returns version information

Parameters:
string Version code, x.x.x
string part: "", "int", "main", "sub", "dev"
Returns:
string
See also:
renderVersion()

Definition at line 4847 of file class.em_index.php.

SC_mod_tools_em_index::managesPriorities listArr,
instExtInfo
 

Traverse the array of installed extensions keys and arranges extensions in the priority order they should be in

Parameters:
array Array of extension keys as values
array Extension information array
Returns:
array Modified array of extention keys as values
See also:
addExtToList()

Definition at line 4172 of file class.em_index.php.

SC_mod_tools_em_index::menuConfig  ) 
 

Configuration of which mod-menu items can be used

Returns:
void

Reimplemented from t3lib_SCbase.

Definition at line 433 of file class.em_index.php.

References t3lib_div::_GP(), t3lib_BEfunc::getModuleData(), and t3lib_SCbase::mergeExternalItems().

Referenced by init().

SC_mod_tools_em_index::modConfFileAnalysis confFilePath  ) 
 

Reads $confFilePath (a module $conf-file) and returns information on the existence of TYPO3_MOD_PATH definition and MCONF_name

Parameters:
string Absolute path to a "conf.php" file of a module which we are analysing.
Returns:
array Information found.
See also:
writeTYPO3_MOD_PATH()

Definition at line 3375 of file class.em_index.php.

SC_mod_tools_em_index::noImportMsg  ) 
 

Warning ( + text string) message about the impossibility to import extensions (both local and global locations are disabled...)

Returns:
string + text string.

Definition at line 2848 of file class.em_index.php.

Referenced by extensionList_import(), and importExtInfo().

SC_mod_tools_em_index::prepareImportExtList  ) 
 

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

Returns:
array List array and category index as key 0 / 1 in an array.

Definition at line 3029 of file class.em_index.php.

Referenced by extensionList_import(), and importExtInfo().

SC_mod_tools_em_index::printContent  ) 
 

Print module content. Called as last thing in the global scope.

Returns:
void

Definition at line 598 of file class.em_index.php.

SC_mod_tools_em_index::removeButton  ) 
 

Returns image tag for "uninstall"

Returns:
string tag

Definition at line 2830 of file class.em_index.php.

SC_mod_tools_em_index::removeCacheFiles  ) 
 

Unlink (delete) cache files

Returns:
integer Number of deleted files.

Definition at line 3595 of file class.em_index.php.

References t3lib_extMgm::removeCacheFiles().

Referenced by importExtFromRep().

SC_mod_tools_em_index::removeExtDirectory removePath,
removeContentOnly = 0
 

Removes the extension directory (including content)

Parameters:
string Extension directory to remove (with trailing slash)
boolean If set, will leave the extension directory
Returns:
boolean False on success, otherwise error string.

Definition at line 3478 of file class.em_index.php.

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

SC_mod_tools_em_index::removeExtFromList extKey,
instExtInfo
 

Remove extension key from the list of currently installed extensions and return 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 4120 of file class.em_index.php.

References t3lib_div::trimExplode().

Referenced by showExtDetails().

SC_mod_tools_em_index::removeRequiredExtFromListArr listArr  ) 
 

This removes any required extensions from the $listArr - they should NOT be added to the common extension list, because they are found already in "requiredExt" list

Parameters:
array Array of extension keys as values
Returns:
array Modified array
See also:
removeExtFromList(), addExtToList()

Definition at line 4157 of file class.em_index.php.

SC_mod_tools_em_index::renderVersion v,
raise = ''
 

Parses the version number x.x.x and returns an array with the various parts.

Parameters:
string Version code, x.x.x
string Increase version part: "main", "sub", "dev"
Returns:
string

Definition at line 4859 of file class.em_index.php.

References t3lib_div::intExplode(), and t3lib_div::intInRange().

SC_mod_tools_em_index::requestInstallExtensions extList  ) 
 

Outputs a screen from where you can install multiple extensions in one go This can be called from external modules with "...index.php?CMD[requestInstallExtensions]=

Parameters:
string Comma list of extension keys to install. Renders a screen with checkboxes for all extensions not already imported or installed
Returns:
void

Definition at line 2063 of file class.em_index.php.

References t3lib_div::_GP(), t3lib_div::_POST(), t3lib_extMgm::isLoaded(), and t3lib_div::locationHeaderUrl().

Referenced by main().

SC_mod_tools_em_index::searchExtension extKey,
row
 

Searches for ->lookUpStr in extension and returns true if found (or if no search string is set)

Parameters:
string Extension key
array Extension content
Returns:
boolean If true, display extension in list

Definition at line 5004 of file class.em_index.php.

Referenced by extensionList_installed(), and extensionList_loaded().

SC_mod_tools_em_index::serverExtensionMD5Array extKey,
conf
 

Creates a MD5-hash array over the current files in the extension

Parameters:
string Extension key
array Extension information array
Returns:
array MD5-keys

Definition at line 3403 of file class.em_index.php.

Referenced by importExtFromRep().

SC_mod_tools_em_index::setCat &$  cat,
listArrayPart,
extKey
 

Set category array entries for extension

Parameters:
array Category index array
array Part of list array for extension.
string Extension key
Returns:
array Modified category index array

Definition at line 3073 of file class.em_index.php.

SC_mod_tools_em_index::showExtDetails extKey  ) 
 

Display extensions details.

Parameters:
string Extension key
Returns:
void Writes content to $this->content

Definition at line 1770 of file class.em_index.php.

References $content, t3lib_div::_GP(), t3lib_div::_POST(), addExtToList(), checkClearCache(), checkDependencies(), t3lib_BEfunc::cshItem(), extBackup(), extDelete(), extDumpTables(), extensionTitleIconHeader(), extInformationArray(), t3lib_SCbase::extObjContent(), extUpdateEMCONF(), t3lib_div::formatForTextarea(), getExtPath(), getFileListOfExtension(), t3lib_BEfunc::getFuncMenu(), getInstalledExtensions(), getRepositoryUploadForm(), t3lib_div::inList(), t3lib_div::isFirstPartOfStr(), t3lib_extMgm::isLoaded(), t3lib_extMgm::isLocalconfWritable(), t3lib_div::linkThisScript(), main(), removeExtFromList(), t3lib_div::split_fileref(), tsStyleConfigForm(), updatesForm(), uploadExtensionToTER(), t3lib_div::writeFile(), and writeNewExtensionList().

Referenced by main().

SC_mod_tools_em_index::splitVersionRange ver  ) 
 

Splits a version range into an array.

If a single version number is given, it is considered a minimum value. If a dash is found, the numbers left and right are considered as minimum and maximum. Empty values are allowed.

Parameters:
string $ver A string with a version range.
Returns:
array

Definition at line 3013 of file class.em_index.php.

SC_mod_tools_em_index::stringToDep dep  ) 
 

Checks whether the passed dependency is TER-style (string) or TER2-style (array) and returns a single string for displaying the dependencies.

It leaves out all version numbers and the "php" and "typo3" dependencies, as they are implicit and of no interest without the version number.

Parameters:
mixed $dep Either a string or an array listing dependencies.
string $type The dependency type to list if $dep is an array
Returns:
string A simple dependency list for display

Definition at line 2880 of file class.em_index.php.

SC_mod_tools_em_index::translationHandling  ) 
 

Allows to set the translation preferences and check the status

Returns:
void

Definition at line 1012 of file class.em_index.php.

References $content, t3lib_div::_GET(), t3lib_div::_POST(), getMirrorURL(), t3lib_BEfunc::getModuleData(), t3lib_div::trimExplode(), and updateTranslation().

Referenced by main().

SC_mod_tools_em_index::tsStyleConfigForm extKey,
extInfo,
output = 0,
script = '',
addFields = ''
 

Produces the config form for an extension (if any template file, ext_conf_template.txt is found)

Parameters:
string Extension key
array Extension information array
boolean If true, the form HTML content is returned, otherwise the content is set in $this->content.
string Submit-to URL (supposedly)
string Additional form fields to include.
Returns:
string Depending on $output. Can return the whole form.

Definition at line 4491 of file class.em_index.php.

References t3lib_div::_GP(), t3lib_div::_POST(), t3lib_div::callUserFunction(), t3lib_BEfunc::getModuleData(), and t3lib_div::makeInstance().

Referenced by showExtDetails().

SC_mod_tools_em_index::ulFolder extKey  ) 
 

Returns upload folder for extension

Parameters:
string Extension key
Returns:
string Upload folder for extension

Definition at line 4896 of file class.em_index.php.

SC_mod_tools_em_index::unzip file,
path
 

Unzips a zip file in the given path.

Uses unzip binary if available, otherwise a pure PHP unzip is used.

Parameters:
string $file Full path to zip file
string $path Path to change to before extracting
Returns:
boolean True on success, false in failure

Definition at line 1294 of file class.em_index.php.

Referenced by installTranslationsForExtension(), and updateTranslation().

SC_mod_tools_em_index::updateLocalEM_CONF extKey,
extInfo
 

Forces update of local EM_CONF. This will renew the information of changed files.

Parameters:
string Extension key
array Extension information array
Returns:
string Status message

Definition at line 3749 of file class.em_index.php.

References t3lib_div::writeFile().

SC_mod_tools_em_index::updatesForm extKey,
extInfo,
notSilent = 0,
script = '',
addFields = ''
 

Creates a form for an extension which contains all options for configuration, updates of database, clearing of cache etc. This form is shown when

Parameters:
string Extension key
array Extension information array
boolean If set, the form will ONLY show if fields/tables should be updated (suppressing forms like general configuration and cache clearing).
string Alternative action=""-script
string HTML: Additional form fields
Returns:
string HTML

Definition at line 2144 of file class.em_index.php.

References t3lib_div::linkThisScript().

Referenced by importExtFromRep(), and showExtDetails().

SC_mod_tools_em_index::updateTranslation extKey,
lang,
mirrorURL
 

Install translations for all selected languages for an extension

Parameters:
string $extKey The extension key to install the translations for
string $lang Language code of translation to fetch
string $mirrorURL Mirror URL to fetch data from
Returns:
mixed true on success, error string on fauilure

Definition at line 1240 of file class.em_index.php.

References t3lib_div::mkdir_deep(), unzip(), and t3lib_div::writeFile().

Referenced by translationHandling().

SC_mod_tools_em_index::uploadExtensionToTER em  ) 
 

Processes return-data from online repository. Currently only the returned emconf array is written to extension.

Parameters:
array Command array returned from TER
Returns:
string Message

Definition at line 4784 of file class.em_index.php.

Referenced by showExtDetails().

SC_mod_tools_em_index::versionDifference v1,
v2,
div = 1
 

Evaluates differences in version numbers with three parts, x.x.x. Returns true if $v1 is greater than $v2

Parameters:
string Version number 1
string Version number 2
integer Tolerance factor. For instance, set to 1000 to ignore difference in dev-version (third part)
Returns:
boolean True if version 1 is greater than version 2

Definition at line 4959 of file class.em_index.php.

Referenced by extensionList_import().

SC_mod_tools_em_index::wrapEmail str,
email
 

Wrapping input string in a link tag with link to email address

Parameters:
string Input string, being wrapped in tags
string Email address for use in link.
Returns:
string Output

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

SC_mod_tools_em_index::writeNewExtensionList newExtList  ) 
 

Writes the extension list to "localconf.php" file Removes the temp_CACHED* files before return.

Parameters:
string List of extensions
Returns:
void

Definition at line 3702 of file class.em_index.php.

Referenced by installExtension(), and showExtDetails().

SC_mod_tools_em_index::writeTsStyleConfig extKey,
arr
 

Writes the TSstyleconf values to "localconf.php" Removes the temp_CACHED* files before return.

Parameters:
string Extension key
array Configuration array to write back
Returns:
void

Definition at line 3727 of file class.em_index.php.

SC_mod_tools_em_index::writeTYPO3_MOD_PATH confFilePath,
type,
mP
 

Write new TYPO3_MOD_PATH to "conf.php" file.

Parameters:
string Absolute path to a "conf.php" file of the backend module which we want to write back to.
string Install scope type: L, G, S
string Relative path for the module folder in extenson
Returns:
string Returns message about the status.
See also:
modConfFileAnalysis()

Definition at line 3665 of file class.em_index.php.

Referenced by importExtFromRep().


Member Data Documentation

SC_mod_tools_em_index::$categories
 

Initial value:

 Array(
                'be' => 'Backend',
                'module' => 'Backend Modules',
                'fe' => 'Frontend',
                'plugin' => 'Frontend Plugins',
                'misc' => 'Miscellaneous',
                'services' => 'Services',
                'templates' => 'Templates',
                'example' => 'Examples',
                'doc' => 'Documentation'
        )
Extension Categories (static var) Content must be redundant with the same internal variable as in class.tx_extrep.php!

Definition at line 227 of file class.em_index.php.

SC_mod_tools_em_index::$CMD = array()
 

The value of GET/POST var, 'CMD'

See also:
init()

Reimplemented from t3lib_SCbase.

Definition at line 321 of file class.em_index.php.

SC_mod_tools_em_index::$content
 

Generally used for accumulating the output content of backend modules

Reimplemented from t3lib_SCbase.

Definition at line 313 of file class.em_index.php.

Referenced by alterSettings(), extensionList_import(), extensionList_installed(), extensionList_loaded(), fetchMetaData(), importExtFromRep(), importExtInfo(), showExtDetails(), and translationHandling().

SC_mod_tools_em_index::$defaultCategories
 

Initial value:

 Array(
                'cat' => Array (
                        'be' => array(),
                        'module' => array(),
                        'fe' => array(),
                        'plugin' => array(),
                        'misc' => array(),
                        'services' => array(),
                        'templates' => array(),
                        'example' => array(),
                        'doc' => array()
                )
        )
Internal variable loaded with extension categories (for display/listing). Should reflect $categories above Dynamic var.

Definition at line 209 of file class.em_index.php.

SC_mod_tools_em_index::$detailCols
 

Initial value:

 Array (
                0 => 2,
                1 => 5,
                2 => 6,
                3 => 6,
                4 => 4,
                5 => 1
        )

Definition at line 286 of file class.em_index.php.

SC_mod_tools_em_index::$doc
 

Generally used to hold an instance of the 'template' class from typo3/template.php

Reimplemented from t3lib_SCbase.

Definition at line 312 of file class.em_index.php.

SC_mod_tools_em_index::$fe_user
 

Initial value:

 array(
                'username' => '',
                'password' => '',
        )

Definition at line 295 of file class.em_index.php.

SC_mod_tools_em_index::$MCONF = array()
 

Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.

See also:
init()

Reimplemented from t3lib_SCbase.

Definition at line 309 of file class.em_index.php.

SC_mod_tools_em_index::$MOD_MENU = array()
 

The module menu items array. Each key represents a key for which values can range between the items in the array of that key.

See also:
init()

Reimplemented from t3lib_SCbase.

Definition at line 310 of file class.em_index.php.

SC_mod_tools_em_index::$MOD_SETTINGS = array()
 

Current settings for the keys of the MOD_MENU array

See also:
$MOD_MENU

Reimplemented from t3lib_SCbase.

Definition at line 311 of file class.em_index.php.

SC_mod_tools_em_index::$stateColors
 

Initial value:

 Array (
                'alpha' => '#d12438',
                'beta' => '#97b17e',
                'stable' => '#3bb65c',
                'experimental' => '#007eba',
                'test' => '#979797',
                'obsolete' => '#000000',
        )
Colors for extension states

Definition at line 255 of file class.em_index.php.

SC_mod_tools_em_index::$states
 

Initial value:

 Array (
                'alpha' => 'Alpha',
                'beta' => 'Beta',
                'stable' => 'Stable',
                'experimental' => 'Experimental',
                'test' => 'Test',
                'obsolete' => 'Obsolete',
        )
Extension States Content must be redundant with the same internal variable as in class.tx_extrep.php!

Definition at line 243 of file class.em_index.php.

SC_mod_tools_em_index::$typeDescr
 

Initial value:

 Array (
                'S' => 'System extension (typo3/sysext/) - Always distributed with source code (Static).',
                'G' => 'Global extensions (typo3/ext/) - Available for shared source on server (Dynamic).',
                'L' => 'Local extensions (typo3conf/ext/) - Local for this TYPO3 installation only (Dynamic).',
        )

Definition at line 272 of file class.em_index.php.

SC_mod_tools_em_index::$typeLabels
 

Initial value:

 Array (
                'S' => 'System',
                'G' => 'Global',
                'L' => 'Local',
        )
"TYPE" information; labels, paths, description etc.

Definition at line 267 of file class.em_index.php.

SC_mod_tools_em_index::$typeRelPaths
 

Initial value:

 Array (
                'S' => 'sysext/',
                'G' => 'ext/',
                'L' => '../typo3conf/ext/',
        )

Definition at line 280 of file class.em_index.php.


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


Généré par Les experts TYPO3 avec  doxygen 1.4.6