TYPO3 CMS  TYPO3_6-2
Static Public Member Functions | Static Protected Member Functions | Static Protected Attributes | List of all members
TYPO3\CMS\Core\Utility\ExtensionManagementUtility Class Reference
Inheritance diagram for TYPO3\CMS\Core\Utility\ExtensionManagementUtility:
t3lib_extMgm

Static Public Member Functions

static setPackageManager (\TYPO3\CMS\Core\Package\PackageManager $packageManager)
 
static isLoaded ($key, $exitOnError=FALSE)
 
static extPath ($key, $script='')
 
static extRelPath ($key)
 
static siteRelPath ($key)
 
static getCN ($key)
 
static getExtensionKeyByPrefix ($prefix)
 
static clearExtensionKeyMap ()
 
static getExtensionVersion ($key)
 
static addTCAcolumns ($table, $columnArray, $addTofeInterface=FALSE)
 
static addToAllTCAtypes ($table, $newFieldsString, $typeList='', $position='')
 
static addFieldsToAllPalettesOfField ($table, $field, $addFields, $insertionPosition='')
 
static addFieldsToPalette ($table, $palette, $addFields, $insertionPosition='')
 
static addTcaSelectItem ($table, $field, array $item, $relativeToField='', $relativePosition='')
 
static getFileFieldTCAConfig ($fieldName, array $customSettingOverride=array(), $allowedFileExtensions='', $disallowedFileExtensions='')
 
static addFieldsToUserSettings ($addFields, $insertionPosition='')
 
static allowTableOnStandardPages ($table)
 
static addExtJSModule ($extensionName, $mainModuleName, $subModuleName='', $position='', array $moduleConfiguration=array())
 
static configureModule ($moduleSignature, $modulePath)
 
static addModule ($main, $sub='', $position='', $path='', $moduleConfiguration=array())
 
static registerExtDirectComponent ($endpointName, $callbackClass, $moduleName=NULL, $accessLevel=NULL)
 
static registerAjaxHandler ($ajaxId, $callbackMethod, $csrfTokenCheck=TRUE)
 
static addModulePath ($name, $path)
 
static insertModuleFunction ($modname, $className, $classPath, $title, $MM_key='function', $WS='')
 
static appendToTypoConfVars ($group, $key, $content)
 
static addPageTSConfig ($content)
 
static addUserTSConfig ($content)
 
static addLLrefForTCAdescr ($tca_descr_key, $file_ref)
 
static addNavigationComponent ($module, $componentId, $extensionKey=NULL)
 
static addCoreNavigationComponent ($module, $componentId)
 
static addService ($extKey, $serviceType, $serviceKey, $info)
 
static findService ($serviceType, $serviceSubType='', $excludeServiceKeys=array())
 
static findServiceByKey ($serviceKey)
 
static isServiceAvailable ($serviceType, $serviceKey, $serviceDetails)
 
static deactivateService ($serviceType, $serviceKey)
 
static addPlugin ($itemArray, $type='list_type', $extensionKey=NULL)
 
static addPiFlexFormValue ($piKeyToMatch, $value, $CTypeToMatch='list')
 
static addToInsertRecords ($table, $content_table='tt_content', $content_field='records')
 
static addPItoST43 ($key, $classFile='', $prefix='', $type='list_type', $cached=0)
 
static addStaticFile ($extKey, $path, $title)
 
static addTypoScriptSetup ($content)
 
static addTypoScriptConstants ($content)
 
static addTypoScript ($key, $type, $content, $afterStaticUid=0)
 
static getExtensionIcon ($extensionPath, $returnFullPath=FALSE)
 
static loadNewTcaColumnsConfigFiles ()
 
static isLocalconfWritable ()
 
static removeCacheFiles ()
 
static getLoadedExtensionListArray ()
 
static getRequiredExtensionListArray ()
 
static loadExtension ($extensionKey)
 
static unloadExtension ($extensionKey)
 
static writeNewExtensionList (array $newExtensionList)
 

Static Protected Member Functions

static getCacheManager ()
 
static getSignalSlotDispatcher ()
 
static executePositionedStringInsertion ($list, $insertionList, $insertionPosition='')
 
static removeDuplicatesForInsertion ($insertionList, $list='')
 
static getInsertionNeedles ($item, array $itemDetails)
 
static explodeItemList ($itemList)
 
static generateItemList (array $items, $useRawData=FALSE)
 
static loadSingleExtLocalconfFiles ()
 
static createExtLocalconfCacheEntry ()
 
static getExtLocalconfCacheIdentifier ()
 
static buildBaseTcaFromSingleFiles ()
 
static emitTcaIsBeingBuiltSignal (array $tca)
 
static getBaseTcaCacheIdentifier ()
 
static loadSingleExtTablesFiles ()
 
static createExtTablesCacheEntry ()
 
static getExtTablesCacheIdentifier ()
 

Static Protected Attributes

static $extensionKeyMap
 
static $extTablesWasReadFromCacheOnce = FALSE
 
static $packageManager
 
static $cacheManager
 
static $signalSlotDispatcher
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Extension Management functions

This class is never instantiated, rather the methods inside is called as functions like ::isLoaded('my_extension');

Author
Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 25 of file ExtensionManagementUtility.php.

Member Function Documentation

◆ addCoreNavigationComponent()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addCoreNavigationComponent (   $module,
  $componentId 
)
static

Registers a core navigation component

Parameters
string$module
string$componentId
Returns
void

Definition at line 1089 of file ExtensionManagementUtility.php.

References $GLOBALS, and $module.

◆ addExtJSModule()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addExtJSModule (   $extensionName,
  $mainModuleName,
  $subModuleName = '',
  $position = '',
array  $moduleConfiguration = array() 
)
static

Adds a ExtJS module (main or sub) to the backend interface FOR USE IN ext_tables.php FILES

Parameters
string$extensionName
string$mainModuleNameIs the main module key
string$subModuleNameIs the submodule key, if blank a plain main module is generated
string$positionPassed to ::addModule, see reference there
array$moduleConfigurationIcon with array keys: access, icon, labels to configure the module
Exceptions

Definition at line 786 of file ExtensionManagementUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\camelCaseToLowerCaseUnderscored(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

◆ addFieldsToAllPalettesOfField()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addFieldsToAllPalettesOfField (   $table,
  $field,
  $addFields,
  $insertionPosition = '' 
)
static

Adds new fields to all palettes of an existing field. If the field does not have a palette yet, it's created automatically and gets called "generatedFor-$field".

Parameters
string$tableName of the table
string$fieldName of the field that has the palette to be extended
string$addFieldsList of fields to be added to the palette
string$insertionPositionInsert fields before (default) or after one
Returns
void

Definition at line 361 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToAllPalettesOfFieldAfterExistingOnes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToAllPalettesOfFieldAfterNotExistingOnes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToAllPalettesOfFieldBeforeExistingOnes(), and TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToAllPalettesOfFieldWithoutPaletteExistingBefore().

◆ addFieldsToPalette()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addFieldsToPalette (   $table,
  $palette,
  $addFields,
  $insertionPosition = '' 
)
static

Adds new fields to a palette. If the palette does not exist yet, it's created automatically.

Parameters
string$tableName of the table
string$paletteName of the palette to be extended
string$addFieldsList of fields to be added to the palette
string$insertionPositionInsert fields before (default) or after one
Returns
void

Definition at line 404 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToPaletteAfterExistingOnes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToPaletteAfterNotExistingOnes(), and TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToPaletteBeforeExistingOnes().

◆ addFieldsToUserSettings()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addFieldsToUserSettings (   $addFields,
  $insertionPosition = '' 
)
static

Adds a list of new fields to the TYPO3 USER SETTINGS configuration "showitem" list, the array with the new fields itself needs to be added additionally to show up in the user setup, like $GLOBALS['TYPO3_USER_SETTINGS']['columns'] += $tempColumns

Parameters
string$addFieldsList of fields to be added to the user settings
string$insertionPositionInsert fields before (default) or after one
Returns
void

Definition at line 569 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ addLLrefForTCAdescr()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr (   $tca_descr_key,
  $file_ref 
)
static

Adds a reference to a locallang file with $GLOBALS['TCA_DESCR'] labels FOR USE IN ext_tables.php FILES eg. ::addLLrefForTCAdescr('pages', 'EXT:lang/locallang_csh_pages.xlf'); for the pages table or ::addLLrefForTCAdescr('_MOD_web_layout', 'EXT:cms/locallang_csh_weblayout.php'); for the Web > Page module.

Parameters
string$tca_descr_keyDescription key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
string$file_refFile reference to locallang file, eg. "EXT:lang/locallang_csh_pages.xlf" (or ".xml")
Returns
void

Definition at line 1049 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ addModule()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addModule (   $main,
  $sub = '',
  $position = '',
  $path = '',
  $moduleConfiguration = array() 
)
static

Adds a module (main or sub) to the backend interface FOR USE IN ext_tables.php FILES

Parameters
string$mainThe main module key, $sub is the submodule key. So $main would be an index in the $TBE_MODULES array and $sub could be an element in the lists there.
string$subThe submodule key. If $sub is not set a blank $main module is created.
string$positionCan be used to set the position of the $sub module within the list of existing submodules for the main module. $position has this syntax: [cmd]:[submodule-key]. cmd can be "after", "before" or "top" (or blank which is default). If "after"/"before" then submodule will be inserted after/before the existing submodule with [submodule-key] if found. If not found, the bottom of list. If "top" the module is inserted in the top of the submodule list.
string$pathThe absolute path to the module. If this value is defined the path is added as an entry in $TBE_MODULES['_PATHS'][ main_sub ] = $path; and thereby tells the backend where the newly added modules is found in the system.
array$moduleConfigurationadditional configuration, previously put in "conf.php" of the module directory
Returns
void

Definition at line 864 of file ExtensionManagementUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addModuleCanAddModule(), and TYPO3\CMS\Extbase\Utility\ExtensionUtility\registerModule().

◆ addModulePath()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addModulePath (   $name,
  $path 
)
static

Adds a module path to $GLOBALS['TBE_MODULES'] for used with the module dispatcher, mod.php Used only for modules that are not placed in the main/sub menu hierarchy by the traditional mechanism of addModule() Examples for this is context menu functionality (like import/export) which runs as an independent module through mod.php FOR USE IN ext_tables.php FILES Example: ::addModulePath('xMOD_tximpexp', ::extPath($_EXTKEY).'app/');

Parameters
string$nameThe name of the module, refer to conf.php of the module.
string$pathThe absolute path to the module directory inside of which "index.php" and "conf.php" is found.
Returns
void

Definition at line 955 of file ExtensionManagementUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath().

◆ addNavigationComponent()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addNavigationComponent (   $module,
  $componentId,
  $extensionKey = NULL 
)
static

Registers a navigation component

Parameters
string$module
string$componentId
string$extensionKey
Exceptions

Definition at line 1070 of file ExtensionManagementUtility.php.

References $GLOBALS, and $module.

◆ addPageTSConfig()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addPageTSConfig (   $content)
static

Adds $content to the default Page TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultPageTSconfig'] Prefixed with a [GLOBAL] line FOR USE IN ext_tables.php/ext_localconf.php FILES

Parameters
string$contentPage TSconfig content
Returns
void

Definition at line 1020 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Form\Utility\FormUtility\initializePageTsConfig().

◆ addPiFlexFormValue()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addPiFlexFormValue (   $piKeyToMatch,
  $value,
  $CTypeToMatch = 'list' 
)
static

Adds an entry to the "ds" array of the tt_content field "pi_flexform". This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.

Parameters
string$piKeyToMatchPlugin key as used in the list_type field. Use the asterisk * to match all list_type values.
string$valueEither a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
string$CTypeToMatchValue of tt_content.CType (Content Type) to match. The default is "list" which corresponds to the "Insert Plugin" content element. Use the asterisk * to match all CType values.
Returns
void
See also
addPlugin()

Definition at line 1308 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ addPItoST43()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addPItoST43 (   $key,
  $classFile = '',
  $prefix = '',
  $type = 'list_type',
  $cached = 0 
)
static

Add PlugIn to the default template rendering (previously called "Static Template #43")

When adding a frontend plugin you will have to add both an entry to the TCA definition of tt_content table AND to the TypoScript template which must initiate the rendering.

The naming of #43 has historic reason and is rooted inside code which is now put into a TER extension called "statictemplates". Since the static template with uid 43 is the "content.default" and practically always used for rendering the content elements it's very useful to have this function automatically adding the necessary TypoScript for calling your plugin. It will also work for the extension "css_styled_content". The logic is now generalized and called "defaultContentRendering", see addTypoScript() as well.

$type determines the type of frontend plugin:

  • list_type (default) - the good old "Insert plugin" entry
  • menu_type - a "Menu/Sitemap" entry
  • CType - a new content element type
  • header_layout - an additional header type (added to the selection of layout1-5)
  • includeLib - just includes the library for manual use somewhere in TypoScript. (Remember that your $type definition should correspond to the column/items array in $GLOBALS['TCA'][tt_content] where you added the selector item for the element! See addPlugin() function) FOR USE IN ext_localconf.php FILES
Parameters
string$keyThe extension key
string$classFileThe PHP-class filename relative to the extension root directory. If set to blank a default value is chosen according to convensions.
string$prefixIs used as a - yes, suffix - of the class name (fx. "_pi1")
string$typeSee description above
integer$cachedIf $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
Returns
void

Definition at line 1358 of file ExtensionManagementUtility.php.

References $addLine, $GLOBALS, and $pluginContent.

◆ addPlugin()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addPlugin (   $itemArray,
  $type = 'list_type',
  $extensionKey = NULL 
)
static

Adds an entry to the list of plugins in content elements of type "Insert plugin" Takes the $itemArray (label, value[,icon]) and adds to the items-array of $GLOBALS['TCA'][tt_content] elements with CType "listtype" (or another field if $type points to another fieldname) If the value (array pos. 1) is already found in that items-array, the entry is substituted, otherwise the input array is added to the bottom. Use this function to add a frontend plugin to this list of plugin-types - or more generally use this function to add an entry to any selectorbox/radio-button set in the TCEFORMS FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!

Parameters
array$itemArrayNumerical array: [0] => Plugin label, [1] => Underscored extension key, [2] => Path to plugin icon relative to TYPO3_mainDir
string$typeType (eg. "list_type") - basically a field from "tt_content" table
string$extensionKeyThe extension key
Exceptions

Definition at line 1272 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Extbase\Utility\ExtensionUtility\registerPlugin().

◆ addService()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addService (   $extKey,
  $serviceType,
  $serviceKey,
  $info 
)
static

Adds a service to the global services array

Parameters
string$extKeyExtension key
string$serviceTypeService type, must not be prefixed "tx_" or "Tx_"
string$serviceKeyService key, must be prefixed "tx_", "Tx_" or "user_"
array$infoService description array
Returns
void

Definition at line 1108 of file ExtensionManagementUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ addStaticFile()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addStaticFile (   $extKey,
  $path,
  $title 
)
static

Call this method to add an entry in the static template list found in sys_templates FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!

Parameters
string$extKeyIs of course the extension key
string$pathIs the path where the template files (fixed names) include_static.txt (integer list of uids from the table "static_templates"), constants.txt, setup.txt, and include_static_file.txt is found (relative to extPath, eg. 'static/'). The file include_static_file.txt, allows you to include other static templates defined in files, from your static template, and thus corresponds to the field 'include_static_file' in the sys_template table. The syntax for this is a comma separated list of static templates to include, like: EXT:css_styled_content/static/,EXT:da_newsletter_subscription/static/,EXT:cc_random_image/pi2/static/
string$titleIs the title in the selector box.
Returns
void
See also
addTypoScript()

Definition at line 1415 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ addTCAcolumns()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTCAcolumns (   $table,
  $columnArray,
  $addTofeInterface = FALSE 
)
static

Adding fields to an existing table definition in $GLOBALS['TCA'] Adds an array with $GLOBALS['TCA'] column-configuration to the $GLOBALS['TCA']-entry for that table. This function adds the configuration needed for rendering of the field in TCEFORMS - but it does NOT add the field names to the types lists! So to have the fields displayed you must also call fx. addToAllTCAtypes or manually add the fields to the types list. FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!

Parameters
string$tableThe table name of a table already present in $GLOBALS['TCA'] with a columns section
array$columnArrayThe array with the additional columns (typical some fields an extension wants to add)
boolean$addTofeInterfaceDEPRECATED: Usage of feInterface is no longer part of the TYPO3 CMS Core. Please check EXT:statictemplates.
Returns
void

Definition at line 248 of file ExtensionManagementUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog().

Referenced by TYPO3\CMS\Core\Category\CategoryRegistry\addTcaColumn().

◆ addTcaSelectItem()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTcaSelectItem (   $table,
  $field,
array  $item,
  $relativeToField = '',
  $relativePosition = '' 
)
static

Add an item to a select field item list.

Warning: Do not use this method for radio or check types, especially not with $relativeToField and $relativePosition parameters. This would shift existing database data 'off by one'.

As an example, this can be used to add an item to tt_content CType select drop-down after the existing 'mailform' field with these parameters:

  • $table = 'tt_content'
  • $field = 'CType'
  • $item = array( 'LLL:EXT:cms/locallang_ttc.xlf:CType.I.10', 'login', 'i/tt_content_login.gif', ),
  • $relativeToField = mailform
  • $relativePosition = after
Exceptions

Definition at line 444 of file ExtensionManagementUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\ArrayUtility\filterByValueRecursive().

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addTcaSelectItemInsertsItemAtSpecifiedPosition(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfFieldIsNotFoundInTca(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfFieldIsNotOfTypeString(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfRelativePositionIsNotOfTypeString(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfRelativePositionIsNotOneOfValidKeywords(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfRelativeToFieldIsNotOfTypeString(), and TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfTableIsNotOfTypeString().

◆ addToAllTCAtypes()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addToAllTCAtypes (   $table,
  $newFieldsString,
  $typeList = '',
  $position = '' 
)
static

Makes fields visible in the TCEforms, adding them to the end of (all) "types"-configurations

Adds a string $string (comma separated list of field names) to all ["types"][xxx]["showitem"] entries for table $table (unless limited by $typeList) This is needed to have new fields shown automatically in the TCEFORMS of a record from $table. Typically this function is called after having added new columns (database fields) with the addTCAcolumns function FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!

Parameters
string$tableTable name
string$newFieldsStringField list to add.
string$typeListList of specific types to add the field list to. (If empty, all type entries are affected)
string$positionInsert fields before (default) or after one, or replace a field
Returns
void

Definition at line 274 of file ExtensionManagementUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Category\CategoryRegistry\addToAllTCAtypes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\addToAllTCAtypesReplacesExistingOnes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToAllTCATypesAfterExistingOnes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToAllTCATypesBeforeExistingOnes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToTCATypeAfterExistingOnes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToTCATypeAndReplaceExistingOnes(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldsToTCATypeBeforeExistingOnes(), and TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\canAddFieldWithPartOfAlreadyExistingFieldname().

◆ addToInsertRecords()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addToInsertRecords (   $table,
  $content_table = 'tt_content',
  $content_field = 'records' 
)
static

Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records" By using $content_table and $content_field you can also use the function for other tables. FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!

Parameters
string$tableTable name to allow for "insert record
string$content_tableTable name TO WHICH the $table name is applied. See $content_field as well.
string$content_fieldField name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
Returns
void

Definition at line 1324 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ addTypoScript()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScript (   $key,
  $type,
  $content,
  $afterStaticUid = 0 
)
static

Adds $content to the default TypoScript code for either setup or constants as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_*'] (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!) FOR USE IN ext_localconf.php FILES Note: As of TYPO3 CMS 6.2, static template #43 (content: default) was replaced with "defaultContentRendering" which makes it possible that a first extension like css_styled_content registers a "contentRendering" template (= a template that defines default content rendering TypoScript) by adding itself to $TYPO3_CONF_VARS[FE][contentRenderingTemplates][] = 'myext/Configuration/TypoScript'. An extension calling addTypoScript('myext', 'setup', $typoScript, 'defaultContentRendering') will add its TypoScript directly after; For now, "43" and "defaultContentRendering" can be used, but "defaultContentRendering" is more descriptive and should be used in the future.

Parameters
string$keyIs the extension key (informative only).
string$typeIs either "setup" or "constants" and obviously determines which kind of TypoScript code we are adding.
string$contentIs the TS content, will be prefixed with a [GLOBAL] line and a comment-header.
int | string$afterStaticUidIs either an integer pointing to a uid of a static_template or a string pointing to the "key" of a static_file template ([reduced extension_key]/[local path]). The points is that the TypoScript you add is included only IF that static template is included (and in that case, right after). So effectively the TypoScript you set can specifically overrule settings from those static templates.
Returns
void

Definition at line 1469 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Extbase\Utility\ExtensionUtility\configurePlugin().

◆ addTypoScriptConstants()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScriptConstants (   $content)
static

Adds $content to the default TypoScript constants code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_constants'] Prefixed with a [GLOBAL] line FOR USE IN ext_localconf.php FILES

Parameters
string$contentTypoScript Constants string
Returns
void

Definition at line 1445 of file ExtensionManagementUtility.php.

◆ addTypoScriptSetup()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScriptSetup (   $content)
static

Adds $content to the default TypoScript setup code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_setup'] Prefixed with a [GLOBAL] line FOR USE IN ext_localconf.php FILES

Parameters
string$contentTypoScript Setup string
Returns
void

Definition at line 1431 of file ExtensionManagementUtility.php.

◆ addUserTSConfig()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addUserTSConfig (   $content)
static

Adds $content to the default User TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultUserTSconfig'] Prefixed with a [GLOBAL] line FOR USE IN ext_tables.php/ext_localconf.php FILES

Parameters
string$contentUser TSconfig content
Returns
void

Definition at line 1034 of file ExtensionManagementUtility.php.

◆ allowTableOnStandardPages()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::allowTableOnStandardPages (   $table)
static

Add tablename to default list of allowed tables on pages (in $PAGES_TYPES) Will add the $table to the list of tables allowed by default on pages as setup by $PAGES_TYPES['default']['allowedTables'] FOR USE IN ext_tables.php FILES

Parameters
string$tableTable name
Returns
void

Definition at line 770 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ appendToTypoConfVars()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::appendToTypoConfVars (   $group,
  $key,
  $content 
)
static

Adds some more content to a key of TYPO3_CONF_VARS array.

This also tracks which content was added by extensions (in TYPO3_CONF_VARS_extensionAdded) so that they cannot be editted again through the Install Tool.

Parameters
string$groupThe group ('FE', 'BE', 'SYS' ...)
string$keyThe key of this setting within the group
string$contentThe text to add (include leading "\n" in case of multi-line entries)
Returns
void

Definition at line 1007 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ buildBaseTcaFromSingleFiles()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::buildBaseTcaFromSingleFiles ( )
staticprotected

Find all Configuration/TCA/* files of extensions and create base TCA from it. The filename must be the table name in $GLOBALS['TCA'], and the content of the file should return an array with content of a specific table.

Returns
void
See also
Extension core, cms, extensionmanager and others for examples.

Definition at line 1657 of file ExtensionManagementUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Category\CategoryRegistry\getInstance().

◆ clearExtensionKeyMap()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::clearExtensionKeyMap ( )
static

Clears the extension key map.

Returns
void

Definition at line 202 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Core\ClassLoaderTest\createFakeExtension(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getExtensionKeyByPrefixForLoadedExtensionWithoutUnderscoresReturnsExtensionKey(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getExtensionKeyByPrefixForLoadedExtensionWithUnderscoresReturnsExtensionKey(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getExtensionKeyByPrefixForNotLoadedExtensionReturnsFalse(), and TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\tearDown().

◆ configureModule()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::configureModule (   $moduleSignature,
  $modulePath 
)
static

This method is called from ::checkMod and it replaces old conf.php.

The original function for is called Tx_Extbase_Utility_Extension::configureModule, the refered function can be deprecated now

Parameters
string$moduleSignatureThe module name
string$modulePathAbsolute path to module (not used by Extbase currently)
Returns
array Configuration of the module

Definition at line 829 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ createExtLocalconfCacheEntry()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::createExtLocalconfCacheEntry ( )
staticprotected

Create cache entry for concatenated ext_localconf.php files

Returns
void

Definition at line 1572 of file ExtensionManagementUtility.php.

References $_EXTCONF, $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\getUrl().

◆ createExtTablesCacheEntry()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::createExtTablesCacheEntry ( )
staticprotected

Create concatenated ext_tables.php cache file

Returns
void

Definition at line 1803 of file ExtensionManagementUtility.php.

References $_EXTCONF, $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\getUrl().

◆ deactivateService()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::deactivateService (   $serviceType,
  $serviceKey 
)
static

Deactivate a service

Parameters
string$serviceTypeService type
string$serviceKeyService key
Returns
void

Definition at line 1248 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Service\AbstractService\deactivateService(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstanceService().

◆ emitTcaIsBeingBuiltSignal()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::emitTcaIsBeingBuiltSignal ( array  $tca)
staticprotected

Emits the signal and uses the result of slots for the final TCA This means, that all slots must return the complete TCA to be effective. If a slot calls methods that manipulate the global array, it needs to return the global array in the end. To be future proof, a slot should manipulate the signal argument only and return it after manipulation.

Parameters
array$tca

Definition at line 1719 of file ExtensionManagementUtility.php.

References $GLOBALS, and $tca.

◆ executePositionedStringInsertion()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::executePositionedStringInsertion (   $list,
  $insertionList,
  $insertionPosition = '' 
)
staticprotected

Inserts as list of data into an existing list. The insertion position can be defined accordant before of after existing list items.

Example:

  • list: 'field_a, field_b;;;;2-2-2, field_c;;;;3-3-3'
  • insertionList: 'field_d, field_e;;;4-4-4'
  • insertionPosition: 'after:field_b' -> 'field_a, field_b;;;;2-2-2, field_d, field_e;;;4-4-4, field_c;;;;3-3-3'

$insertPosition may contain ; and - characters: after:–palette–;;title

Parameters
string$listThe list of items to be extended
string$insertionListThe list of items to inserted
string$insertionPositionInsert fields before (default) or after one
Returns
string The extended list

Definition at line 590 of file ExtensionManagementUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ explodeItemList()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::explodeItemList (   $itemList)
staticprotected

Generates an array of fields/items with additional information such as e.g. the name of the palette.

Parameters
string$itemListList of fields/items to be splitted up
Returns
array An array with the names of the fields/items as keys and additional information

Definition at line 712 of file ExtensionManagementUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ extPath()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath (   $key,
  $script = '' 
)
static

Returns the absolute path to the extension with extension key $key.

Parameters
$keystring Extension key
$scriptstring $script is appended to the output if set.
Exceptions

Definition at line 120 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Backend\Form\Element\TreeElement\__construct(), TYPO3\CMS\Core\TypoScript\TemplateService\addExtensionStatics(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\addModulePath(), TYPO3\CMS\Backend\Module\ModuleLoader\checkMod(), TYPO3\CMS\Extbase\Utility\ExtensionUtility\configureModule(), TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Dbal\ExtensionManager\MessageDisplay\displayMessage(), TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\executeAction(), TYPO3\CMS\Fluid\Tests\Unit\View\TemplateViewTest\expandGenericPathPatternWorksWithNewNamingSchemeOfSubPackage(), TYPO3\CMS\Fluid\Tests\Unit\View\TemplateViewTest\expandGenericPathPatternWorksWithOldNamingSchemeOfSubPackage(), TYPO3\CMS\Core\Tests\Unit\TypoScript\TemplateServiceTest\extensionStaticFilesAreNotProcessedIfNotExplicitlyRequested(), TYPO3\CMS\Core\Tests\Unit\TypoScript\TemplateServiceTest\extensionStaticsAreProcessedIfExplicitlyRequested(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\extPathAppendsScriptNameToPath(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\extPathThrowsExceptionIfExtensionIsNotLoaded(), TYPO3\CMS\Fluid\Compatibility\DocbookGeneratorService\getClassNamesInNamespace(), TYPO3\CMS\Core\Package\PackageManager\getExtAutoloadRegistry(), TYPO3\CMS\Documentation\Utility\MiscUtility\getExtensionMetaData(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\TypoScript\TemplateService\getFileName(), TYPO3\CMS\Documentation\Utility\MiscUtility\getIcon(), TYPO3\CMS\Install\Updates\InitUpdateWizard\getRequiredUpdates(), TYPO3\CMS\Install\Updates\ExtensionManagerTables\getUpdateStatements(), TYPO3\CMS\Install\Updates\FilePermissionUpdate\getUpdateStatements(), TYPO3\CMS\Openid\OpenidService\includePHPOpenIDLibrary(), TYPO3\CMS\Core\TypoScript\TemplateService\includeStaticTypoScriptSources(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\init(), TYPO3\CMS\Core\Charset\CharsetConverter\initCharset(), TYPO3\CMS\Frontend\Utility\EidUtility\initExtensionTCA(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateConstantEditorModuleFunctionController\initialize_editor(), TYPO3\CMS\Core\Charset\CharsetConverter\initUnicodeData(), TYPO3\CMS\Backend\Controller\BackendController\loadResourcesForRegisteredNavigationComponents(), TYPO3\CMS\Install\Updates\ExtensionManagerTables\performUpdate(), and TYPO3\CMS\Core\Core\Bootstrap\registerExtDirectComponents().

◆ extRelPath()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath (   $key)
static

Returns the relative path to the extension as measured from from the TYPO3_mainDir If the extension is not loaded the function will die with an error message Useful for images and links from backend

Parameters
string$keyExtension key
Exceptions

Definition at line 137 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\T3editor\T3editor\__construct(), TYPO3\CMS\Rsaauth\Hook\BackendHookForAjaxLogin\addRsaJsLibraries(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase\addSkin(), TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\collectTcaSpriteIcons(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_newWizard(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), TYPO3\CMS\Frontend\View\AdminPanelView\ext_makeToolBar(), TYPO3\CMS\Workspaces\Controller\PreviewController\generateJavascript(), TYPO3\CMS\Backend\Controller\BackendController\generateJavascript(), TYPO3\CMS\T3editor\T3editor\getModeSpecificJavascriptCode(), TYPO3\CMS\Backend\Template\DocumentTemplate\getSkinStylesheetDirectories(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\indexAction(), TYPO3\CMS\Backend\Controller\BackendLayoutWizardController\init(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\init(), TYPO3\CMS\Rtehtmlarea\SelectImage\initDocumentTemplate(), TYPO3\CMS\Rtehtmlarea\BrowseLinks\initDocumentTemplate(), TYPO3\CMS\Recycler\Controller\RecyclerModuleController\initialize(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initialize(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateConstantEditorModuleFunctionController\initialize_editor(), TYPO3\CMS\Workspaces\Controller\PreviewController\initializeAction(), TYPO3\CMS\Workspaces\Controller\AbstractController\initializeAction(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase\isAvailable(), TYPO3\CMS\Form\View\Wizard\WizardView\loadCss(), TYPO3\CMS\Form\View\Wizard\WizardView\loadJavascript(), TYPO3\CMS\Backend\Controller\BackendController\loadResourcesForRegisteredNavigationComponents(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\main(), TYPO3\CMS\Backend\Controller\BackendLayoutWizardController\main(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Reports\ViewHelpers\IconViewHelper\render(), TYPO3\CMS\Workspaces\Controller\ReviewController\singleIndexAction(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\stopTask().

◆ findService()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::findService (   $serviceType,
  $serviceSubType = '',
  $excludeServiceKeys = array() 
)
static

Find the available service with highest priority

Parameters
string$serviceTypeService type
string$serviceSubTypeService sub type
mixed$excludeServiceKeysService keys that should be excluded in the search for a service. Array or comma list.
Returns
mixed Service info array if a service was found, FALSE otherwise

Definition at line 1150 of file ExtensionManagementUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Utility\GeneralUtility\makeInstanceService().

◆ findServiceByKey()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::findServiceByKey (   $serviceKey)
static

Find a specific service identified by its key Note that this completely bypasses the notions of priority and quality

Parameters
string$serviceKeyService key
Returns
array Service info array if a service was found
Exceptions

Definition at line 1199 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Sv\Report\ServicesListReport\renderServiceRow().

◆ generateItemList()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::generateItemList ( array  $items,
  $useRawData = FALSE 
)
staticprotected

Generates a list of fields/items out of an array provided by the function getFieldsOfFieldList().

See also
explodeItemList
Parameters
array$itemsThe array of fields/items with optional additional information
boolean$useRawDataUse raw data instead of building by using the details (default: FALSE)
Returns
string The list of fields/items which gets used for $GLOBALS['TCA'][
['types'][<type>]['showitem']

Definition at line 746 of file ExtensionManagementUtility.php.

◆ getBaseTcaCacheIdentifier()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getBaseTcaCacheIdentifier ( )
staticprotected

Cache identifier of base TCA cache entry.

Returns
string

Definition at line 1741 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ getCacheManager()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCacheManager ( )
staticprotected

Getter for the cache manager

Returns

Definition at line 67 of file ExtensionManagementUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ getCN()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN (   $key)
static

Returns the correct class name prefix for the extension key $key

Parameters
string$keyExtension key
Returns
string

Definition at line 169 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getClassNamePrefixForExtensionKey().

◆ getExtensionIcon()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getExtensionIcon (   $extensionPath,
  $returnFullPath = FALSE 
)
static

Find extension icon

Parameters
string$extensionPathPath to extension directory.
boolean$returnFullPathReturn full path of file.
Returns
string

Definition at line 1506 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\ListUtility\getAvailableExtensions(), TYPO3\CMS\Lang\Domain\Repository\ExtensionRepository\getExtensionIconWithPath(), TYPO3\CMS\Documentation\Utility\MiscUtility\getIcon(), and TYPO3\CMS\Core\Compatibility\LoadedExtensionArrayElement\initializeExtensionIcon().

◆ getExtensionKeyByPrefix()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getExtensionKeyByPrefix (   $prefix)
static

Returns the real extension key like 'tt_news' from an extension prefix like 'tx_ttnews'.

Parameters
string$prefixThe extension prefix (e.g. 'tx_ttnews')
Returns
mixed Real extension key (string) or FALSE (boolean) if something went wrong

Definition at line 179 of file ExtensionManagementUtility.php.

References $result.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getExtensionKeyByPrefixForLoadedExtensionWithoutUnderscoresReturnsExtensionKey(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getExtensionKeyByPrefixForLoadedExtensionWithUnderscoresReturnsExtensionKey(), and TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getExtensionKeyByPrefixForNotLoadedExtensionReturnsFalse().

◆ getExtensionVersion()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getExtensionVersion (   $key)
static

Retrieves the version of an installed extension. If the extension is not installed, this function returns an empty string.

Parameters
string$keyThe key of the extension to look up, must not be empty
Exceptions

Definition at line 216 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isLoadedVersionCompatible().

◆ getExtLocalconfCacheIdentifier()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getExtLocalconfCacheIdentifier ( )
staticprotected

Cache identifier of concatenated ext_localconf file

Returns
string

Definition at line 1612 of file ExtensionManagementUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\setSingletonInstance().

◆ getExtTablesCacheIdentifier()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getExtTablesCacheIdentifier ( )
staticprotected

Cache identifier for concatenated ext_tables.php files

Returns
string

Definition at line 1887 of file ExtensionManagementUtility.php.

References $GLOBALS.

◆ getFileFieldTCAConfig()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getFileFieldTCAConfig (   $fieldName,
array  $customSettingOverride = array(),
  $allowedFileExtensions = '',
  $disallowedFileExtensions = '' 
)
static

Gets the TCA configuration for a field handling (FAL) files.

Parameters
string$fieldNameName of the field to be used
array$customSettingOverrideCustom field settings overriding the basics
string$allowedFileExtensionsComma list of allowed file extensions (e.g. "jpg,gif,pdf")
string$disallowedFileExtensions
Returns
array

Definition at line 500 of file ExtensionManagementUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

◆ getInsertionNeedles()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getInsertionNeedles (   $item,
array  $itemDetails 
)
staticprotected

Generates search needles that are used for inserting fields/items into an existing list.

See also
executePositionedStringInsertion
Parameters
string$itemThe name of the field/item
array$itemDetailsAdditional details of the field/item like e.g. palette information
Returns
array The needled to be used for inserting content before or after existing fields/items
Deprecated:
since 6.2, will be removed two versions later. This method was only used by executePositionedStringInsertion().

Definition at line 686 of file ExtensionManagementUtility.php.

◆ getLoadedExtensionListArray()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getLoadedExtensionListArray ( )
static

Gets an array of loaded extension keys

Returns
array Loaded extensions

Definition at line 1928 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\loadRequireJs(), TYPO3\CMS\Extensionmanager\Controller\ActionController\toggleExtensionInstallationStateAction(), and TYPO3\CMS\Extensionmanager\Controller\DownloadController\updateExtensionAction().

◆ getRequiredExtensionListArray()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getRequiredExtensionListArray ( )
static

Returns REQUIRED_EXTENSIONS constant set by package manager as array.

Returns
array List of required extensions
Deprecated:
since 6,2, will be removed two versions later.

Definition at line 1938 of file ExtensionManagementUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ getSignalSlotDispatcher()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getSignalSlotDispatcher ( )
staticprotected

Getter for the signal slot dispatcher

Returns

Definition at line 84 of file ExtensionManagementUtility.php.

References $signalSlotDispatcher, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ insertModuleFunction()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::insertModuleFunction (   $modname,
  $className,
  $classPath,
  $title,
  $MM_key = 'function',
  $WS = '' 
)
static

Adds a "Function menu module" ('third level module') to an existing function menu for some other backend module The arguments values are generally determined by which function menu this is supposed to interact with See Inside TYPO3 for information on how to use this function. FOR USE IN ext_tables.php FILES

Parameters
string$modnameModule name
string$classNameClass name
string$classPathClass path, deprecated since 6.2, use auto-loading instead
string$titleTitle of module
string$MM_keyMenu array key - default is "function @param string $WS Workspace conditions. Blank means all workspaces, any other string can be a comma list of "online", "offline" and "custom
Returns
void
See also
::mergeExternalItems()

Definition at line 978 of file ExtensionManagementUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog().

◆ isLoaded()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded (   $key,
  $exitOnError = FALSE 
)
static

Returns TRUE if the extension with extension key $key is loaded.

Parameters
string$keyExtension key to test
boolean$exitOnErrorIf $exitOnError is TRUE and the extension is not loaded the function will die with an error message
Returns
boolean
Exceptions

Definition at line 104 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\ModuleController\__construct(), TYPO3\CMS\Rtehtmlarea\Extension\Plaintext\applyToolbarConstraints(), TYPO3\CMS\Rtehtmlarea\Extension\Language\applyToolbarConstraints(), TYPO3\CMS\Rtehtmlarea\Extension\Plaintext\buildJavascriptConfiguration(), TYPO3\CMS\Saltedpasswords\Utility\ExtensionManagerConfigurationUtility\checkConfigurationBackend(), TYPO3\CMS\Version\Hook\PreviewHook\checkForPreview(), TYPO3\CMS\Rtehtmlarea\Hook\StatusReportConflictsCheckHook\checkIfNoConflictingExtensionIsInstalled(), TYPO3\CMS\Install\Service\SilentConfigurationUpgradeService\configureBackendLoginSecurity(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_newWizard(), TYPO3\CMS\Rtehtmlarea\Controller\FrontendRteController\drawRTE(), TYPO3\CMS\Install\Controller\Action\Ajax\UninstallExtension\executeAction(), TYPO3\CMS\Frontend\View\AdminPanelView\ext_makeToolBar(), TYPO3\CMS\Backend\Utility\BackendUtility\fixVersioningPid(), TYPO3\CMS\Backend\Form\FormEngine\getAdditionalPreviewLanguages(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\getAvailableLanguages(), TYPO3\CMS\Backend\Form\FormEngine\getAvailableLanguages(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\TypoScript\TemplateService\getFileName(), TYPO3\CMS\Rtehtmlarea\Controller\AccessibilityLinkController\getFullFileName(), TYPO3\CMS\Documentation\Utility\MiscUtility\getIcon(), TYPO3\CMS\Rtehtmlarea\Extension\Language\getLanguages(), TYPO3\CMS\Backend\Controller\BackendController\getLoggedInUserLabel(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getSelectedDbalDriver(), TYPO3\CMS\Backend\Template\DocumentTemplate\getSkinStylesheetDirectories(), TYPO3\CMS\Backend\Template\DocumentTemplate\getVersionSelector(), TYPO3\CMS\Backend\Controller\PageTreeNavigationController\getWorkspaceInfo(), TYPO3\CMS\Backend\Utility\BackendUtility\getWorkspaceVersionOfRecord(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\hasPageRecordVersions(), TYPO3\CMS\Core\TypoScript\TemplateService\includeStaticTypoScriptSources(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase\isAvailable(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isDependentExtensionLoaded(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\isLoadedReturnsFalseIfExtensionIsNotLoadedAndExitIsDisabled(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\isLoadedReturnsTrueIfExtensionIsLoaded(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\isLoadedThrowsExceptionIfExtensionIsNotLoaded(), TYPO3\CMS\Rtehtmlarea\Extension\Language\main(), TYPO3\CMS\Rtehtmlarea\Extension\Spellchecker\main(), TYPO3\CMS\Rtehtmlarea\Extension\Acronym\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateObjectBrowserModuleFunctionController\main(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Backend\Controller\LoginController\makeLogoutForm(), TYPO3\CMS\Backend\Form\ElementConditionMatcher\matchExtensionCondition(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFieldValue(), TYPO3\CMS\Core\Core\Bootstrap\registerExtDirectComponents(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\settingLanguage(), TYPO3\CMS\Extensionmanager\Controller\ListController\terAction(), TYPO3\CMS\Install\Updates\FileIdentifierHashUpdate\updateIdentifierHashesForStorage(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\whichWorkspace(), and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

◆ isLocalconfWritable()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLocalconfWritable ( )
static

Returns TRUE if configuration files in typo3conf/ are writable

Returns
boolean TRUE if at least one configuration file in typo3conf/ is writable

Definition at line 1898 of file ExtensionManagementUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ isServiceAvailable()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isServiceAvailable (   $serviceType,
  $serviceKey,
  $serviceDetails 
)
static

Check if a given service is available, based on the executable files it depends on

Parameters
string$serviceTypeType of service
string$serviceKeySpecific key of the service
array$serviceDetailsInformation about the service
Returns
boolean Service availability

Definition at line 1225 of file ExtensionManagementUtility.php.

References TYPO3\CMS\Core\Utility\CommandUtility\checkCommand(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ loadExtension()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::loadExtension (   $extensionKey)
static

Loads given extension

Warning: This method only works if the ugrade wizard to transform localconf.php to LocalConfiguration.php was already run

Parameters
string$extensionKeyExtension key to load
Returns
void
Exceptions

Definition at line 1953 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getSelectedDbalDriver().

◆ loadNewTcaColumnsConfigFiles()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::loadNewTcaColumnsConfigFiles ( )
static

Loads "columns" of a $TCA table definition if extracted to a "dynamicConfigFile". This method is called after each single ext_tables.php files was included to immediately have the full $TCA ready for the next extension.

$TCA[$tableName]['ctrl']['dynamicConfigFile'] must be the absolute path to a file.

Be aware that 'dynamicConfigFile' is obsolete, and all TCA table definitions should be moved to Configuration/TCA/tablename.php to be fully loaded automatically.

Example: dynamicConfigFile = ::extPath($_EXTKEY) . 'SysNote.php',

Returns
void
Exceptions

Definition at line 1862 of file ExtensionManagementUtility.php.

References $TCA, and TYPO3\CMS\Core\Utility\GeneralUtility\isAbsPath().

Referenced by TYPO3\CMS\Core\Category\CategoryRegistry\add().

◆ loadSingleExtLocalconfFiles()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::loadSingleExtLocalconfFiles ( )
staticprotected

Execute ext_localconf.php files from extensions

Returns
void

Definition at line 1551 of file ExtensionManagementUtility.php.

References $_EXTCONF, $GLOBALS, and $TYPO3_CONF_VARS.

◆ loadSingleExtTablesFiles()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::loadSingleExtTablesFiles ( )
staticprotected

Load ext_tables.php as single files

Returns
void

Definition at line 1779 of file ExtensionManagementUtility.php.

References $_EXTCONF, $GLOBALS, $TCA, and $TYPO3_CONF_VARS.

◆ registerAjaxHandler()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::registerAjaxHandler (   $ajaxId,
  $callbackMethod,
  $csrfTokenCheck = TRUE 
)
static

Registers an Ajax Handler

Parameters
string$ajaxIdIdentifier of the handler, that is used in the request
string$callbackMethodTYPO3 callback method (className->methodName).
bool$csrfTokenCheckOnly set this to FALSE if you are sure that the registered handler does not modify any data!

Definition at line 937 of file ExtensionManagementUtility.php.

References $csrfTokenCheck, and $GLOBALS.

◆ registerExtDirectComponent()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::registerExtDirectComponent (   $endpointName,
  $callbackClass,
  $moduleName = NULL,
  $accessLevel = NULL 
)
static

Registers an Ext.Direct component with access restrictions.

Parameters
string$endpointName
string$callbackClass
string$moduleNameOptional: must be <mainmodule> or <mainmodule>_<submodule>
string$accessLevelOptional: can be 'admin' or 'user,group'
Returns
void

Definition at line 922 of file ExtensionManagementUtility.php.

References $GLOBALS, and $moduleName.

Referenced by TYPO3\CMS\Core\Core\Bootstrap\registerExtDirectComponents().

◆ removeCacheFiles()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::removeCacheFiles ( )
static

Remove cache files from php code cache, grouped by 'system'

This removes the following cache entries:

  • autoloader cache registry
  • cache loaded extension array
  • ext_localconf concatenation
  • ext_tables concatenation

This method is usually only used by extension that fiddle with the loaded extensions. An example is the extension manager and the install tool.

Returns
void

Definition at line 1919 of file ExtensionManagementUtility.php.

◆ removeDuplicatesForInsertion()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::removeDuplicatesForInsertion (   $insertionList,
  $list = '' 
)
staticprotected

Compares an existing list of items and a list of items to be inserted and returns a duplicate-free variant of that insertion list.

Example:

  • list: 'field_a, field_b;;;;2-2-2, field_c;;;;3-3-3'
  • insertion: 'field_b, field_d, field_c;;;4-4-4' -> new insertion: 'field_d'

Duplicate values in $insertionList are removed.

Parameters
string$insertionListThe list of items to inserted
string$listThe list of items to be extended (default: '')
Returns
string Duplicate-free list of items to be inserted

Definition at line 652 of file ExtensionManagementUtility.php.

◆ setPackageManager()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::setPackageManager ( \TYPO3\CMS\Core\Package\PackageManager  $packageManager)
static

Sets the package manager for all that backwards compatibility stuff, so it doesn't have to be fetched through the bootstap.

Parameters
\TYPO3\CMS\Core\Package\PackageManager$packageManager

Definition at line 53 of file ExtensionManagementUtility.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\$packageManager.

Referenced by TYPO3\CMS\Core\Tests\Unit\TypoScript\TemplateServiceTest\extensionStaticsAreProcessedIfExplicitlyRequested(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\extPathAppendsScriptNameToPath(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\extPathThrowsExceptionIfExtensionIsNotLoaded(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getExtensionKeyByPrefixForLoadedExtensionWithoutUnderscoresReturnsExtensionKey(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\getExtensionKeyByPrefixForLoadedExtensionWithUnderscoresReturnsExtensionKey(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\loadBaseTcaCreatesCacheFileWithContentOfAnExtensionsConfigurationTcaPhpFile(), and TYPO3\CMS\Core\Core\Bootstrap\unregisterClassLoader().

◆ siteRelPath()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath (   $key)
static

Returns the relative path to the extension as measured from the PATH_site (frontend) If the extension is not loaded the function will die with an error message Useful for images and links from the frontend

Parameters
string$keyExtension key
Returns
string

Definition at line 158 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase\addSkin(), TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow(), TYPO3\CMS\Rtehtmlarea\Controller\FrontendRteController\drawRTE(), TYPO3\CMS\Openid\OpenidService\getBackPath(), TYPO3\CMS\Core\TypoScript\TemplateService\getFileName(), TYPO3\CMS\Rtehtmlarea\Controller\AccessibilityLinkController\getFullFileName(), TYPO3\CMS\Documentation\Utility\MiscUtility\getIcon(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getPathToPluginDirectory(), TYPO3\CMS\Rsaauth\Hook\FrontendLoginHook\loginFormHook(), and TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ unloadExtension()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::unloadExtension (   $extensionKey)
static

Unloads given extension

Warning: This method only works if the ugrade wizard to transform localconf.php to LocalConfiguration.php was already run

Parameters
string$extensionKeyExtension key to remove
Returns
void
Exceptions

Definition at line 1970 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getSelectedDbalDriver().

◆ writeNewExtensionList()

static TYPO3\CMS\Core\Utility\ExtensionManagementUtility::writeNewExtensionList ( array  $newExtensionList)
static

Writes extension list and clear cache files.

: This method should be protected, but with current em it is hard to do so, : Find out if we may remove this already

Parameters
array$newExtensionListExtension array to load, loader order is kept
Returns
void

Definition at line 1987 of file ExtensionManagementUtility.php.

References $result, TYPO3\CMS\Core\Category\CategoryRegistry\getInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Data Documentation

◆ $cacheManager

TYPO3\CMS\Core\Utility\ExtensionManagementUtility::$cacheManager
staticprotected

Definition at line 60 of file ExtensionManagementUtility.php.

◆ $extensionKeyMap

TYPO3\CMS\Core\Utility\ExtensionManagementUtility::$extensionKeyMap
staticprotected

Definition at line 27 of file ExtensionManagementUtility.php.

◆ $extTablesWasReadFromCacheOnce

TYPO3\CMS\Core\Utility\ExtensionManagementUtility::$extTablesWasReadFromCacheOnce = FALSE
staticprotected

Definition at line 39 of file ExtensionManagementUtility.php.

◆ $packageManager

TYPO3\CMS\Core\Utility\ExtensionManagementUtility::$packageManager
staticprotected

Definition at line 44 of file ExtensionManagementUtility.php.

Referenced by TYPO3\CMS\Core\Utility\ExtensionManagementUtility\setPackageManager().

◆ $signalSlotDispatcher

TYPO3\CMS\Core\Utility\ExtensionManagementUtility::$signalSlotDispatcher
staticprotected

Definition at line 77 of file ExtensionManagementUtility.php.