t3lib_extMgm Class Reference

List of all members.

Public Member Functions
	addFieldsToUserSettings ($addFields, $insertionPosition= '')
Static Public Member Functions
static	isLoaded ($key, $exitOnError=0)
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=0)
static	addToAllTCAtypes ($table, $str, $specificTypesList= '', $position= '')
static	addFieldsToAllPalettesOfField ($table, $field, $addFields, $insertionPosition= '')
static	addFieldsToPalette ($table, $palette, $addFields, $insertionPosition= '')
static	allowTableOnStandardPages ($table)
static	addModule ($main, $sub= '', $position= '', $path= '')
static	addModulePath ($name, $path)
static	insertModuleFunction ($modname, $className, $classPath, $title, $MM_key= 'function', $WS= '')
static	addPageTSConfig ($content)
static	addUserTSConfig ($content)
static	addLLrefForTCAdescr ($tca_descr_key, $file_ref)
static	addNavigationComponent ($module, $componentId)
static	addCoreNavigationComponent ($module, $componentId)
static	addService ($extKey, $serviceType, $serviceKey, $info)
static	findService ($serviceType, $serviceSubType= '', $excludeServiceKeys=array())
static	deactivateService ($serviceType, $serviceKey)
static	addPlugin ($itemArray, $type= 'list_type')
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	typo3_loadExtensions ()
static	_makeIncludeHeader ($key, $file)
static	isCacheFilesAvailable ($cacheFilePrefix)
static	isLocalconfWritable ()
static	cannotCacheFilesWritable ($cacheFilePrefix)
static	currentCacheFiles ($cacheFilePrefix=NULL)
static	writeCacheFiles ($extensions, $cacheFilePrefix)
static	removeCacheFiles ($cacheFilePrefix=NULL)
static	getExtensionCacheBehaviour ($usePlainValue=FALSE)
static	getCacheFilePrefix ()
static	getEnabledExtensionList ()
static	getRequiredExtensionList ()
static	getIgnoredExtensionList ()
Static Protected Member Functions
static	executePositionedStringInsertion ($list, $insertionList, $insertionPosition= '')
static	removeDuplicatesForInsertion ($insertionList, $list= '')
static	getInsertionNeedles ($item, array $itemDetails)
static	explodeItemList ($itemList)
static	generateItemList (array $items, $useRawData=FALSE)
Static Protected Attributes
static	$extensionKeyMap

---

Detailed Description

Definition at line 100 of file class.t3lib_extmgm.php.

---

Member Function Documentation

static t3lib_extMgm::_makeIncludeHeader	(	$	key,
		$	file
	)		[static]

Returns the section headers for the compiled cache-files.

Parameters:

string	$key	is the extension key
string	$file	is the filename (only informative for comment)

Returns:

string

Definition at line 1375 of file class.t3lib_extmgm.php.

References $_EXTCONF, and $TYPO3_CONF_VARS.

static t3lib_extMgm::addCoreNavigationComponent	(	$	module,
		$	componentId
	)		[static]

Registers a core navigation component

Parameters:

string	$module
string	$componentId

Returns:

void

Definition at line 864 of file class.t3lib_extmgm.php.

References $GLOBALS, $module, and addNavigationComponent().

static t3lib_extMgm::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	$table,:	Name of the table
string	$field,:	Name of the field that has the palette to be extended
string	$addFields,:	List of fields to be added to the palette
string	$insertionPosition,:	Insert fields before (default) or after one of this fields (commalist with "before:", "after:" or "replace:" commands). Example: "before:keywords,--palette--;;4,after:description". Palettes must be passed like in the example no matter how the palette definition looks like in TCA.

Returns:

void

Definition at line 372 of file class.t3lib_extmgm.php.

References $GLOBALS, $items, addFieldsToPalette(), explodeItemList(), generateItemList(), and t3lib_div\loadTCA().

Referenced by t3lib_extmgmTest\canAddFieldsToAllPalettesOfFieldAfterExistingOnes(), t3lib_extmgmTest\canAddFieldsToAllPalettesOfFieldAfterNotExistingOnes(), t3lib_extmgmTest\canAddFieldsToAllPalettesOfFieldBeforeExistingOnes(), and t3lib_extmgmTest\canAddFieldsToAllPalettesOfFieldWithoutPaletteExistingBefore().

static t3lib_extMgm::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	$table,:	Name of the table
string	$palette,:	Name of the palette to be extended
string	$addFields,:	List of fields to be added to the palette
string	$insertionPosition,:	Insert fields before (default) or after one of this fields (commalist with "before:", "after:" or "replace:" commands). Example: "before:keywords,--palette--;;4,after:description". Palettes must be passed like in the example no matter how the palette definition looks like in TCA.

Returns:

void

Definition at line 422 of file class.t3lib_extmgm.php.

References $GLOBALS, executePositionedStringInsertion(), t3lib_div\loadTCA(), and removeDuplicatesForInsertion().

Referenced by addFieldsToAllPalettesOfField(), addToAllTCAtypes(), t3lib_extmgmTest\canAddFieldsToPaletteAfterExistingOnes(), t3lib_extmgmTest\canAddFieldsToPaletteAfterNotExistingOnes(), and t3lib_extmgmTest\canAddFieldsToPaletteBeforeExistingOnes().

t3lib_extMgm::addFieldsToUserSettings	(	$	addFields,
		$	insertionPosition = ''
	)

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	$addFields,:	List of fields to be added to the user settings
string	$insertionPosition,:	Insert fields before (default) or after one of this fields (commalist with "before:", "after:" or "replace:" commands). Example: "before:password,after:email".

Returns:

void

Definition at line 452 of file class.t3lib_extmgm.php.

References $GLOBALS, and executePositionedStringInsertion().

static t3lib_extMgm::addLLrefForTCAdescr	(	$	tca_descr_key,
		$	file_ref
	)		[static]

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

Parameters:

string	Description key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
string	File reference to locallang file, eg. "EXT:lang/locallang_csh_pages.php" (or ".xml")

Returns:

void

Definition at line 829 of file class.t3lib_extmgm.php.

static t3lib_extMgm::addModule	(	$	main,
		$	sub = '',
		$	position = '',
		$	path = ''
	)		[static]

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

Parameters:

string	$main	is the 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	$sub	is the submodule key. If $sub is not set a blank $main module is created.
string	$position	can 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	$path	is the 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.

Returns:

void

Definition at line 695 of file class.t3lib_extmgm.php.

References $TBE_MODULES, and t3lib_div\trimExplode().

Referenced by Tx_Extbase_Utility_Extension\registerModule().

static t3lib_extMgm::addModulePath	(	$	name,
		$	path
	)		[static]

Adds a module path to 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: t3lib_extMgm::addModulePath('xMOD_tximpexp', t3lib_extMgm::extPath($_EXTKEY).'app/');

Parameters:

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

Returns:

void

Definition at line 759 of file class.t3lib_extmgm.php.

References $TBE_MODULES.

static t3lib_extMgm::addNavigationComponent	(	$	module,
		$	componentId
	)		[static]

Registers a navigation component

Parameters:

string	$module
string	$componentId

Returns:

void

Definition at line 849 of file class.t3lib_extmgm.php.

References $GLOBALS, and $module.

Referenced by addCoreNavigationComponent().

static t3lib_extMgm::addPageTSConfig

(

$

content

)

[static]

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

Parameters:

string

Page TSconfig content

Returns:

void

Definition at line 800 of file class.t3lib_extmgm.php.

References $content, and $TYPO3_CONF_VARS.

static t3lib_extMgm::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. Usage: 0

Parameters:

string	Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
string	Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
string	Value 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 1083 of file class.t3lib_extmgm.php.

References $TCA, $value, and t3lib_div\loadTCA().

static t3lib_extMgm::addPItoST43	(	$	key,
		$	classFile = '',
		$	prefix = '',
		$	type = 'list_type',
		$	cached = 0
	)		[static]

Add PlugIn to 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. 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" $type determines the type of frontend plugin: "list_type" (default) - the good old "Insert plugin" entry "menu_type" - a "Menu/Sitemap" entry "splash_layout" - a "Textbox" 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 $TCA[tt_content] where you added the selector item for the element! See addPlugin() function) FOR USE IN ext_localconf.php FILES Usage: 2

Parameters:

string	$key	is the extension key
string	$classFile	is the PHP-class filename relative to the extension root directory. If set to blank a default value is chosen according to convensions.
string	$prefix	is used as a - yes, suffix - of the class name (fx. "_pi1")
string	$type,see	description above
	boolean	If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.

Returns:

void

Definition at line 1134 of file class.t3lib_extmgm.php.

References $addLine, $pluginContent, $TYPO3_LOADED_EXT, addTypoScript(), and getCN().

static t3lib_extMgm::addPlugin	(	$	itemArray,
		$	type = 'list_type'
	)		[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 $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 Usage: 13

Parameters:

array	Item Array
string	Type (eg. "list_type") - basically a field from "tt_content" table

Returns:

void

Definition at line 1052 of file class.t3lib_extmgm.php.

References $GLOBALS, $TCA, extRelPath(), and t3lib_div\loadTCA().

Referenced by Tx_Extbase_Utility_Extension\registerPlugin().

static t3lib_extMgm::addService	(	$	extKey,
		$	serviceType,
		$	serviceKey,
		$	info
	)		[static]

Adds a service to the global services array

Parameters:

string	Extension key
string	Service type, cannot be prefixed "tx_"
string	Service key, must be prefixed "tx_" or "user_"
array	Service description array

Returns:

void

Author:

René Fritz <r.fritz@colorcube.de>

Definition at line 888 of file class.t3lib_extmgm.php.

References $T3_SERVICES, $TYPO3_CONF_VARS, deactivateService(), t3lib_div\isFirstPartOfStr(), and t3lib_div\trimExplode().

static t3lib_extMgm::addStaticFile	(	$	extKey,
		$	path,
		$	title
	)		[static]

Call this method to add an entry in the static template list found in sys_templates "static template files" are the modern equalent (provided from extensions) to the traditional records in "static_templates" FOR USE IN ext_localconf.php FILES Usage: 3

Parameters:

string	$extKey	is of course the extension key
string	$path	is the path where the template files (fixed names) include_static.txt (integer list of uids from the table "static_templates"), constants.txt, setup.txt, editorcfg.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 commaseperated list of static templates to include, like: EXT:css_styled_content/static/,EXT:da_newsletter_subscription/static/,EXT:cc_random_image/pi2/static/
string	$title	is the title in the selector box.

Returns:

void

See also:

addTypoScript()

Definition at line 1200 of file class.t3lib_extmgm.php.

References $TCA, $value, and t3lib_div\loadTCA().

static t3lib_extMgm::addTCAcolumns	(	$	table,
		$	columnArray,
		$	addTofeInterface = 0
	)		[static]

Adding fields to an existing table definition in $TCA Adds an array with $TCA column-configuration to the $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 Usage: 4

Parameters:

string	$table	is the table name of a table already present in $TCA with a columns section
array	$columnArray	is the array with the additional columns (typical some fields an extension wants to add)
	boolean	If $addTofeInterface is true the list of fields are also added to the fe_admin_fieldList.

Returns:

void

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

References $TCA, and t3lib_div\loadTCA().

static t3lib_extMgm::addToAllTCAtypes	(	$	table,
		$	str,
		$	specificTypesList = '',
		$	position = ''
	)		[static]

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

Adds a string $str (comma list of field names) to all ["types"][xxx]["showitem"] entries for table $table (unless limited by $specificTypesList) 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 Usage: 1

Parameters:

string	Table name
string	Field list to add.
string	List of specific types to add the field list to. (If empty, all type entries are affected)
string	Insert fields before (default) or after one of this fields (commalist with "before:", "after:" or "replace:" commands). Example: "before:keywords,--palette--;;4,after:description". Palettes must be passed like in the example no matter how the palette definition looks like in TCA. It will add the list of new fields before or after a palette or replace the field inside the palette, when the field given in $position is found inside a palette used by the type.

Returns:

void

Definition at line 303 of file class.t3lib_extmgm.php.

References $GLOBALS, addFieldsToPalette(), executePositionedStringInsertion(), t3lib_div\inList(), t3lib_div\loadTCA(), and t3lib_div\trimExplode().

Referenced by t3lib_extmgmTest\canAddFieldsToAllTCATypesAfterExistingOnes(), t3lib_extmgmTest\canAddFieldsToAllTCATypesBeforeExistingOnes(), t3lib_extmgmTest\canAddFieldsToTCATypeAfterExistingOnes(), and t3lib_extmgmTest\canAddFieldsToTCATypeBeforeExistingOnes().

static t3lib_extMgm::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 Usage: 9

Parameters:

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

Returns:

void

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

References $TCA, and t3lib_div\loadTCA().

static t3lib_extMgm::addTypoScript	(	$	key,
		$	type,
		$	content,
		$	afterStaticUid = 0
	)		[static]

Adds $content to the default TypoScript code for either setup, constants or editorcfg as set in $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 Usage: 7

Parameters:

string	$key	is the extension key (informative only).
string	$type	is either "setup", "constants" or "editorcfg" and obviously determines which kind of TypoScript code we are adding.
string	$content	is the TS content, prefixed with a [GLOBAL] line and a comment-header.
string	$afterStaticUid	is 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 1250 of file class.t3lib_extmgm.php.

References $content, and $TYPO3_CONF_VARS.

Referenced by addPItoST43(), and Tx_Extbase_Utility_Extension\configurePlugin().

static t3lib_extMgm::addTypoScriptConstants

(

$

content

)

[static]

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

Parameters:

string

TypoScript Constants string

Returns:

void

Definition at line 1233 of file class.t3lib_extmgm.php.

References $content, and $TYPO3_CONF_VARS.

static t3lib_extMgm::addTypoScriptSetup

(

$

content

)

[static]

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

Parameters:

string

TypoScript Setup string

Returns:

void

Definition at line 1219 of file class.t3lib_extmgm.php.

References $content, and $TYPO3_CONF_VARS.

static t3lib_extMgm::addUserTSConfig

(

$

content

)

[static]

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

Parameters:

string

User TSconfig content

Returns:

void

Definition at line 814 of file class.t3lib_extmgm.php.

References $content, and $TYPO3_CONF_VARS.

static t3lib_extMgm::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 Usage: 11

Parameters:

string

Table name

Returns:

void

Definition at line 678 of file class.t3lib_extmgm.php.

References $PAGES_TYPES.

static t3lib_extMgm::cannotCacheFilesWritable

(

$

cacheFilePrefix

)

[static]

Returns an error string if typo3conf/ or cache-files with $cacheFilePrefix are NOT writable Returns false if no problem. Usage: 1

Parameters:

string

Prefix of the cache file to check

Returns:

string

Definition at line 1422 of file class.t3lib_extmgm.php.

Referenced by typo3_loadExtensions().

static t3lib_extMgm::clearExtensionKeyMap

(

)

[static]

Clears the extension key map.

Returns:

void

Definition at line 224 of file class.t3lib_extmgm.php.

Referenced by t3lib_extmgmTest\getExtensionKeyByPrefixForLoadedExtensionWithoutUnderscoresReturnsExtensionKey(), t3lib_extmgmTest\getExtensionKeyByPrefixForLoadedExtensionWithUnderscoresReturnsExtensionKey(), t3lib_extmgmTest\getExtensionKeyByPrefixForNotLoadedExtensionReturnsFalse(), t3lib_extmgmTest\getExtensionVersionForLoadedExtensionReturnsExtensionVersion(), t3lib_extmgmTest\getExtensionVersionForNotLoadedExtensionReturnsEmptyString(), and t3lib_extmgmTest\tearDown().

static t3lib_extMgm::currentCacheFiles

(

$

cacheFilePrefix = NULL

)

[static]

Returns an array with the two cache-files (0=>localconf, 1=>tables) from typo3conf/ if they (both) exist. Otherwise false. Evaluation relies on $TYPO3_LOADED_EXT['_CACHEFILE'] Usage: 2

Parameters:

string

$cacheFilePrefix

Cache file prefix to be used (optional)

Returns:

array

Definition at line 1447 of file class.t3lib_extmgm.php.

References $GLOBALS.

static t3lib_extMgm::deactivateService	(	$	serviceType,
		$	serviceKey
	)		[static]

Deactivate a service

Parameters:

string	Service type
string	Service key

Returns:

void

Author:

René Fritz <r.fritz@colorcube.de>

Definition at line 1025 of file class.t3lib_extmgm.php.

References $T3_SERVICES.

Referenced by addService(), findService(), and t3lib_div\makeInstanceService().

static t3lib_extMgm::executePositionedStringInsertion	(	$	list,
		$	insertionList,
		$	insertionPosition = ''
	)		[static, protected]

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

Parameters:

string	$list,:	The list of items to be extended
string	$insertionList,:	The list of items to inserted
string	$insertionPosition,:	Insert fields before (default) or after one of this fields (commalist with "before:" or "after:" commands). Example: "before:keywords,--palette--;;4,after:description". Palettes must be passed like in the example no matter how the palette definition looks like in TCA.

Returns:

string The extended list

Definition at line 473 of file class.t3lib_extmgm.php.

References $items, explodeItemList(), generateItemList(), getInsertionNeedles(), removeDuplicatesForInsertion(), and t3lib_div\trimExplode().

Referenced by addFieldsToPalette(), addFieldsToUserSettings(), and addToAllTCAtypes().

static t3lib_extMgm::explodeItemList

(

$

itemList

)

[static, protected]

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

Parameters:

string

$itemList,:

List of fields/items to be splitted up (this mostly reflects the data in $TCA[ ['types'][<type>]['showitem'])

Returns:

array An array with the names of the fields/items as keys and additional information

Definition at line 612 of file class.t3lib_extmgm.php.

References $items, and t3lib_div\trimExplode().

Referenced by addFieldsToAllPalettesOfField(), and executePositionedStringInsertion().

static t3lib_extMgm::extPath	(	$	key,
		$	script = ''
	)		[static]

Returns the absolute path to the extension with extension key $key If the extension is not loaded the function will die with an error message Useful for internal fileoperations Usage: 136

Parameters:

	string	Extension key
string	$script	is appended to the output if set.

Returns:

string

Definition at line 139 of file class.t3lib_extmgm.php.

References $TYPO3_LOADED_EXT.

Referenced by tx_reports_Module\__construct(), tx_em_API\__construct(), SC_mod_user_task_index\__construct(), tx_em_Extensions_Details\__construct(), tx_em_Install\__construct(), t3lib_autoloader\attemptToLoadRegistryForGivenClassName(), tx_saltedpasswords_sv1\authUser(), tx_install\checkTheImageProcessing(), tx_lowlevel_cleaner_core\cli_main(), Tx_Extbase_Utility_Extension\configureModule(), FakeDbConnection\connect(), tx_dbal_installtool\createConnectionForm(), tx_dbal_tsparserext\displayMessage(), tx_install\displayTwinImage(), tx_version_tasks_AutoPublish\execute(), Tx_Fluid_Compatibility_DocbookGeneratorService\getClassNamesInNamespace(), t3lib_div\getFileAbsFileName(), t3lib_TStemplate\getFileName(), Tx_Fluid_View_TemplateView\getLayoutRootPath(), Tx_Fluid_View_TemplateView\getPartialRootPath(), Tx_Fluid_View_TemplateView\getTemplateRootPath(), ux_t3lib_DB\handler_init(), tx_indexedsearch_indexer\includeCrawlerClass(), tx_openid_sv1\includePHPOpenIDLibrary(), t3lib_TStemplate\includeStaticTypoScriptSources(), tx_dbal_handler_openoffice\init(), tx_scheduler_Module\init(), tslib_eidtools\initExtensionTCA(), tx_recycler_module1\initialize(), tx_linkvalidator_ModFuncReport\initialize(), tx_tstemplateceditor\initialize_editor(), tx_install\isGIF(), tx_install\isPNG(), Tx_Extbase_Utility_ClassLoader\loadClass(), tx_indexedsearch_crawler\loadIndexerClass(), tx_indexedsearch_files\loadIndexerClass(), TYPO3backend\loadResourcesForRegisteredNavigationComponents(), tx_rtehtmlarea_language\main(), tx_tsconfighelp_module1\moduleContent(), tx_t3editor_TSrefLoader\processAjaxRequest(), SC_db_new\regularNew(), tx_em_ExtensionManager\render(), tx_t3editor_hooks_tstemplateinfo\save(), and tx_em_Connection_ExtDirectServer\saveLanguageSelection().

static t3lib_extMgm::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 Usage: 54

Parameters:

string

Extension key

Returns:

string

Definition at line 159 of file class.t3lib_extmgm.php.

References $TYPO3_LOADED_EXT.

Referenced by tx_em_ExtensionManager\__construct(), tx_sysactionToolbarMenu\addCssToBackend(), tx_opendocs\addCssToBackend(), WorkspaceSelectorToolbarItem\addJavascriptToBackend(), tx_sysactionToolbarMenu\addJavascriptToBackend(), tx_opendocs\addJavascriptToBackend(), addPlugin(), tx_rtehtmlarea_base\addSkin(), clickMenu\DB_newWizard(), clickMenu\DB_perms(), tx_install\displayTwinImage(), tx_rtehtmlarea_base\drawRTE(), tslib_AdminPanel\ext_makeToolBar(), Tx_Workspaces_Controller_PreviewController\generateJavascript(), TYPO3backend\generateJavascript(), tx_sv_reports_ServicesList\getReport(), template\getSkinStylesheetDirectories(), tx_version_gui\getVersionSelector(), tx_reports_Module\indexAction(), SC_mod_user_task_index\indexAction(), tx_scheduler_Module\init(), SC_mod_tools_isearch_index\init(), SC_file_upload\init(), tx_recycler_module1\initialize(), tx_linkvalidator_ModFuncReport\initialize(), Tx_Workspaces_Controller_PreviewController\initializeAction(), Tx_Workspaces_Controller_AbstractController\initializeAction(), Tx_Workspaces_Controller_ReviewController\initializeAction(), TYPO3backend\loadResourcesForRegisteredNavigationComponents(), tx_version_cm1\main(), tx_impexp_task\main(), SC_mod_tools_log_index\main(), localRecordList\makeControl(), Tx_Extbase_Utility_Extension\registerModule(), SC_db_new\regularNew(), SC_mod_user_task_index\renderListMenu(), SC_db_layout\renderQuickEdit(), and tx_sysaction_task\viewSqlQuery().

static t3lib_extMgm::findService	(	$	serviceType,
		$	serviceSubType = '',
		$	excludeServiceKeys = array()
	)		[static]

Find the available service with highest priority

Parameters:

string	Service type
string	Service sub type
mixed	Service 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, FLASE otherwise

Author:

René Fritz <r.fritz@colorcube.de>

Definition at line 956 of file class.t3lib_extmgm.php.

References $T3_SERVICES, $TYPO3_CONF_VARS, t3lib_exec\checkCommand(), deactivateService(), and t3lib_div\trimExplode().

Referenced by t3lib_div\makeInstanceService().

static t3lib_extMgm::generateItemList	(	array $	items,
		$	useRawData = FALSE
	)		[static, protected]

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

See also:

explodeItemList

Parameters:

array	$items,:	The array of fields/items with optional additional information
boolean	$useRawData,:	Use raw data instead of building by using the details (default: false)

Returns:

string The list of fields/items which gets used for $TCA[ ['types'][<type>]['showitem'] or $TCA[ ['palettes'][<palette>]['showitem'] in most cases

Definition at line 650 of file class.t3lib_extmgm.php.

Referenced by addFieldsToAllPalettesOfField(), and executePositionedStringInsertion().

static t3lib_extMgm::getCacheFilePrefix

(

)

[static]

Gets the prefix used for the ext_tables.php and ext_localconf.php cached files.

Returns:

string

Definition at line 1558 of file class.t3lib_extmgm.php.

Referenced by typo3_loadExtensions(), and tx_install\updateWizard().

static t3lib_extMgm::getCN

(

$

key

)

[static]

Returns the correct class name prefix for the extension key $key Usage: 3

Parameters:

string

Extension key

Returns:

string

Definition at line 191 of file class.t3lib_extmgm.php.

Referenced by addPItoST43().

static t3lib_extMgm::getEnabledExtensionList

(

)

[static]

Gets the list of enabled extensions for the accordant context (frontend or backend).

Returns:

string

Definition at line 1578 of file class.t3lib_extmgm.php.

Referenced by t3lib_extmgmTest\getEnabledExtensionListConsidersRequiredAndIgnoredExtensions(), t3lib_extmgmTest\getEnabledExtensionListConsidersRequiredExtensions(), and typo3_loadExtensions().

static t3lib_extMgm::getExtensionCacheBehaviour

(

$

usePlainValue = FALSE

)

[static]

Gets the behaviour for caching ext_tables.php and ext_localconf.php files (see $TYPO3_CONF_VARS['EXT']['extCache'] setting in the install tool).

Parameters:

boolean

$usePlainValue

Whether to use the value as it is without modifications

Returns:

integer

Definition at line 1542 of file class.t3lib_extmgm.php.

Referenced by typo3_loadExtensions().

static t3lib_extMgm::getExtensionKeyByPrefix

(

$

prefix

)

[static]

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

Parameters:

string

$prefix,:

The extension prefix (e.g. 'tx_ttnews')

Returns:

mixed Real extension key (string) or false (boolean) if something went wrong

Definition at line 201 of file class.t3lib_extmgm.php.

References $GLOBALS.

Referenced by t3lib_autoloader\attemptToLoadRegistryForGivenClassName(), t3lib_extmgmTest\getExtensionKeyByPrefixForLoadedExtensionWithoutUnderscoresReturnsExtensionKey(), t3lib_extmgmTest\getExtensionKeyByPrefixForLoadedExtensionWithUnderscoresReturnsExtensionKey(), and t3lib_extmgmTest\getExtensionKeyByPrefixForNotLoadedExtensionReturnsFalse().

static t3lib_extMgm::getExtensionVersion

(

$

key

)

[static]

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

Parameters:

string

$key

the key of the extension to look up, must not be empty

Returns:

string the extension version as a string in the format "x.y.z", will be an empty string if the extension is not loaded

Definition at line 236 of file class.t3lib_extmgm.php.

References $EM_CONF.

Referenced by t3lib_extmgmTest\getExtensionVersionForFaultyExtensionKeyThrowsException(), t3lib_extmgmTest\getExtensionVersionForLoadedExtensionReturnsExtensionVersion(), and t3lib_extmgmTest\getExtensionVersionForNotLoadedExtensionReturnsEmptyString().

static t3lib_extMgm::getIgnoredExtensionList

(

)

[static]

Gets the list of extensions to be ignored (not to be loaded).

Returns:

string

Definition at line 1622 of file class.t3lib_extmgm.php.

static t3lib_extMgm::getInsertionNeedles	(	$	item,
		array $	itemDetails
	)		[static, protected]

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

See also:

executePositionedStringInsertion

Parameters:

string	$item,:	The name of the field/item
array	$itemDetails,:	Additional details of the field/item like e.g. palette information (this array gets created by the function explodeItemList())

Returns:

array The needled to be used for inserting content before or after existing fields/items

Definition at line 582 of file class.t3lib_extmgm.php.

Referenced by executePositionedStringInsertion().

static t3lib_extMgm::getRequiredExtensionList

(

)

[static]

Gets the list of required extensions.

Returns:

string

Definition at line 1609 of file class.t3lib_extmgm.php.

Referenced by SC_mod_tools_em_index\init(), tx_em_Extensions_List\removeRequiredExtFromListArr(), and tx_em_Extensions_List\singleExtInfo().

static t3lib_extMgm::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 Usage: 26

Parameters:

string	Module name
string	Class name
string	Class path
string	Title of module
string	Menu array key - default is "function"
string	Workspace conditions. Blank means all workspaces, any other string can be a comma list of "online", "offline" and "custom"

Returns:

void

See also:

t3lib_SCbase::mergeExternalItems()

Definition at line 781 of file class.t3lib_extmgm.php.

static t3lib_extMgm::isCacheFilesAvailable

(

$

cacheFilePrefix

)

[static]

Returns true if both the localconf and tables cache file exists (with $cacheFilePrefix) Usage: 2

Parameters:

string

Prefix of the cache file to check

Returns:

boolean

Definition at line 1396 of file class.t3lib_extmgm.php.

static t3lib_extMgm::isLoaded	(	$	key,
		$	exitOnError = 0
	)		[static]

Returns true if the extension with extension key $key is loaded. Usage: 109

Parameters:

string	Extension key to test
boolean	If $exitOnError is true and the extension is not loaded the function will die with an error message

Returns:

boolean

Definition at line 118 of file class.t3lib_extmgm.php.

References $TYPO3_LOADED_EXT.

Referenced by Tx_Fluid_View_StandaloneView\__construct(), tx_version_cm1\adminLinks(), tx_rtehtmlarea_plaintext\applyToolbarConstraints(), tx_rtehtmlarea_language\applyToolbarConstraints(), tx_saltedpasswords_sv1\authUser(), tx_rtehtmlarea_plaintext\buildJavascriptConfiguration(), WorkspaceSelectorToolbarItem\checkAccess(), tx_saltedpasswords_emconfhelper\checkConfigurationBackend(), tx_install\checkDatabase(), tx_em_Install\checkDependencies(), tx_coreupdates_t3skin\checkForUpdate(), tx_coreupdates_statictemplates\checkForUpdate(), tx_coreupdates_migrateworkspaces\checkForUpdate(), tx_coreupdates_installnewsysexts\checkForUpdate(), tx_coreupdates_installsysexts\checkForUpdate(), tx_rtehtmlarea_statusReport_conflictsCheck\checkIfNoConflictingExtensionIsInstalled(), t3lib_loadModules\checkMod(), tx_install\checkTheDatabase(), t3lib_userAuthGroup\checkWorkspace(), t3lib_pageSelect\checkWorkspaceAccess(), t3lib_TCEmain\clear_cache(), t3lib_TCEmain\clear_cacheCmd(), clickMenu\DB_edit(), clickMenu\DB_newWizard(), clickMenu\DB_perms(), tx_impexp\displayContentOverview(), tx_rtehtmlarea_pi2\drawRTE(), tx_rtehtmlarea_base\drawRTE(), SC_alt_doc\editRegularContentFromId(), tx_dbal_autoloader\execute(), local_beUserAuth\ext_getReadableButNonmounted(), tslib_AdminPanel\ext_makeToolBar(), local_beUserAuth\ext_workspaceMembership(), tx_em_Install\extDelete(), SC_mod_tools_em_index\extensionList_import(), tx_em_Extensions_List\extensionList_installed(), tx_em_Extensions_List\extensionListRow(), tx_em_Extensions_Details\extInformationarray(), tx_indexedsearch_indexer\extractLinks(), t3lib_userAuthGroup\fetchGroupData(), t3lib_BEfunc\firstDomainRecord(), t3lib_BEfunc\fixVersioningPid(), SC_mod_tools_dbint_index\func_records(), Tx_Workspaces_Controller_PreviewController\generateJavascript(), TYPO3backend\generateJavascript(), tx_install\generateUpdateDatabaseForm(), t3lib_admin\genTree(), tx_lowlevel_cleaner_core\genTree(), t3lib_TCEforms\getAdditionalPreviewLanguages(), t3lib_flexformtools\getAvailableLanguages(), t3lib_TCEforms\getAvailableLanguages(), SC_alt_doc\getButtons(), t3lib_userAuthGroup\getDefaultWorkspace(), t3lib_BEfunc\getDomainStartPage(), t3lib_div\getFileAbsFileName(), t3lib_TStemplate\getFileName(), tx_em_Extensions_List\getInstExtList(), tx_rtehtmlarea_language\getLanguages(), t3lib_BEfunc\getListViewLink(), TYPO3backend\getLoggedInUserLabel(), tx_cms_layout\getPageInfoBox(), ShortcutMenu\getShortcutIcon(), template\getSkinStylesheetDirectories(), t3lib_transl8tools\getSystemLanguages(), tx_cms_layout\getTable_sys_note(), tx_cms_layout\getTableMenu(), tx_coreupdates_installnewsysexts\getUserInput(), tx_coreupdates_migrateworkspaces\getUserInput(), template\getVersionSelector(), SC_alt_db_navframe\getWorkspaceInfo(), t3lib_BEfunc\getWorkspaceVersionOfRecord(), TYPO3backend\handlePageEditing(), tx_indexedsearch_tslib_fe_hook\headerNoCache(), tx_indexedsearch_indexer\hook_indexContent(), t3lib_TStemplate\includeStaticTypoScriptSources(), t3lib_browseTree\init(), t3lib_pageTree\init(), tx_dbal_handler_openoffice\init(), SC_wizard_tsconfig\init(), tx_em_Install\installExtension(), SC_mod_tools_em_index\installExtension(), t3lib_TCEmain\internal_clearPageCache(), t3lib_TCEforms\isDisplayCondition(), tslib_feUserAuth\isExistingSessionRecord(), Tx_Extbase_Utility_ClassLoader\loadClass(), tx_rtehtmlarea_spellchecker\main(), tx_rtehtmlarea_acronym\main(), tx_rtehtmlarea_language\main(), tx_wizardsortpages_webfunc_2\main(), tx_cms_webinfo_page\main(), SC_alt_doc_nodoc\main(), SC_db_list\main(), tx_tstemplateobjbrowser\main(), tx_tstemplateinfo\main(), localRecordList\makeControl(), tx_em_Install\makeDetailedExtensionAnalysis(), tslib_fe\makeSimulFileName(), t3lib_fullsearch\makeStoreControl(), SC_mod_tools_log_index\menuConfig(), tx_tsconfighelp_module1\moduleContent(), SC_mod_web_ts_index\noTemplate(), tx_cms_layout\pages_drawItem(), tx_coreupdates_t3skin\performUpdate(), tx_coreupdates_statictemplates\performUpdate(), t3lib_fullsearch\procesStoreControl(), SC_db_new\regularNew(), tslib_content_FluidTemplate\render(), SC_db_layout\renderQuickEdit(), SC_mod_tools_em_index\requestInstallExtensions(), t3lib_fullsearch\saveQueryInAction(), SC_alt_doc\setDocument(), tslib_fe\settingLanguage(), SC_mod_tools_em_index\showExtDetails(), tx_em_Extensions_List\showExtensionsToUpdate(), recordList\showSysNotesForPage(), tslib_fe\simulateStaticDocuments_pEnc_onlyP_proc(), tx_em_Extensions_List\singleExtInfo(), tslib_fe\statistics(), tx_em_Install\tsStyleConfigForm(), tx_tsconfighelp_module1\unzip(), tx_sysaction_task\viewSqlQuery(), tslib_fe\whichWorkspace(), t3lib_userAuthGroup\workspaceCheckStageForCurrent(), t3lib_BEfunc\workspaceOL(), SC_alt_shortcut\workspaceSelector(), and SC_index\wrapLoginForm().

static t3lib_extMgm::isLocalconfWritable

(

)

[static]

Returns true if the "localconf.php" file in "typo3conf/" is writable Usage: 1

Returns:

boolean

Definition at line 1409 of file class.t3lib_extmgm.php.

Referenced by SC_mod_tools_em_index\installExtension(), and SC_mod_tools_em_index\showExtDetails().

static t3lib_extMgm::removeCacheFiles

(

$

cacheFilePrefix = NULL

)

[static]

Unlink (delete) cache files

Parameters:

string

$cacheFilePrefix

Cache file prefix to be used (optional)

Returns:

integer Number of deleted files.

Definition at line 1520 of file class.t3lib_extmgm.php.

Referenced by tx_em_Install\installExtension(), tx_dbal_autoloader\updateExtensionList(), tx_install\updateWizard(), tx_coreupdates_t3skin\writeNewExtensionList(), tx_coreupdates_installnewsysexts\writeNewExtensionList(), and tx_coreupdates_installsysexts\writeNewExtensionList().

static t3lib_extMgm::removeDuplicatesForInsertion	(	$	insertionList,
		$	list = ''
	)		[static, protected]

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'

Parameters:

string	$insertionList,:	The list of items to inserted
string	$list,:	The list of items to be extended (default: '')

Returns:

string Duplicate-free list of items to be inserted

Definition at line 544 of file class.t3lib_extmgm.php.

Referenced by addFieldsToPalette(), and executePositionedStringInsertion().

static t3lib_extMgm::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 Usage: 6

Parameters:

string

Extension key

Returns:

string

Definition at line 179 of file class.t3lib_extmgm.php.

Referenced by tx_reports_Module\__construct(), SC_mod_user_task_index\__construct(), tx_rtehtmlarea_base\addSkin(), tx_rtehtmlarea_pi2\drawRTE(), tslib_cObj\filelink(), tx_openid_sv1\getBackPath(), t3lib_TStemplate\getFileName(), tx_rsaauth_loginformhook\getLoginScripts(), tx_rtehtmlarea_api\getPathToPluginDirectory(), tx_rsaauth_feloginhook\loginFormHook(), tx_rtehtmlarea_pi1\main(), and tslib_fe\setAbsRefPrefix().

static t3lib_extMgm::typo3_loadExtensions

(

)

[static]

Loading extensions configured in $TYPO3_CONF_VARS['EXT']['extList']

CACHING ON: ($TYPO3_CONF_VARS['EXT']['extCache'] = 1 or 2) If caching is enabled (and possible), the output will be $extensions['_CACHEFILE'] set to the cacheFilePrefix. Subsequently the cache files must be included then since those will eventually set up the extensions. If cachefiles are not found they will be generated CACHING OFF: ($TYPO3_CONF_VARS['EXT']['extCache'] = 0) The returned value will be an array where each key is an extension key and the value is an array with filepaths for the extension. This array will later be set in the global var $TYPO3_LOADED_EXT

Usages of this function can be seen in config_default.php Extensions are always detected in the order local - global - system. Usage: 1

Returns:

array Extension Array

Definition at line 1300 of file class.t3lib_extmgm.php.

References $TYPO3_CONF_VARS, cannotCacheFilesWritable(), getCacheFilePrefix(), getEnabledExtensionList(), getExtensionCacheBehaviour(), t3lib_div\trimExplode(), and writeCacheFiles().

Referenced by tx_em_Tools\refreshGlobalExtList().

static t3lib_extMgm::writeCacheFiles	(	$	extensions,
		$	cacheFilePrefix
	)		[static]

Compiles/Creates the two cache-files in typo3conf/ based on $cacheFilePrefix Returns a array with the key "_CACHEFILE" set to the $cacheFilePrefix value Usage: 1

Parameters:

array	Extension information array
string	Prefix for the cache files

Returns:

array

Definition at line 1479 of file class.t3lib_extmgm.php.

Referenced by typo3_loadExtensions().

---

Member Data Documentation

t3lib_extMgm::$extensionKeyMap [static, protected]

Definition at line 101 of file class.t3lib_extmgm.php.

---

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

• t3lib/class.t3lib_extmgm.php