Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0 3.8.1 4.0.0 4.0.1 4.1.0 <- Available in other TYPO3 versions

t3lib_extMgm Class Reference


Public Member Functions
	isLoaded ($key, $exitOnError=0)
	extPath ($key, $script='')
	extRelPath ($key)
	siteRelPath ($key)
	getCN ($key)
	addTCAcolumns ($table, $columnArray, $addTofeInterface=0)
	addToAllTCAtypes ($table, $str, $specificTypesList='', $position='')
	allowTableOnStandardPages ($table)
	addModule ($main, $sub='', $position='', $path='')
	insertModuleFunction ($modname, $className, $classPath, $title, $MM_key='function')
	addPageTSConfig ($content)
	addUserTSConfig ($content)
	addLLrefForTCAdescr ($tca_descr_key, $file_ref)
	addService ($extKey, $serviceType, $serviceKey, $info)
	findService ($serviceType, $serviceSubType='', $excludeServiceKeys=array())
	deactivateService ($serviceType, $serviceKey)
	addPlugin ($itemArray, $type='list_type')
	addPiFlexFormValue ($piKeyToMatch, $value)
	addToInsertRecords ($table, $content_table='tt_content', $content_field='records')
	addPItoST43 ($key, $classFile='', $prefix='', $type='list_type', $cached=0)
	addStaticFile ($extKey, $path, $title)
	addTypoScriptSetup ($content)
	addTypoScriptConstants ($content)
	addTypoScript ($key, $type, $content, $afterStaticUid=0)
	typo3_loadExtensions ()
	_makeIncludeHeader ($key, $file)
	isCacheFilesAvailable ($cacheFilePrefix)
	isLocalconfWritable ()
	cannotCacheFilesWritable ($cacheFilePrefix)
	currentCacheFiles ()
	writeCacheFiles ($extensions, $cacheFilePrefix)
	isLoaded ($key, $exitOnError=0)
	extPath ($key, $script='')
	extRelPath ($key)
	siteRelPath ($key)
	getCN ($key)
	addTCAcolumns ($table, $columnArray, $addTofeInterface=0)
	addToAllTCAtypes ($table, $str, $specificTypesList='', $position='')
	allowTableOnStandardPages ($table)
	addModule ($main, $sub='', $position='', $path='')
	insertModuleFunction ($modname, $className, $classPath, $title, $MM_key='function')
	addPageTSConfig ($content)
	addUserTSConfig ($content)
	addLLrefForTCAdescr ($tca_descr_key, $file_ref)
	addService ($extKey, $serviceType, $serviceKey, $info)
	findService ($serviceType, $serviceSubType='', $excludeServiceKeys=array())
	deactivateService ($serviceType, $serviceKey)
	addPlugin ($itemArray, $type='list_type')
	addPiFlexFormValue ($piKeyToMatch, $value)
	addToInsertRecords ($table, $content_table='tt_content', $content_field='records')
	addPItoST43 ($key, $classFile='', $prefix='', $type='list_type', $cached=0)
	addStaticFile ($extKey, $path, $title)
	addTypoScriptSetup ($content)
	addTypoScriptConstants ($content)
	addTypoScript ($key, $type, $content, $afterStaticUid=0)
	typo3_loadExtensions ()
	_makeIncludeHeader ($key, $file)
	isCacheFilesAvailable ($cacheFilePrefix)
	isLocalconfWritable ()
	cannotCacheFilesWritable ($cacheFilePrefix)
	currentCacheFiles ()
	writeCacheFiles ($extensions, $cacheFilePrefix)

Detailed Description

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

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.

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.

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 t3lib_div::trimExplode().

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.

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 t3lib_div::loadTCA().

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().

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 t3lib_div::loadTCA().

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 deactivateService(), and t3lib_div::trimExplode().

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.
References t3lib_div::loadTCA().

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 t3lib_div::loadTCA().

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 t3lib_div::inList(), t3lib_div::loadTCA(), and t3lib_div::trimExplode().

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 t3lib_div::loadTCA().

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.

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.

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.

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.

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.

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.

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().

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.

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 siteRelPath().
Referenced by tx_kickstarter_compilefiles::addLLfunc(), tx_install::checkTheImageProcessing(), freesite_admin::displayExample(), tx_install::displayTwinImage(), extPath(), t3lib_div::getFileAbsFileName(), t3lib_TStemplate::getFileName(), SC_rte_rte::getLabels(), tx_version_cm1::includeLL(), tx_impexp_clickmenu::includeLL(), tx_ttrating_wizicon::includeLocalLang(), tx_ttproducts_wizicon::includeLocalLang(), tx_ttguest_wizicon::includeLocalLang(), tx_ttboard_wizicon::includeLocalLang(), t3lib_TStemplate::includeStaticTypoScriptSources(), SC_mod_web_modules_index::init(), tx_tstemplateceditor::initialize_editor(), tx_install::isGIF(), tx_install::isPNG(), tx_kickstarter_compilefiles::makeFieldTCA(), tx_indexedsearch_modfunc1::makeItemTypeIcon(), mod_web_dmail::mod_web_dmail(), tx_kickstarter_wizard::path_resources(), tx_kickstarter_compilefiles::renderExtPart_cm(), tx_kickstarter_compilefiles::renderExtPart_module(), tx_kickstarter_compilefiles::renderExtPart_moduleFunction(), tx_kickstarter_compilefiles::renderExtPart_SV(), tx_kickstarter_compilefiles::renderExtPart_tables(), siteRelPath(), and tx_kickstarter_compilefiles::writeStandardBE_xMod().

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.
Referenced by tx_version_cm1::adminLinks(), clickMenu::DB_newWizard(), t3lib_tsfeBeUserAuth::ext_makeToolBar(), extRelPath(), tx_version_cm1::main(), tx_impexp_clickmenu::main(), tx_kickstarter_compilefiles::makeFieldTCA(), tx_ttrating_wizicon::proc(), tx_ttproducts_wizicon::proc(), tx_ttguest_wizicon::proc(), tx_ttboard_wizicon::proc(), SC_db_new::regularNew(), tx_kickstarter_compilefiles::renderExtPart_tables(), and localRecordList::renderListHeader().

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 t3lib_exec::checkCommand(), deactivateService(), and t3lib_div::trimExplode().

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.

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.

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.

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.

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.
Referenced by SC_mod_tools_em_index::showExtDetails().

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().

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 cannotCacheFilesWritable(), isCacheFilesAvailable(), t3lib_div::shortMD5(), t3lib_div::trimExplode(), and writeCacheFiles().

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 t3lib_div::writeFile().

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

typo3_src-3.7.0/t3lib/class.t3lib_extmgm.php
typo3_src-3.7.0/typo3/t3lib/class.t3lib_extmgm.php

Généré par TYPO3 Ameos avec doxygen

1.4.6

Documentation TYPO3 par Ameos

t3lib_extMgm Class Reference

Public Member Functions

Detailed Description

Member Function Documentation