t3lib_extMgm Class Reference

List of all members.

Public Member Functions
	isLoaded ($key, $exitOnError=0)
	Returns true if the extension with extension key $key is loaded.
	extPath ($key, $script='')
	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.
	extRelPath ($key)
	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.
	siteRelPath ($key)
	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.
	getCN ($key)
	Returns the correct class name prefix for the extension key $key Usage: 3.
	addTCAcolumns ($table, $columnArray, $addTofeInterface=0)
	Adding fields to an existing table definition in $TCA Adds an array with $TCA column-configuration to the $TCA-entry for that table.
	addToAllTCAtypes ($table, $str, $specificTypesList='', $position='')
	Makes fields visible in the TCEforms, adding them to the end of (all) "types"-configurations.
	allowTableOnStandardPages ($table)
	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.
	addModule ($main, $sub='', $position='', $path='')
	Adds a module (main or sub) to the backend interface FOR USE IN ext_tables.php FILES Usage: 18.
	insertModuleFunction ($modname, $className, $classPath, $title, $MM_key='function')
	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.
	addPageTSConfig ($content)
	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_locallang.php FILES Usage: 5.
	addUserTSConfig ($content)
	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_locallang.php FILES Usage: 3.
	addLLrefForTCAdescr ($tca_descr_key, $file_ref)
	Adds a reference to a locallang file with TCA_DESCR labels FOR USE IN ext_tables.php FILES eg.
	addService ($extKey, $serviceType, $serviceKey, $info)
	Adds a service to the global services array.
	findService ($serviceType, $serviceSubType='', $excludeServiceKeys=array())
	Find the available service with highest priority.
	deactivateService ($serviceType, $serviceKey)
	Deactivate a service.
	addPlugin ($itemArray, $type='list_type')
	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.
	addPiFlexFormValue ($piKeyToMatch, $value)
	Adds an entry to the "ds" array of the tt_content field "pi_flexform".
	addToInsertRecords ($table, $content_table='tt_content', $content_field='records')
	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.
	addPItoST43 ($key, $classFile='', $prefix='', $type='list_type', $cached=0)
	Add PlugIn to Static Template #43.
	addStaticFile ($extKey, $path, $title)
	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_locallang.php FILES Usage: 3.
	addTypoScriptSetup ($content)
	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_locallang.php FILES Usage: 6.
	addTypoScriptConstants ($content)
	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_locallang.php FILES Usage: 0.
	addTypoScript ($key, $type, $content, $afterStaticUid=0)
	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_locallang.php FILES Usage: 7.
	typo3_loadExtensions ()
	Loading extensions configured in $TYPO3_CONF_VARS['EXT']['extList'].
	_makeIncludeHeader ($key, $file)
	Returns the section headers for the compiled cache-files.
	isCacheFilesAvailable ($cacheFilePrefix)
	Returns true if both the localconf and tables cache file exists (with $cacheFilePrefix) Usage: 2.
	isLocalconfWritable ()
	Returns true if the "localconf.php" file in "typo3conf/" is writable Usage: 1.
	cannotCacheFilesWritable ($cacheFilePrefix)
	Returns an error string if typo3conf/ or cache-files with $cacheFilePrefix are NOT writable Returns false if no problem.
	currentCacheFiles ()
	Returns an array with the two cache-files (0=>localconf, 1=>tables) from typo3conf/ if they (both) exist.
	writeCacheFiles ($extensions, $cacheFilePrefix)
	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.

---

Member Function Documentation

t3lib_extMgm::_makeIncludeHeader (  $  key, $  file )

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 998 of file class.t3lib_extmgm.php. References $TYPO3_CONF_VARS. Referenced by writeCacheFiles(). { return '<?php ########################### ## EXTENSION: '.$key.' ## FILE: '.$file.' ########################### $_EXTKEY = \''.$key.'\'; $_EXTCONF = $TYPO3_CONF_VARS[\'EXT\'][\'extConf\'][$_EXTKEY]; ?>'; }

t3lib_extMgm::addLLrefForTCAdescr (  $  tca_descr_key, $  file_ref )

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 438 of file class.t3lib_extmgm.php. { global $TCA_DESCR; if ($tca_descr_key) { if (!is_array($TCA_DESCR[$tca_descr_key])) { $TCA_DESCR[$tca_descr_key]=array(); } if (!is_array($TCA_DESCR[$tca_descr_key]['refs'])) { $TCA_DESCR[$tca_descr_key]['refs']=array(); } $TCA_DESCR[$tca_descr_key]['refs'][]=$file_ref; } }

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

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 329 of file class.t3lib_extmgm.php. References $TBE_MODULES, and main(). { global $TBE_MODULES; if (isset($TBE_MODULES[$main]) && $sub) { // If there is already a main module by this name: // Adding the submodule to the correct position: list($place,$modRef)=t3lib_div::trimExplode(':',$position,1); $mods = t3lib_div::trimExplode(',',$TBE_MODULES[$main],1); if (!in_array($sub,$mods)) { switch(strtolower($place)) { case 'after': case 'before': $pointer=0; reset($mods); while(list($k,$m)=each($mods)) { if (!strcmp($m,$modRef)) { $pointer=strtolower($place)=='after'?$k+1:$k; } } array_splice( $mods, // The modules array $pointer, // To insert one position from the end of the list 0, // Don't remove any items, just insert $sub // Module to insert ); break; default: if (strtolower($place)=='top') { array_unshift($mods,$sub); } else { array_push($mods,$sub); } break; } } // Re-inserting the submodule list: $TBE_MODULES[$main]=implode(',',$mods); } else { // Create new main modules with only one submodule, $sub (or none if $sub is blank) $TBE_MODULES[$main]=$sub; } // Adding path: if ($path) { $TBE_MODULES['_PATHS'][$main.($sub?'_'.$sub:'')]=$path; } }

t3lib_extMgm::addPageTSConfig (  $  content  )

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_locallang.php FILES Usage: 5. Parameters: string  Page TSconfig content Returns: void Definition at line 409 of file class.t3lib_extmgm.php. References $TYPO3_CONF_VARS. { global $TYPO3_CONF_VARS; $TYPO3_CONF_VARS['BE']['defaultPageTSconfig'].="\n[GLOBAL]\n".$content; }

t3lib_extMgm::addPiFlexFormValue (  $  piKeyToMatch, $  value )

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. Usage: 0 Parameters: string  The same value as the key for the plugin string  Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly. Returns: void See also: addPlugin() Definition at line 680 of file class.t3lib_extmgm.php. References $TCA. { global $TCA; t3lib_div::loadTCA('tt_content'); if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns']['pi_flexform']['config']['ds'])) { $TCA['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch] = $value; } }

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

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_locallang.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 731 of file class.t3lib_extmgm.php. References getCN(), and siteRelPath(). { global $TYPO3_LOADED_EXT; $classFile = $classFile ? $classFile : 'pi/class.tx_'.str_replace('_','',$key).$prefix.'.php'; $cN = t3lib_extMgm::getCN($key); // General plugin: if ($cached) { $pluginContent = trim(' includeLibs.'.$cN.$prefix.' = '.$TYPO3_LOADED_EXT[$key]['siteRelPath'].$classFile.' plugin.'.$cN.$prefix.' = USER plugin.'.$cN.$prefix.' { userFunc = '.$cN.$prefix.'->main }'); } else { $pluginContent = trim(' plugin.'.$cN.$prefix.' = USER_INT plugin.'.$cN.$prefix.' { includeLibs = '.$TYPO3_LOADED_EXT[$key]['siteRelPath'].$classFile.' userFunc = '.$cN.$prefix.'->main }'); } t3lib_extMgm::addTypoScript($key,'setup',' # Setting '.$key.' plugin TypoScript '.$pluginContent); // After ST43: switch($type) { case 'list_type': $addLine = 'tt_content.list.20.'.$key.$prefix.' = < plugin.'.$cN.$prefix; break; case 'menu_type': $addLine = 'tt_content.menu.20.'.$key.$prefix.' = < plugin.'.$cN.$prefix; break; case 'splash_layout': $addLine = 'tt_content.splash.'.$key.$prefix.' = < plugin.'.$cN.$prefix; break; case 'CType': $addLine = trim(' tt_content.'.$key.$prefix.' = COA tt_content.'.$key.$prefix.' { 10 = < lib.stdheader 20 = < plugin.'.$cN.$prefix.' } '); break; case 'header_layout': $addLine = 'lib.stdheader.10.'.$key.$prefix.' = < plugin.'.$cN.$prefix; break; case 'includeLib': $addLine = 'page.1000 = < plugin.'.$cN.$prefix; break; default: $addLine = ''; break; } if ($addLine) { t3lib_extMgm::addTypoScript($key,'setup',' # Setting '.$key.' plugin TypoScript '.$addLine.' ',43); } }

t3lib_extMgm::addPlugin (  $  itemArray, $  type = 'list_type' )

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 655 of file class.t3lib_extmgm.php. References $TCA. { global $TCA; t3lib_div::loadTCA('tt_content'); if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns'][$type]['config']['items'])) { reset($TCA['tt_content']['columns'][$type]['config']['items']); while(list($k,$v)=each($TCA['tt_content']['columns'][$type]['config']['items'])) { if (!strcmp($v[1],$itemArray[1])) { $TCA['tt_content']['columns'][$type]['config']['items'][$k]=$itemArray; return; } } $TCA['tt_content']['columns'][$type]['config']['items'][]=$itemArray; } }

t3lib_extMgm::addService (  $  extKey, $  serviceType, $  serviceKey, $  info )

Adds a service to the global services array. Parameters: string  Extension key string  Service type string  Service key array  Service description array Returns: void Author: René Fritz <r.fritz@colorcube.de> Definition at line 480 of file class.t3lib_extmgm.php. References $T3_SERVICES, and deactivateService(). { global $T3_SERVICES,$TYPO3_CONF_VARS; // even not available services will be included to make it possible to give the admin a feedback of non-available services. // but maybe it's better to move non-available services to a different array?? if ($serviceType AND substr($serviceType,0,3)!='tx_' AND substr($serviceKey,0,3)=='tx_' AND is_array($info)) { $info['priority'] = max(0,min(100,$info['priority'])); $T3_SERVICES[$serviceType][$serviceKey]=$info; $T3_SERVICES[$serviceType][$serviceKey]['extKey'] = $extKey; $T3_SERVICES[$serviceType][$serviceKey]['serviceKey'] = $serviceKey; $T3_SERVICES[$serviceType][$serviceKey]['serviceType'] = $serviceType; // mapping a service key to a service type // all service keys begin with tx_ - service types don't // this way a selection of a special service key as service type is easy $T3_SERVICES[$serviceKey][$serviceKey] = &$T3_SERVICES[$serviceType][$serviceKey]; // change the priority (and other values) from TYPO3_CONF_VARS // $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]['priority'] // even the activation is possible (a unix service might be possible on windows for some reasons) if (is_array($TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey])) { // no check is done here - there might be configuration values only the service type knows about, so we pass everything $T3_SERVICES[$serviceType][$serviceKey] = array_merge ($T3_SERVICES[$serviceType][$serviceKey],$TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]); } // OS check // empty $os means 'not limited to one OS', therefore a check is not needed if ($T3_SERVICES[$serviceType][$serviceKey]['available'] AND $T3_SERVICES[$serviceType][$serviceKey]['os']!='') { // TYPO3_OS is not yet defined $os_type = stristr(PHP_OS,'win')&&!stristr(PHP_OS,'darwin')?'WIN':'UNIX'; $os = t3lib_div::trimExplode(',',strtoupper($T3_SERVICES[$serviceType][$serviceKey]['os'])); if (!in_array($os_type,$os)) { t3lib_extMgm::deactivateService($serviceType, $serviceKey); } } // convert subtype list to array for quicker access $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'] = array(); $serviceSubTypes = t3lib_div::trimExplode(',',$info['subtype']); foreach ($serviceSubTypes as $subtype) { $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'][$subtype] = $subtype; } } }

t3lib_extMgm::addStaticFile (  $  extKey, $  path, $  title )

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_locallang.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 and editorcfg.txt is found (relative to extPath, eg. 'static/') string  $title is the title in the selector box. Returns: void See also: addTypoScript() Definition at line 806 of file class.t3lib_extmgm.php. { global $TCA; t3lib_div::loadTCA('sys_template'); if ($extKey && $path && is_array($TCA['sys_template']['columns'])) { $value = str_replace(',','','EXT:'.$extKey.'/'.$path); $itemArray=array(trim($title.' ('.$extKey.')'),$value); $TCA['sys_template']['columns']['include_static_file']['config']['items'][]=$itemArray; } }

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

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 226 of file class.t3lib_extmgm.php. References $TCA, and table(). { global $TCA; t3lib_div::loadTCA($table); if (is_array($columnArray) && is_array($TCA[$table]) && is_array($TCA[$table]['columns'])) { $TCA[$table]['columns'] = array_merge($TCA[$table]['columns'],$columnArray); // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble... if ($addTofeInterface) $TCA[$table]['feInterface']['fe_admin_fieldList'].=','.implode(',',array_keys($columnArray)); } }

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

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:" 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: void Definition at line 250 of file class.t3lib_extmgm.php. References $TCA, and table(). { global $TCA; $positionArr=t3lib_div::trimExplode(',',$position,1); $insert=count($position); t3lib_div::loadTCA($table); if (trim($str) && is_array($TCA[$table]) && is_array($TCA[$table]['types'])) { foreach($TCA[$table]['types'] as $k => $v) { if (!$specificTypesList || t3lib_div::inList($specificTypesList,$k)) { if ($insert) { $append=true; $showItem = t3lib_div::trimExplode(',',$TCA[$table]['types'][$k]['showitem'],1); foreach($showItem as $key => $fieldInfo) { $parts = explode(';',$fieldInfo); $theField = trim($parts[0]); $palette = trim($parts[0]).';;'.trim($parts[2]); // insert before: find exact field name or palette with number if (in_array($theField, $positionArr) OR in_array($palette, $positionArr) OR in_array('before:'.$theField, $positionArr) OR in_array('before:'.$palette, $positionArr)) { $showItem[$key]=trim($str).', '.$fieldInfo; $append=false; break; } // insert after if (in_array('after:'.$theField, $positionArr) OR in_array('after:'.$palette, $positionArr)) { $showItem[$key]=$fieldInfo.', '.trim($str); $append=false; break; } } // Not found? Then append. if($append) { $showItem[]=trim($str); } $TCA[$table]['types'][$k]['showitem']=implode(', ', $showItem); } else { $TCA[$table]['types'][$k]['showitem'].=', '.trim($str); } } } } }

t3lib_extMgm::addToInsertRecords (  $  table, $  content_table = 'tt_content', $  content_field = 'records' )

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 700 of file class.t3lib_extmgm.php. References $TCA. { global $TCA; t3lib_div::loadTCA($content_table); if (is_array($TCA[$content_table]['columns']) && isset($TCA[$content_table]['columns'][$content_field]['config']['allowed'])) { $TCA[$content_table]['columns'][$content_field]['config']['allowed'].=','.$table; } }

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

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_locallang.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 856 of file class.t3lib_extmgm.php. References $content, and $TYPO3_CONF_VARS. { global $TYPO3_CONF_VARS; if ($type=='setup' || $type=='editorcfg' || $type=='constants') { $content = ' [GLOBAL] ############################################# ## TypoScript added by extension "'.$key.'" ############################################# '.$content; if ($afterStaticUid) { $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.'][$afterStaticUid].=$content; if ($afterStaticUid==43) { // If 'content (default)' is targeted, also add to other 'content rendering templates', eg. css_styled_content $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.']['cssstyledcontent/static/'].=$content; } } else { $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type].=$content; } } }

t3lib_extMgm::addTypoScriptConstants (  $  content  )

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_locallang.php FILES Usage: 0. Parameters: string  TypoScript Constants string Returns: void Definition at line 839 of file class.t3lib_extmgm.php. References $TYPO3_CONF_VARS. { global $TYPO3_CONF_VARS; $TYPO3_CONF_VARS['FE']['defaultTypoScript_constants'].="\n[GLOBAL]\n".$content; }

t3lib_extMgm::addTypoScriptSetup (  $  content  )

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_locallang.php FILES Usage: 6. Parameters: string  TypoScript Setup string Returns: void Definition at line 825 of file class.t3lib_extmgm.php. References $TYPO3_CONF_VARS. { global $TYPO3_CONF_VARS; $TYPO3_CONF_VARS['FE']['defaultTypoScript_setup'].="\n[GLOBAL]\n".$content; }

t3lib_extMgm::addUserTSConfig (  $  content  )

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_locallang.php FILES Usage: 3. Parameters: string  User TSconfig content Returns: void Definition at line 423 of file class.t3lib_extmgm.php. References $TYPO3_CONF_VARS. { global $TYPO3_CONF_VARS; $TYPO3_CONF_VARS['BE']['defaultUserTSconfig'].="\n[GLOBAL]\n".$content; }

t3lib_extMgm::allowTableOnStandardPages (  $  table  )

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 312 of file class.t3lib_extmgm.php. References $PAGES_TYPES. { global $PAGES_TYPES; $PAGES_TYPES['default']['allowedTables'].=','.$table; }

t3lib_extMgm::cannotCacheFilesWritable (  $  cacheFilePrefix  )

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 1045 of file class.t3lib_extmgm.php. References error(), and PATH_typo3conf. Referenced by typo3_loadExtensions(). { $error=array(); if (!@is_writeable(PATH_typo3conf)) { $error[]=PATH_typo3conf; } if (@is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php') && !@is_writeable(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php')) { $error[]=PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php'; } if (@is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php') && !@is_writeable(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php')) { $error[]=PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php'; } return implode(', ',$error); }

t3lib_extMgm::currentCacheFiles (   )

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 Returns: array Definition at line 1069 of file class.t3lib_extmgm.php. References isCacheFilesAvailable(), and PATH_typo3conf. Referenced by t3lib_TCEmain::removeCacheFiles(). { global $TYPO3_LOADED_EXT; if ($TYPO3_LOADED_EXT['_CACHEFILE']) { if (t3lib_extMgm::isCacheFilesAvailable($TYPO3_LOADED_EXT['_CACHEFILE'])) { return array( PATH_typo3conf.$TYPO3_LOADED_EXT['_CACHEFILE'].'_ext_localconf.php', PATH_typo3conf.$TYPO3_LOADED_EXT['_CACHEFILE'].'_ext_tables.php' ); } } }

t3lib_extMgm::deactivateService (  $  serviceType, $  serviceKey )

Deactivate a service. Parameters: string  Service type string  Service key Returns: void Author: René Fritz <r.fritz@colorcube.de> Definition at line 616 of file class.t3lib_extmgm.php. References $T3_SERVICES. Referenced by addService(), t3lib_svbase::deactivateService(), and findService(). { global $T3_SERVICES; // ... maybe it's better to move non-available services to a different array?? $T3_SERVICES[$serviceType][$serviceKey]['available'] = FALSE; }

t3lib_extMgm::extPath (  $  key, $  script = '' )

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 146 of file class.t3lib_extmgm.php. References extPath(), PATH_site, and siteRelPath(). Referenced by tx_install::checkTheImageProcessing(), tx_install::displayTwinImage(), extPath(), and siteRelPath(). { global $TYPO3_LOADED_EXT; if (!isset($TYPO3_LOADED_EXT[$key])) { #debug(array(debug_backtrace())); die('TYPO3 Fatal Error: Extension key "'.$key.'" was NOT loaded! (t3lib_extMgm::extPath)'); } return PATH_site.$TYPO3_LOADED_EXT[$key]['siteRelPath'].$script; }

t3lib_extMgm::extRelPath (  $  key  )

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 164 of file class.t3lib_extmgm.php. References extRelPath(). Referenced by extRelPath(), and SC_db_new::regularNew(). { global $TYPO3_LOADED_EXT; if (!isset($TYPO3_LOADED_EXT[$key])) { die('TYPO3 Fatal Error: Extension key "'.$key.'" was NOT loaded! (t3lib_extMgm::extRelPath)'); } return $TYPO3_LOADED_EXT[$key]['typo3RelPath']; }

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

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 545 of file class.t3lib_extmgm.php. References $T3_SERVICES, t3lib_exec::checkCommand(), deactivateService(), and PATH_t3lib. { global $T3_SERVICES; $serviceKey = FALSE; $serviceInfo = FALSE; $priority = 0; $quality = 0; if (!is_array($excludeServiceKeys) ) { $excludeServiceKeys = t3lib_div::trimExplode(',', $excludeServiceKeys, 1); } if (is_array($T3_SERVICES[$serviceType])) { foreach($T3_SERVICES[$serviceType] as $key => $info) { if (in_array($key, $excludeServiceKeys)) { continue; } // select a subtype randomly // usefull to start a service by service key without knowing his subtypes - for testing purposes if ($serviceSubType=='*') { $serviceSubType = key($info['serviceSubTypes']); } // this matches empty subtype too if( $info['available'] AND ($info['subtype']==$serviceSubType OR $info['serviceSubTypes'][$serviceSubType]) AND $info['priority']>=$priority ) { // has a lower quality than the already found, therefore we skip this service if($info['priority']==$priority AND $info['quality']<$quality) { continue; } // service depends on external programs - check if they exists if(trim($info['exec'])) { require_once(PATH_t3lib.'class.t3lib_exec.php'); $executables = t3lib_div::trimExplode(',', $info['exec'],1); foreach($executables as $executable) { if(!t3lib_exec::checkCommand($executable)) { t3lib_extMgm::deactivateService($serviceType, $key); $info['available']=FALSE; break; } } } // still available after exec check? if($info['available']) { $serviceKey = $key; $priority = $info['priority']; $quality = $info['quality']; } } } } if ($serviceKey) { $serviceInfo = $T3_SERVICES[$serviceType][$serviceKey]; } return $serviceInfo; }

t3lib_extMgm::getCN (  $  key  )

Returns the correct class name prefix for the extension key $key Usage: 3. Parameters: string  Extension key Returns: string Definition at line 193 of file class.t3lib_extmgm.php. Referenced by addPItoST43(). { return substr($key,0,5)=='user_' ? 'user_'.str_replace('_','',substr($key,5)) : 'tx_'.str_replace('_','',$key); }

t3lib_extMgm::insertModuleFunction (  $  modname, $  className, $  classPath, $  title, $  MM_key = 'function' )

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" Returns: void See also: t3lib_SCbase::mergeExternalItems() Definition at line 391 of file class.t3lib_extmgm.php. { global $TBE_MODULES_EXT; $TBE_MODULES_EXT[$modname]['MOD_MENU'][$MM_key][$className]=array( 'name' => $className, 'path' => $classPath, 'title' => $title, ); }

t3lib_extMgm::isCacheFilesAvailable (  $  cacheFilePrefix  )

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 1019 of file class.t3lib_extmgm.php. References PATH_typo3conf. Referenced by currentCacheFiles(), and typo3_loadExtensions(). { return @is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php') && @is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php'); }

t3lib_extMgm::isLoaded (  $  key, $  exitOnError = 0 )

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 130 of file class.t3lib_extmgm.php. Referenced by t3lib_TCEmain::clear_cache(), t3lib_TCEmain::clear_cacheCmd(), tslib_cObj::cObjGetSingle(), SC_alt_main::editPageHandling(), SC_alt_shortcut::editPageIdFunc(), SC_alt_doc::editRegularContentFromId(), SC_mod_tools_em_index::extDelete(), SC_mod_tools_em_index::extensionList_import(), SC_mod_tools_em_index::extensionList_installed(), SC_mod_tools_em_index::extensionListRow(), SC_mod_tools_em_index::extInformationArray(), t3lib_userAuthGroup::fetchGroupData(), firstDomainRecord(), getDomainStartPage(), tx_cms_layout::getPageInfoBox(), getSingleField_typeFlex_sheetMenu(), tx_cms_layout::getTable_sys_note(), tx_cms_layout::getTableMenu(), getVersionSelector(), SC_mod_tools_em_index::importExtFromRep(), SC_wizard_tsconfig::init(), t3lib_pageTree::init(), t3lib_browseTree::init(), tx_wizardsortpages_webfunc_2::main(), tx_wizardcrpages_webfunc_2::main(), tx_cms_webinfo_page::main(), SC_mod_user_setup_index::main(), SC_alt_shortcut::main(), SC_alt_doc_nodoc::main(), SC_alt_doc::makeButtonPanel(), SC_mod_tools_em_index::makeDetailedExtensionAnalysis(), t3lib_fullsearch::makeStoreControl(), t3lib_positionMap::onClickEvent(), tx_cms_layout::pages_drawItem(), SC_db_new::regularNew(), SC_db_layout::renderQuickEdit(), t3lib_fullsearch::saveQueryInAction(), SC_alt_doc::setDocument(), tslib_fe::settingLanguage(), SC_mod_tools_em_index::showExtDetails(), tslib_fe::statistics(), SC_mod_user_setup_index::storeIncomingData(), and t3lib_beUserAuth::trackBeUser(). { global $TYPO3_LOADED_EXT; if ($exitOnError && !isset($TYPO3_LOADED_EXT[$key])) die('Fatal Error: Extension "'.$key.'" was not loaded.'); return isset($TYPO3_LOADED_EXT[$key]); }

t3lib_extMgm::isLocalconfWritable (   )

Returns true if the "localconf.php" file in "typo3conf/" is writable Usage: 1. Returns: boolean Definition at line 1032 of file class.t3lib_extmgm.php. References PATH_typo3conf. Referenced by SC_mod_tools_em_index::showExtDetails(). { return is_writeable(PATH_typo3conf) && is_writeable(PATH_typo3conf.'localconf.php'); }

t3lib_extMgm::siteRelPath (  $  key  )

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 181 of file class.t3lib_extmgm.php. References extPath(), and PATH_site. Referenced by addPItoST43(), extPath(), and tslib_pibase::pi_loadLL(). { return substr(t3lib_extMgm::extPath($key),strlen(PATH_site)); }

t3lib_extMgm::typo3_loadExtensions (   )

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 919 of file class.t3lib_extmgm.php. References $TYPO3_CONF_VARS, cannotCacheFilesWritable(), isCacheFilesAvailable(), PATH_site, TYPO3_mainDir, and writeCacheFiles(). { global $TYPO3_CONF_VARS; // Full list of extensions includes both required and extList: $rawExtList = $TYPO3_CONF_VARS['EXT']['requiredExt'].','.$TYPO3_CONF_VARS['EXT']['extList']; // Empty array as a start. $extensions = array(); // if ($rawExtList) { // The cached File prefix. $cacheFilePrefix = 'temp_CACHED'; // Setting the name for the cache files: if (intval($TYPO3_CONF_VARS['EXT']['extCache'])==1) $cacheFilePrefix.= '_ps'.substr(t3lib_div::shortMD5(PATH_site.'|'.$GLOBALS['TYPO_VERSION']),0,4); if (intval($TYPO3_CONF_VARS['EXT']['extCache'])==2) $cacheFilePrefix.= '_'.t3lib_div::shortMD5($rawExtList); // If cache files available, set cache file prefix and return: if ($TYPO3_CONF_VARS['EXT']['extCache'] && t3lib_extMgm::isCacheFilesAvailable($cacheFilePrefix)) { // Return cache file prefix: $extensions['_CACHEFILE'] = $cacheFilePrefix; } else { // ... but if not, configure... $temp_extensions = array_unique(t3lib_div::trimExplode(',',$rawExtList,1)); while(list(,$temp_extKey)=each($temp_extensions)) { if (@is_dir(PATH_site.'typo3conf/ext/'.$temp_extKey)) { $extensions[$temp_extKey]=array('type'=>'L','siteRelPath'=>'typo3conf/ext/'.$temp_extKey.'/','typo3RelPath'=>'../typo3conf/ext/'.$temp_extKey.'/'); } elseif (@is_dir(PATH_site.TYPO3_mainDir.'ext/'.$temp_extKey)) { $extensions[$temp_extKey]=array('type'=>'G','siteRelPath'=>TYPO3_mainDir.'ext/'.$temp_extKey.'/','typo3RelPath'=>'ext/'.$temp_extKey.'/'); } elseif (@is_dir(PATH_site.TYPO3_mainDir.'sysext/'.$temp_extKey)) { $extensions[$temp_extKey]=array('type'=>'S','siteRelPath'=>TYPO3_mainDir.'sysext/'.$temp_extKey.'/','typo3RelPath'=>'sysext/'.$temp_extKey.'/'); } $files = t3lib_div::trimExplode(',',' ext_localconf.php, ext_tables.php, ext_tables.sql, ext_tables_static+adt.sql, ext_typoscript_constants.txt, ext_typoscript_editorcfg.txt, ext_typoscript_setup.txt ',1); reset($files); while(list(,$fName)=each($files)) { $temp_filename = PATH_site.$extensions[$temp_extKey]['siteRelPath'].trim($fName); if (is_array($extensions[$temp_extKey]) && @is_file($temp_filename)) { $extensions[$temp_extKey][$fName]=$temp_filename; } } } unset($extensions['_CACHEFILE']); // write cache? if ($TYPO3_CONF_VARS['EXT']['extCache']) { $wrError = t3lib_extMgm::cannotCacheFilesWritable($cacheFilePrefix); if ($wrError) { //debug('Cannot write cache files: '.$wrError.'. Disabling the cache...'); $TYPO3_CONF_VARS['EXT']['extCache']=0; } else { // Write cache files: $extensions = t3lib_extMgm::writeCacheFiles($extensions,$cacheFilePrefix); } } } } #debug($extensions); return $extensions; }

t3lib_extMgm::writeCacheFiles (  $  extensions, $  cacheFilePrefix )

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 1092 of file class.t3lib_extmgm.php. References _makeIncludeHeader(), and PATH_typo3conf. Referenced by typo3_loadExtensions(). { // Making cache files: $extensions['_CACHEFILE'] = $cacheFilePrefix; $cFiles=array(); $cFiles['ext_localconf'].='<?php $TYPO3_LOADED_EXT = unserialize(stripslashes(\''.addslashes(serialize($extensions)).'\')); ?>'; reset($extensions); while(list($key,$conf)=each($extensions)) { if (is_array($conf)) { if ($conf['ext_localconf.php']) { $cFiles['ext_localconf'].=t3lib_extMgm::_makeIncludeHeader($key,$conf['ext_localconf.php']); $cFiles['ext_localconf'].=trim(t3lib_div::getUrl($conf['ext_localconf.php'])); } if ($conf['ext_tables.php']) { $cFiles['ext_tables'].=t3lib_extMgm::_makeIncludeHeader($key,$conf['ext_tables.php']); $cFiles['ext_tables'].=trim(t3lib_div::getUrl($conf['ext_tables.php'])); } } } t3lib_div::writeFile(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php',$cFiles['ext_localconf']); t3lib_div::writeFile(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php',$cFiles['ext_tables']); $extensions=array(); $extensions['_CACHEFILE'] = $cacheFilePrefix; return $extensions; }

---

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

• t3lib/class.t3lib_extmgm.php

---