TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
ExtensionManagementUtility Class Reference
Inheritance diagram for ExtensionManagementUtility:
ExtensionManagementUtilityAccessibleProxy

Static Public Member Functions

static setPackageManager (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)
 
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=[], $allowedFileExtensions= '', $disallowedFileExtensions= '')
 
static addFieldsToUserSettings ($addFields, $insertionPosition= '')
 
static allowTableOnStandardPages ($table)
 
static addExtJSModule ($extensionName, $mainModuleName, $subModuleName= '', $position= '', array $moduleConfiguration=[])
 
static configureModule ($moduleSignature)
 
static addModule ($main, $sub= '', $position= '', $path=null, $moduleConfiguration=[])
 
static registerExtDirectComponent ($endpointName, $callbackClass, $moduleName=null, $accessLevel=null)
 
static registerAjaxHandler ($ajaxId, $callbackMethod, $csrfTokenCheck=true)
 
static insertModuleFunction ($modname, $className, $classPath=null, $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=[])
 
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, $_, $suffix= '', $type= 'list_type', $cached=0)
 
static addStaticFile ($extKey, $path, $title)
 
static registerPageTSConfigFile ($extKey, $filePath, $title)
 
static addTypoScriptSetup ($content)
 
static addTypoScriptConstants ($content)
 
static addTypoScript ($key, $type, $content, $afterStaticUid=0)
 
static getExtensionIcon ($extensionPath, $returnFullPath=false)
 
static removeCacheFiles ()
 
static getLoadedExtensionListArray ()
 
static loadExtension ($extensionKey)
 
static unloadExtension ($extensionKey)
 

Static Protected Member Functions

static getCacheManager ()
 
static getSignalSlotDispatcher ()
 
static executePositionedStringInsertion ($list, $insertionList, $insertionPosition= '')
 
static removeDuplicatesForInsertion ($insertionList, $list= '')
 
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

Extension Management functions

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

Definition at line 29 of file ExtensionManagementUtility.php.

Member Function Documentation

static addCoreNavigationComponent (   $module,
  $componentId 
)
static

Registers a core navigation component

Parameters
string$module
string$componentId
Returns
void

Definition at line 1123 of file ExtensionManagementUtility.php.

References $GLOBALS.

static addExtJSModule (   $extensionName,
  $mainModuleName,
  $subModuleName = '',
  $position = '',
array  $moduleConfiguration = [] 
)
static

Adds an 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
InvalidArgumentException

Definition at line 836 of file ExtensionManagementUtility.php.

References $GLOBALS, and ArrayUtility\mergeRecursiveWithOverrule().

static addFieldsToAllPalettesOfField (   $table,
  $field,
  $addFields,
  $insertionPosition = '' 
)
static

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

See unit tests for more examples and edge cases.

Example:

'aTable' => array( 'types' => array( 'aType' => array( 'showitem' => 'aField, –palette–;;aPalette', ), ), 'palettes' => array( 'aPallete' => array( 'showitem' => 'fieldB, fieldC', ), ), ),

Calling addFieldsToAllPalettesOfField('aTable', 'aField', 'newA', 'before: fieldC') results in:

'aTable' => array( 'types' => array( 'aType' => array( 'showitem' => 'aField, –palette–;;aPalette', ), ), 'palettes' => array( 'aPallete' => array( 'showitem' => 'fieldB, newA, fieldC', ), ), ),

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 410 of file ExtensionManagementUtility.php.

References $GLOBALS, and GeneralUtility\trimExplode().

Referenced by ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsAfterExistingIfRequested(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsBeforeExistingIfRequested(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsFieldsAtEndIfAfterRequestedDoesNotExist(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsFieldsAtEndIfBeforeRequestedDoesNotExist(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsFieldsToMultiplePalettes(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsFieldsToPaletteAndSuppressesDuplicates(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsMultipleFields(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsNewPaletteIfFieldHasNoPaletteYet(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldAddsNewPaletteIfFieldHasNoPaletteYetAndKeepsExistingLabel(), ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldDoesNotAddAFieldThatIsPartOfPaletteAlready(), and ExtensionManagementUtilityTest\addFieldsToAllPalettesOfFieldDoesNotAddAnythingIfFieldIsNotRegisteredInColumns().

static 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 463 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by ExtensionManagementUtilityTest\canAddFieldsToPaletteAfterExistingOnes(), ExtensionManagementUtilityTest\canAddFieldsToPaletteAfterNotExistingOnes(), and ExtensionManagementUtilityTest\canAddFieldsToPaletteBeforeExistingOnes().

static 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 631 of file ExtensionManagementUtility.php.

References $GLOBALS.

static 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/Resources/Private/Language/locallang_csh_pages.xlf'); for the pages table or ::addLLrefForTCAdescr('_MOD_web_layout', 'EXT:frontend/Resources/Private/Language/locallang_csh_weblayout.xlf'); 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/Resources/Private/Language/locallang_csh_pages.xlf" (or ".xml")
Returns
void

Definition at line 1081 of file ExtensionManagementUtility.php.

References $GLOBALS.

static addModule (   $main,
  $sub = '',
  $position = '',
  $path = null,
  $moduleConfiguration = [] 
)
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. Was used prior to TYPO3 v8, use $moduleConfiguration[routeTarget] now
array$moduleConfigurationadditional configuration, previously put in "conf.php" of the module directory
Returns
void

Definition at line 907 of file ExtensionManagementUtility.php.

References $GLOBALS, $iconRegistry, GeneralUtility\deprecationLog(), GeneralUtility\getFileAbsFileName(), GeneralUtility\inList(), GeneralUtility\makeInstance(), and GeneralUtility\trimExplode().

Referenced by ExtensionManagementUtilityTest\addModuleCanAddModule(), and ExtensionUtility\registerModule().

static addNavigationComponent (   $module,
  $componentId,
  $extensionKey = null 
)
static

Registers a navigation component

Parameters
string$module
string$componentId
string$extensionKey
Exceptions
RuntimeException
Returns
void

Definition at line 1103 of file ExtensionManagementUtility.php.

References $GLOBALS.

static 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 1050 of file ExtensionManagementUtility.php.

static 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 1348 of file ExtensionManagementUtility.php.

References $GLOBALS.

static addPItoST43 (   $key,
  $_,
  $suffix = '',
  $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$_unused since TYPO3 CMS 8
string$suffixIs used as a suffix of the class name (e.g. "_pi1")
string$typeSee description above
int$cachedIf $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
Returns
void

Definition at line 1400 of file ExtensionManagementUtility.php.

static 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
RuntimeException
Returns
void

Definition at line 1311 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by ExtensionUtility\registerPlugin().

static 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 1143 of file ExtensionManagementUtility.php.

References $GLOBALS, and GeneralUtility\trimExplode().

static 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 in Configuration/TCA/Overrides/sys_template.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 1455 of file ExtensionManagementUtility.php.

References $GLOBALS.

static addTCAcolumns (   $table,
  $columnArray 
)
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)
Returns
void

Definition at line 268 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by CategoryRegistry\addTcaColumn().

static 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:frontend/Resources/Private/Language/locallang_ttc.xlf:CType.I.10', 'login', 'i/imagename.gif', ),
  • $relativeToField = mailform
  • $relativePosition = after
Exceptions
InvalidArgumentException If given parameters are not of correct
RuntimeException If reference to related position fields can not
Parameters
string$tableName of TCA table
string$fieldName of TCA field
array$itemNew item to add
string$relativeToFieldAdd item relative to existing field
string$relativePositionValid keywords: 'before', 'after'
Returns
void

Definition at line 504 of file ExtensionManagementUtility.php.

References $GLOBALS, and ArrayUtility\filterByValueRecursive().

Referenced by ExtensionManagementUtilityTest\addTcaSelectItemInsertsItemAtSpecifiedPosition(), ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfFieldIsNotFoundInTca(), ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfFieldIsNotOfTypeString(), ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfRelativePositionIsNotOfTypeString(), ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfRelativePositionIsNotOneOfValidKeywords(), ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfRelativeToFieldIsNotOfTypeString(), and ExtensionManagementUtilityTest\addTcaSelectItemThrowsExceptionIfTableIsNotOfTypeString().

static 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 290 of file ExtensionManagementUtility.php.

References $GLOBALS, GeneralUtility\inList(), and GeneralUtility\trimExplode().

Referenced by CategoryRegistry\addToAllTCAtypes(), ExtensionManagementUtilityTest\addToAllTCAtypesReplacesExistingOnes(), ExtensionManagementUtilityTest\canAddFieldsToAllTCATypesAfterExistingOnes(), ExtensionManagementUtilityTest\canAddFieldsToAllTCATypesBeforeExistingOnes(), ExtensionManagementUtilityTest\canAddFieldsToAllTCATypesRespectsPalettes(), ExtensionManagementUtilityTest\canAddFieldsToAllTCATypesRespectsPositionFieldInPalette(), ExtensionManagementUtilityTest\canAddFieldsToTCATypeAfterExistingOnes(), ExtensionManagementUtilityTest\canAddFieldsToTCATypeAndReplaceExistingOnes(), ExtensionManagementUtilityTest\canAddFieldsToTCATypeBeforeExistingOnes(), and ExtensionManagementUtilityTest\canAddFieldWithPartOfAlreadyExistingFieldname().

static 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 1365 of file ExtensionManagementUtility.php.

References $GLOBALS.

static 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 1538 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by ExtensionUtility\configurePlugin().

static 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 1513 of file ExtensionManagementUtility.php.

static 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 1498 of file ExtensionManagementUtility.php.

static 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 1065 of file ExtensionManagementUtility.php.

static 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 819 of file ExtensionManagementUtility.php.

References $GLOBALS.

static 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 1036 of file ExtensionManagementUtility.php.

References $GLOBALS.

static 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, extensionmanager and others for examples.

Definition at line 1740 of file ExtensionManagementUtility.php.

References $GLOBALS, GeneralUtility\deprecationLog(), CategoryRegistry\getInstance(), and GeneralUtility\makeInstance().

static clearExtensionKeyMap ( )
static
static configureModule (   $moduleSignature)
static

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

Parameters
string$moduleSignatureThe module name
Returns
array Configuration of the module

Definition at line 873 of file ExtensionManagementUtility.php.

References $GLOBALS, $iconRegistry, GeneralUtility\deprecationLog(), GeneralUtility\getFileAbsFileName(), and GeneralUtility\makeInstance().

static createExtLocalconfCacheEntry ( )
staticprotected

Create cache entry for concatenated ext_localconf.php files

Returns
void

Definition at line 1652 of file ExtensionManagementUtility.php.

References $_EXTCONF, and $GLOBALS.

static createExtTablesCacheEntry ( )
staticprotected

Create concatenated ext_tables.php cache file

Returns
void

Definition at line 1904 of file ExtensionManagementUtility.php.

References $_EXTCONF, and $GLOBALS.

static deactivateService (   $serviceType,
  $serviceKey 
)
static

Deactivate a service

Parameters
string$serviceTypeService type
string$serviceKeyService key
Returns
void

Definition at line 1287 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by AbstractService\deactivateService(), and GeneralUtility\makeInstanceService().

static 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 1816 of file ExtensionManagementUtility.php.

References $GLOBALS, and $tca.

static 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, field_c'
  • insertionList: 'field_d, field_e'
  • insertionPosition: 'after:field_b' -> 'field_a, field_b, field_d, field_e, field_c'

$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 653 of file ExtensionManagementUtility.php.

References GeneralUtility\trimExplode().

static 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 749 of file ExtensionManagementUtility.php.

References GeneralUtility\trimExplode().

static 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
BadFunctionCallException
Returns
string

Definition at line 131 of file ExtensionManagementUtility.php.

Referenced by ErrorPageController\__construct(), SystemInformationToolbarItem\__construct(), SchedulerModuleController\__construct(), ImportExportController\__construct(), T3editor\__construct(), TemplateService\addExtensionStatics(), CleanerCommand\cli_main(), PageRenderer\computeRequireJsConfig(), PdoBackend\createCacheTables(), RecyclerAjaxController\dispatch(), ErrorPageController\errorAction(), TestSetup\executeAction(), TemplateServiceTest\extensionStaticFilesAreNotProcessedIfNotExplicitlyRequested(), TemplateServiceTest\extensionStaticsAreProcessedIfExplicitlyRequested(), TerService\fetchTranslation(), DatabaseIntegrityView\func_refindex(), DocumentTemplate\getBackendFavicon(), ModuleTemplate\getDynamicTabMenu(), StatusReportConflictsCheckHook\getEmConf(), MiscUtility\getExtensionMetaData(), TemplatePaths\getExtensionPrivateResourcesPath(), RichTextElement\getExternalPlugins(), GeneralUtility\getFileAbsFileName(), MiscUtility\getIcon(), DocumentationService\getLocalExtensions(), BackendUtility\getPagesTSconfig(), DocumentTemplate\getSkinStylesheetDirectories(), Typo3DatabaseBackend\getTableDefinitions(), ExtensionManagerTables\getTableStatements(), GraphicalFunctions\getTemporaryImageWithText(), TemplateService\includeStaticTypoScriptSources(), CharsetConverter\initCharset(), EidUtility\initExtensionTCA(), CharsetConverter\initUnicodeData(), BackendController\loadResourcesForRegisteredNavigationComponents(), TemplateService\mergeConstantsFromIncludedTsConfigFiles(), ExtensionManagerTables\performUpdate(), TypoScriptReferenceLoader\processAjaxRequest(), NewRecordController\regularNew(), RichTextElement\render(), T3editorElement\render(), IconViewHelper\renderStatic(), AbstractContainer\renderTabMenu(), and DistributionController\showAction().

static 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
BadFunctionCallException
Returns
string
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9, use PathUtility::getAbsoluteWebPath(), or ->siteRelPath()

Definition at line 150 of file ExtensionManagementUtility.php.

References GeneralUtility\logDeprecatedFunction().

static findService (   $serviceType,
  $serviceSubType = '',
  $excludeServiceKeys = [] 
)
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 1186 of file ExtensionManagementUtility.php.

References $GLOBALS, and GeneralUtility\trimExplode().

Referenced by GeneralUtility\makeInstanceService().

static 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
TYPO3

Definition at line 1236 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by ServicesListReport\getServiceRow().

static 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
bool$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 782 of file ExtensionManagementUtility.php.

static getBaseTcaCacheIdentifier ( )
staticprotected

Cache identifier of base TCA cache entry.

Returns
string

Definition at line 1840 of file ExtensionManagementUtility.php.

References $GLOBALS.

static getCacheManager ( )
staticprotected

Getter for the cache manager

Returns

Definition at line 75 of file ExtensionManagementUtility.php.

References GeneralUtility\makeInstance().

static getCN (   $key)
static

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

Parameters
string$keyExtension key
Returns
string

Definition at line 186 of file ExtensionManagementUtility.php.

Referenced by ExtensionManagementUtilityTest\getClassNamePrefixForExtensionKey().

static getExtensionIcon (   $extensionPath,
  $returnFullPath = false 
)
static

Find extension icon

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

Definition at line 1576 of file ExtensionManagementUtility.php.

Referenced by ListUtility\getAvailableExtensions(), ExtensionRepository\getExtensionIconWithPath(), MiscUtility\getIcon(), LoadedExtensionArrayElement\initializeExtensionIcon(), NewRecordController\regularNew(), and IconViewHelper\renderStatic().

static 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 (bool) if something went wrong

Definition at line 197 of file ExtensionManagementUtility.php.

Referenced by ExtensionManagementUtilityTest\getExtensionKeyByPrefixForNotLoadedExtensionReturnsFalse().

static 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
InvalidArgumentException
TYPO3
Returns
string The extension version as a string in the format "x.y.z",

Definition at line 236 of file ExtensionManagementUtility.php.

Referenced by DependencyUtility\isLoadedVersionCompatible().

static getExtLocalconfCacheIdentifier ( )
staticprotected

Cache identifier of concatenated ext_localconf file

Returns
string

Definition at line 1693 of file ExtensionManagementUtility.php.

References $GLOBALS.

static getExtTablesCacheIdentifier ( )
staticprotected

Cache identifier for concatenated ext_tables.php files

Returns
string

Definition at line 1947 of file ExtensionManagementUtility.php.

References $GLOBALS.

static getFileFieldTCAConfig (   $fieldName,
array  $customSettingOverride = [],
  $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 561 of file ExtensionManagementUtility.php.

References ArrayUtility\mergeRecursiveWithOverrule().

static getLoadedExtensionListArray ( )
static

Gets an array of loaded extension keys

Returns
array Loaded extensions

Definition at line 1977 of file ExtensionManagementUtility.php.

Referenced by ImportExportController\makeAdvancedOptionsForm(), ActionController\toggleExtensionInstallationStateAction(), and DownloadController\updateExtensionAction().

static getSignalSlotDispatcher ( )
staticprotected

Getter for the signal slot dispatcher

Returns

Definition at line 93 of file ExtensionManagementUtility.php.

References $signalSlotDispatcher, and GeneralUtility\makeInstance().

static insertModuleFunction (   $modname,
  $className,
  $classPath = null,
  $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 1015 of file ExtensionManagementUtility.php.

References $GLOBALS.

static isLoaded (   $key,
  $exitOnError = false 
)
static

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

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

Definition at line 114 of file ExtensionManagementUtility.php.

Referenced by Plaintext\applyToolbarConstraints(), Language\applyToolbarConstraints(), Plaintext\buildJavascriptConfiguration(), ExtensionManagerConfigurationUtility\checkConfigurationBackend(), ExtensionManagerConfigurationUtility\checkConfigurationFrontend(), LanguageIsoCodeUpdate\checkForUpdate(), ContentTypesToTextMediaUpdate\checkForUpdate(), TableFlexFormToTtContentFieldsUpdate\checkForUpdate(), WorkspacesNotificationSettingsUpdate\checkForUpdate(), MediaceExtractionUpdate\checkForUpdate(), StatusReportConflictsCheckHook\checkIfNoConflictingExtensionIsInstalled(), Import\checkImportPrerequisites(), PageRepository\checkWorkspaceAccess(), SilentConfigurationUpgradeService\configureBackendLoginSecurity(), ClickMenu\DB_perms(), ImportExport\displayContentOverview(), UninstallExtension\executeAction(), BackendUtility\fixVersioningPid(), CleanerCommand\genTree(), DatabaseRecordList\getButtons(), Typo3Status\getCompatibility6Status(), DatabaseRecordList\getDocHeaderButtons(), TemplatePaths\getExtensionPrivateResourcesPath(), GeneralUtility\getFileAbsFileName(), MiscUtility\getIcon(), Language\getLanguages(), DocumentRepository\getMetadata(), BackendUtility\getPagesTSconfig(), DocumentTemplate\getSkinStylesheetDirectories(), TranslationConfigurationProvider\getSystemLanguages(), DocumentTemplate\getVersionSelector(), BackendUtility\getWorkspaceVersionOfRecord(), TemplateService\includeStaticTypoScriptSources(), EditDocumentController\init(), AdminPanelView\initialize(), DownloadController\installDistributionAction(), DependencyUtility\isDependentExtensionLoaded(), ExtensionManagementUtilityTest\isLoadedReturnsFalseIfExtensionIsNotLoadedAndExitIsDisabled(), ExtensionManagementUtilityTest\isLoadedThrowsExceptionIfExtensionIsNotLoaded(), FormResultCompiler\JSbottom(), Language\main(), Spellchecker\main(), Abbreviation\main(), DatabaseRecordList\makeControl(), QueryView\makeStoreControl(), TemplateService\mergeConstantsFromIncludedTsConfigFiles(), Clipboard\printClipboard(), QueryView\procesStoreControl(), IsExtensionLoadedViewHelper\renderStatic(), TypoScriptFrontendController\whichWorkspace(), and BackendUtility\workspaceOL().

static 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
bool Service availability

Definition at line 1263 of file ExtensionManagementUtility.php.

References CommandUtility\checkCommand(), and GeneralUtility\trimExplode().

static 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
RuntimeException

Definition at line 1992 of file ExtensionManagementUtility.php.

static loadSingleExtLocalconfFiles ( )
staticprotected

Execute ext_localconf.php files from extensions

Returns
void

Definition at line 1630 of file ExtensionManagementUtility.php.

References $_EXTCONF, and $GLOBALS.

static loadSingleExtTablesFiles ( )
staticprotected

Load ext_tables.php as single files

Returns
void

Definition at line 1880 of file ExtensionManagementUtility.php.

References $_EXTCONF, and $GLOBALS.

static 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!
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 991 of file ExtensionManagementUtility.php.

References $GLOBALS, and GeneralUtility\logDeprecatedFunction().

static 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 974 of file ExtensionManagementUtility.php.

References $GLOBALS.

Referenced by Bootstrap\registerExtDirectComponents().

static registerPageTSConfigFile (   $extKey,
  $filePath,
  $title 
)
static

Call this method to add an entry in the pageTSconfig list found in pages FOR USE in Configuration/TCA/Overrides/pages.php Use the latter to benefit from TCA caching!

Parameters
string$extKeyThe extension key
string$filePathThe path where the TSconfig file is located
string$titleThe title in the selector box
Returns
void

Definition at line 1473 of file ExtensionManagementUtility.php.

References $GLOBALS.

static 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 1967 of file ExtensionManagementUtility.php.

static 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, field_c'
  • insertion: 'field_b, field_d, field_c' -> 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 717 of file ExtensionManagementUtility.php.

static 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
RuntimeException

Definition at line 2010 of file ExtensionManagementUtility.php.

Referenced by UninstallExtension\executeAction().

Member Data Documentation

$cacheManager
staticprotected
$extensionKeyMap
staticprotected

Definition at line 34 of file ExtensionManagementUtility.php.

$extTablesWasReadFromCacheOnce = false
staticprotected

Definition at line 46 of file ExtensionManagementUtility.php.

$packageManager
staticprotected
$signalSlotDispatcher
staticprotected

Definition at line 86 of file ExtensionManagementUtility.php.