t3lib_div Class Reference

List of all members.


Public Member Functions
	trimExplode ($delim, $string, $onlyNonEmptyValues=0)
	dirname ($path)
	revExplode ($delim, $string, $count=0)
	getIndpEnv ($getEnvName)
	_GP ($var)
	_GET ($var=NULL)
	_POST ($var=NULL)
	_GETset ($inputGet, $key=')
	GPvar ($var, $strip=0)
	GParrayMerged ($var)
	gif_compress ($theFile, $type)
	png_to_gif_by_imagemagick ($theFile)
	read_png_gif ($theFile, $output_png=0)
	fixed_lgd ($string, $origChars, $preStr=...')
	fixed_lgd_pre ($string, $chars)
	fixed_lgd_cs ($string, $chars)
	breakTextForEmail ($str, $implChar="\n", $charWidth=76)
	breakLinesForEmail ($str, $implChar="\n", $charWidth=76)
	cmpIP ($baseIP, $list)
	cmpFQDN ($baseIP, $list)
	inList ($list, $item)
	rmFromList ($element, $list)
	expandList ($list)
	intInRange ($theInt, $min, $max=2000000000, $zeroValue=0)
	intval_positive ($theInt)
	int_from_ver ($verNumberStr)
	md5int ($str)
	shortMD5 ($input, $len=10)
	uniqueList ($in_list, $secondParameter=NULL)
	split_fileref ($fileref)
	dirname ($path)
	modifyHTMLColor ($color, $R, $G, $B)
	modifyHTMLColorAll ($color, $all)
	rm_endcomma ($string)
	danish_strtoupper ($string)
	convUmlauts ($str)
	testInt ($var)
	isFirstPartOfStr ($str, $partStr)
	formatSize ($sizeInBytes, $labels=')
	convertMicrotime ($microtime)
	splitCalc ($string, $operators)
	calcPriority ($string)
	calcParenthesis ($string)
	htmlspecialchars_decode ($value)
	deHSCentities ($str)
	slashJS ($string, $extended=0, $char="'")
	rawUrlEncodeJS ($str)
	rawUrlEncodeFP ($str)
	validEmail ($email)
	formatForTextarea ($content)
	inArray ($in_array, $item)
	intExplode ($delim, $string)
	revExplode ($delim, $string, $count=0)
	trimExplode ($delim, $string, $onlyNonEmptyValues=0)
	uniqueArray ($valueArray)
	removeArrayEntryByValue ($array, $cmpValue)
	implodeArrayForUrl ($name, $theArray, $str=', $skipBlank=0, $rawurlencodeParamName=0)
	explodeUrl2Array ($string, $multidim=FALSE)
	compileSelectedGetVarsFromArray ($varList, $getArray, $GPvarAlt=1)
	addSlashesOnArray (&$theArray)
	stripSlashesOnArray (&$theArray)
	slashArray ($arr, $cmd)
	array_merge_recursive_overrule ($arr0, $arr1, $notAddKeys=0, $includeEmtpyValues=true)
	array_merge ($arr1, $arr2)
	csvValues ($row, $delim=,', $quote="')
	get_tag_attributes ($tag)
	split_tag_attributes ($tag)
	implodeAttributes ($arr, $xhtmlSafe=FALSE, $dontOmitBlankAttribs=FALSE)
	implodeParams ($arr, $xhtmlSafe=FALSE, $dontOmitBlankAttribs=FALSE)
	wrapJS ($string, $linebreak=TRUE)
	xml2tree ($string, $depth=999)
	array2xml ($array, $NSprefix=', $level=0, $docTag=phparray', $spaceInd=0, $options=array(), $stackData=array())
	xml2array ($string, $NSprefix=', $reportDocTag=FALSE)
	xmlRecompileFromStructValArray ($vals)
	xmlGetHeaderAttribs ($xmlData)
	getURL ($url)
	writeFile ($file, $content)
	fixPermissions ($file)
	writeFileToTypo3tempDir ($filepath, $content)
	mkdir ($theNewFolder)
	get_dirs ($path)
	getFilesInDir ($path, $extensionList=', $prependPath=0, $order=')
	getAllFilesAndFoldersInPath ($fileArr, $path, $extList=', $regDirs=0, $recursivityLevels=99)
	removePrefixPathFromList ($fileArr, $prefixToRemove)
	fixWindowsFilePath ($theFile)
	resolveBackPath ($pathStr)
	locationHeaderUrl ($path)
	debug_ordvalue ($string, $characters=100)
	view_array ($array_in)
	print_array ($array_in)
	debug ($var="", $brOrHeader=0)
	getThisUrl ()
	linkThisScript ($getParams=array())
	linkThisUrl ($url, $getParams=array())
	getIndpEnv ($getEnvName)
	milliseconds ()
	clientInfo ($useragent=')
	getFileAbsFileName ($filename, $onlyRelative=1, $relToTYPO3_mainDir=0)
	validPathStr ($theFile)
	isAbsPath ($path)
	isAllowedAbsPath ($path)
	verifyFilenameAgainstDenyPattern ($filename)
	upload_copy_move ($source, $destination)
	upload_to_tempfile ($uploadedFileName)
	unlink_tempfile ($uploadedTempFileName)
	tempnam ($filePrefix)
	stdAuthCode ($uid_or_record, $fields=')
	cHashParams ($addQueryParams)
	hideIfNotTranslated ($l18n_cfg_fieldValue)
	readLLfile ($fileRef, $langKey)
	readLLXMLfile ($fileRef, $langKey)
	loadTCA ($table)
	resolveSheetDefInDS ($dataStructArray, $sheet=sDEF')
	resolveAllSheetsInDS ($dataStructArray)
	callUserFunction ($funcName, &$params, &$ref, $checkPrefix=user_', $silent=0)
&	getUserObj ($classRef, $checkPrefix=user_', $silent=0)
&	makeInstance ($className)
	makeInstanceClassName ($className)
&	makeInstanceService ($serviceType, $serviceSubType=', $excludeServiceKeys=array())
	plainMailEncoded ($email, $subject, $message, $headers=', $enc=', $charset=ISO-8859-1', $dontEncodeSubject=0)
	quoted_printable ($string, $maxlen=76)
	substUrlsInPlainText ($message, $urlmode=76', $index_script_url=')
	makeRedirectUrl ($inUrl, $l=0, $index_script_url=')
	freetypeDpiComp ($font_size)
	devLog ($msg, $extKey, $severity=0, $dataVar=FALSE)
	arrayToLogString ($arr, $valueList=array(), $valueLength=20)
	imageMagickCommand ($command, $parameters, $path=')
	unQuoteFilenames ($parameters)
	_GP ($var)
	_GET ($var=NULL)
	_POST ($var=NULL)
	_GETset ($inputGet, $key=')
	GPvar ($var, $strip=0)
	GParrayMerged ($var)
	gif_compress ($theFile, $type)
	png_to_gif_by_imagemagick ($theFile)
	read_png_gif ($theFile, $output_png=0)
	fixed_lgd ($string, $origChars, $preStr=...')
	fixed_lgd_pre ($string, $chars)
	fixed_lgd_cs ($string, $chars)
	breakTextForEmail ($str, $implChar="\n", $charWidth=76)
	breakLinesForEmail ($str, $implChar="\n", $charWidth=76)
	cmpIP ($baseIP, $list)
	cmpFQDN ($baseIP, $list)
	inList ($list, $item)
	rmFromList ($element, $list)
	expandList ($list)
	intInRange ($theInt, $min, $max=2000000000, $zeroValue=0)
	intval_positive ($theInt)
	int_from_ver ($verNumberStr)
	md5int ($str)
	shortMD5 ($input, $len=10)
	uniqueList ($in_list, $secondParameter=NULL)
	split_fileref ($fileref)
	dirname ($path)
	modifyHTMLColor ($color, $R, $G, $B)
	modifyHTMLColorAll ($color, $all)
	rm_endcomma ($string)
	danish_strtoupper ($string)
	convUmlauts ($str)
	testInt ($var)
	isFirstPartOfStr ($str, $partStr)
	formatSize ($sizeInBytes, $labels=')
	convertMicrotime ($microtime)
	splitCalc ($string, $operators)
	calcPriority ($string)
	calcParenthesis ($string)
	htmlspecialchars_decode ($value)
	deHSCentities ($str)
	slashJS ($string, $extended=0, $char="'")
	rawUrlEncodeJS ($str)
	rawUrlEncodeFP ($str)
	validEmail ($email)
	formatForTextarea ($content)
	inArray ($in_array, $item)
	intExplode ($delim, $string)
	revExplode ($delim, $string, $count=0)
	trimExplode ($delim, $string, $onlyNonEmptyValues=0)
	uniqueArray ($valueArray)
	removeArrayEntryByValue ($array, $cmpValue)
	implodeArrayForUrl ($name, $theArray, $str=', $skipBlank=0, $rawurlencodeParamName=0)
	explodeUrl2Array ($string, $multidim=FALSE)
	compileSelectedGetVarsFromArray ($varList, $getArray, $GPvarAlt=1)
	addSlashesOnArray (&$theArray)
	stripSlashesOnArray (&$theArray)
	slashArray ($arr, $cmd)
	array_merge_recursive_overrule ($arr0, $arr1, $notAddKeys=0, $includeEmtpyValues=true)
	array_merge ($arr1, $arr2)
	csvValues ($row, $delim=,', $quote="')
	get_tag_attributes ($tag)
	split_tag_attributes ($tag)
	implodeAttributes ($arr, $xhtmlSafe=FALSE, $dontOmitBlankAttribs=FALSE)
	implodeParams ($arr, $xhtmlSafe=FALSE, $dontOmitBlankAttribs=FALSE)
	wrapJS ($string, $linebreak=TRUE)
	xml2tree ($string, $depth=999)
	array2xml ($array, $NSprefix=', $level=0, $docTag=phparray', $spaceInd=0, $options=array(), $stackData=array())
	xml2array ($string, $NSprefix=', $reportDocTag=FALSE)
	xmlRecompileFromStructValArray ($vals)
	xmlGetHeaderAttribs ($xmlData)
	getURL ($url)
	writeFile ($file, $content)
	fixPermissions ($file)
	writeFileToTypo3tempDir ($filepath, $content)
	mkdir ($theNewFolder)
	get_dirs ($path)
	getFilesInDir ($path, $extensionList=', $prependPath=0, $order=')
	getAllFilesAndFoldersInPath ($fileArr, $path, $extList=', $regDirs=0, $recursivityLevels=99)
	removePrefixPathFromList ($fileArr, $prefixToRemove)
	fixWindowsFilePath ($theFile)
	resolveBackPath ($pathStr)
	locationHeaderUrl ($path)
	debug_ordvalue ($string, $characters=100)
	view_array ($array_in)
	print_array ($array_in)
	debug ($var="", $brOrHeader=0)
	getThisUrl ()
	linkThisScript ($getParams=array())
	linkThisUrl ($url, $getParams=array())
	getIndpEnv ($getEnvName)
	milliseconds ()
	clientInfo ($useragent=')
	getFileAbsFileName ($filename, $onlyRelative=1, $relToTYPO3_mainDir=0)
	validPathStr ($theFile)
	isAbsPath ($path)
	isAllowedAbsPath ($path)
	verifyFilenameAgainstDenyPattern ($filename)
	upload_copy_move ($source, $destination)
	upload_to_tempfile ($uploadedFileName)
	unlink_tempfile ($uploadedTempFileName)
	tempnam ($filePrefix)
	stdAuthCode ($uid_or_record, $fields=')
	cHashParams ($addQueryParams)
	hideIfNotTranslated ($l18n_cfg_fieldValue)
	readLLfile ($fileRef, $langKey)
	readLLXMLfile ($fileRef, $langKey)
	loadTCA ($table)
	resolveSheetDefInDS ($dataStructArray, $sheet=sDEF')
	resolveAllSheetsInDS ($dataStructArray)
	callUserFunction ($funcName, &$params, &$ref, $checkPrefix=user_', $silent=0)
&	getUserObj ($classRef, $checkPrefix=user_', $silent=0)
&	makeInstance ($className)
	makeInstanceClassName ($className)
&	makeInstanceService ($serviceType, $serviceSubType=', $excludeServiceKeys=array())
	plainMailEncoded ($email, $subject, $message, $headers=', $enc=', $charset=ISO-8859-1', $dontEncodeSubject=0)
	quoted_printable ($string, $maxlen=76)
	substUrlsInPlainText ($message, $urlmode=76', $index_script_url=')
	makeRedirectUrl ($inUrl, $l=0, $index_script_url=')
	freetypeDpiComp ($font_size)
	devLog ($msg, $extKey, $severity=0, $dataVar=FALSE)
	arrayToLogString ($arr, $valueList=array(), $valueLength=20)
	imageMagickCommand ($command, $parameters, $path=')
	unQuoteFilenames ($parameters)

Detailed Description

Definition at line 5 of file incfile.php.

Member Function Documentation

t3lib_div::_GET ( $ var = NULL )

Returns the global GET array (or value from) normalized to contain un-escaped values. ALWAYS use this API function to acquire the GET variables! Usage: 27

Parameters:

string Optional pointer to value in GET array (basically name of GET var)

Returns:
mixed If $var is set it returns the value of $_GET[$var]. If $var is NULL (default), returns $_GET itself. In any case *slashes are stipped from the output!*

See also:
_POST(), _GP(), _GETset()

Definition at line 259 of file class.t3lib_div.php.
References $value, stripSlashesOnArray(), and value.
Referenced by SC_alt_main::editPageHandling(), SC_mod_tools_dbint_index::func_records(), GParrayMerged(), SC_show_item::init(), SC_file_list::main(), tx_tstemplatestyler_modfunc1::main(), tx_tstemplateobjbrowser::main(), tx_tstemplateanalyzer::main(), SC_db_list::main(), SC_alt_clickmenu::main(), SC_mod_tools_config_index::main(), tx_ttproducts::main_products(), tslib_fe::makeCacheHash(), template::makeShortcutUrl(), tslib_fe::mergingWithGetVars(), TSpagegen::pagegenInit(), SC_alt_doc::preInit(), t3lib_TStemplate::processTemplate(), SC_db_layout::renderQuickEdit(), and t3lib_userAuth::start().

t3lib_div::_GETset ( $ inputGet,

$ key = '

)

Writes input value to $_GET Usage: 2

Parameters:

array Array to write to $_GET. Values should NOT be escaped at input time (but will be escaped before writing according to TYPO3 standards).

string Alternative key; If set, this will not set the WHOLE GET array, but only the key in it specified by this value!

Returns:
void

Definition at line 292 of file class.t3lib_div.php.
References $GLOBALS, $key, and addSlashesOnArray().

t3lib_div::_GP ( $ var )

Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order) Strips slashes from all output, both strings and arrays. This function substitutes t3lib_div::GPvar() To enhancement security in your scripts, please consider using t3lib_div::_GET or t3lib_div::_POST if you already know by which method your data is arriving to the scripts! Usage: 537

Parameters:

string GET/POST var to return

Returns:
mixed POST var named $var and if not set, the GET var of the same name.

See also:
GPvar()

Definition at line 241 of file class.t3lib_div.php.
References $value, _POST(), stripSlashesOnArray(), and value.
Referenced by tx_taskcenterrecent::_renderRecent(), tx_sysaction::action_t1_createUpdateBeUser(), SC_mod_tools_em_index::checkDBupdates(), t3lib_SCbase::checkExtObj(), tslib_fe::checkJumpUrl(), tx_install::checkPassword(), tx_install::checkTheDatabase(), SC_mod_tools_log_index::checkUpload(), t3lib_TCEmain::checkValue_flex(), tx_kickstarter_section_fields::cleanFieldsAndDoCommands(), SC_mod_web_ts_index::clearCache(), mod_web_dmail::cmd_default(), mod_web_dmail::cmd_displayImport(), mod_web_dmail::cmd_displayMailGroup(), mod_web_dmail::cmd_displayUserInfo(), mod_web_dmail::cmd_quickmail(), mod_web_dmail::cmd_send_mail(), mod_web_dmail::cmd_stats(), SC_mod_tools_be_user_index::compareUsers(), mod_web_dmail::createDMail(), SC_mod_web_ts_index::createTemplate(), tslib_fe::determineId(), user_feAdmin::displayCreateScreen(), user_feAdmin::displayEditForm(), freesite_admin::displayExample(), tslib_cObj::editIcons(), tslib_cObj::editPanel(), tslib_cObj::editPanelLinkWrap(), SC_rte_select_image::expandFolder(), localPageTree::ext_tree(), t3lib_tsfeBeUserAuth::extGetCategory_edit(), tslib_menu::filterMenuPages(), tx_ttboard::forum_forum(), SC_mod_tools_dbint_index::func_filesearch(), tx_install::generateConfigForm(), tslib_cObj::getData(), tslib_cObj::getFieldDefaultValue(), t3lib_matchCondition::getGP_ENV_TSFE(), tx_ttproducts::getLinkUrl(), tx_ttnews::getLinkUrl(), t3lib_userAuth::getLoginFormData(), t3lib_fullsearch::getQueryResultCode(), tx_ttnews::getSelectConf(), t3lib_TCEforms::getSingleField_typeFlex(), tx_ttproducts::getTrackingInformation(), t3lib_extobjbase::handleExternalFunctionValue(), SC_wizard_tsconfig::init(), SC_wizard_table::init(), SC_wizard_rte::init(), SC_wizard_list::init(), SC_wizard_forms::init(), SC_wizard_edit::init(), SC_wizard_colorpicker::init(), SC_wizard_add::init(), SC_view_help::init(), SC_tce_file::init(), SC_tce_db::init(), SC_db_new_content_el::init(), SC_db_layout::init(), SC_move_el::init(), SC_file_upload::init(), SC_file_rename::init(), SC_file_newfolder::init(), SC_file_list::init(), SC_file_edit::init(), SC_rte_user::init(), SC_rte_rte::init(), SC_db_new::init(), SC_db_list::init(), SC_browse_links::init(), SC_alt_palette::init(), SC_alt_menu::init(), SC_alt_file_navframe::init(), SC_alt_doc::init(), SC_alt_db_navframe::init(), SC_alt_clickmenu::init(), clickMenu::init(), user_feAdmin::init(), t3lib_SCbase::init(), SC_mod_web_view_index::init(), SC_mod_tools_be_user_index::init(), SC_mod_web_perm_index::init(), SC_mod_tools_em_index::init(), SC_index::init(), SC_mod_web_ts_index::init(), SC_mod_web_modules_index::init(), SC_mod_file_images_index::init(), tslib_fe::initFEuser(), t3lib_treeView::initializePositionSaving(), t3lib_folderTree::initializePositionSaving(), tx_install::isTTF(), tslib_fe::jumpUrl(), SC_logout::logout(), SC_rte_select_image::magicProcess(), mod_web_dmail::mailModule_main(), SC_wizard_colorpicker::main(), tx_wizardsortpages_webfunc_2::main(), tx_wizardcrpages_webfunc_2::main(), tx_indexedsearch_modfunc1::main(), tx_impexp_modfunc1::main(), tx_impexp_clickmenu::main(), tx_extrapagecmoptions::main(), SC_show_item::main(), tx_tstemplatestyler_modfunc1::main(), tx_tstemplateobjbrowser::main(), tx_tstemplateinfo::main(), tx_tstemplateceditor::main(), SC_rte_select_image::main(), tx_cmsplaintextimport_webfunc::main(), SC_browser::main(), SC_alt_mod_frameset::main(), tx_version_cm1::main(), SC_mod_tools_config_index::main(), SC_mod_tools_be_user_index::main(), SC_mod_web_modules_index::main(), tx_ttboard::main_board(), SC_browse_links::main_file(), tx_ttnews::main_news(), SC_rte_user::main_user(), SC_db_layout::menuConfig(), SC_file_list::menuConfig(), SC_db_list::menuConfig(), t3lib_SCbase::menuConfig(), SC_mod_tools_dbint_index::menuConfig(), SC_mod_tools_config_index::menuConfig(), SC_mod_tools_isearch_index::menuConfig(), SC_mod_tools_be_user_index::menuConfig(), SC_mod_tools_log_index::menuConfig(), SC_mod_web_perm_index::menuConfig(), SC_mod_tools_em_index::menuConfig(), SC_mod_web_modules_index::menuConfig(), tx_ttnews::news_list(), TSpagegen::pagegenInit(), user_feAdmin::parseValues(), SC_rte_select_image::preinit(), SC_alt_shortcut::preinit(), SC_alt_doc::preInit(), freesite_admin::printSelect(), SC_alt_doc::processData(), user_feAdmin::procesSetFixed(), SC_mod_tools_log_index::processPresets(), t3lib_modSettings::processStoreControl(), t3lib_fullsearch::procesStoreControl(), tx_ttproducts::products_basket(), tx_ttproducts::products_display(), tx_ttproducts::products_tracking(), recordHistory::recordHistory(), template::redirectUrls(), tx_sysaction::renderActions(), tx_sysmessages::renderMessages(), tx_sysnotepad::renderNote(), tx_systodos::renderTasks(), t3lib_fullsearch::search(), tslib_cObj::SEARCHRESULT(), user_feAdmin::sendInfoMail(), tx_ttproducts::shopAdmin(), SC_mod_tools_em_index::showExtDetails(), SC_mod_user_setup_index::simulateUser(), recordList::start(), tslib_fe::statistics(), SC_mod_user_setup_index::storeIncomingData(), SC_browse_links::TBE_dragNDrop(), SC_mod_web_ts_index::templateMenu(), tx_tipafriend::tipform(), tx_systodos::todos_createForm(), tx_systodos::todos_displayTodo(), tx_systodos::todos_processIncoming(), alt_menu_functions::topMenu(), SC_mod_tools_em_index::tsStyleConfigForm(), tx_install::tx_install(), and mod_web_dmail::updatePageTS().

t3lib_div::_POST ( $ var = NULL )

Returns the global POST array (or value from) normalized to contain un-escaped values. ALWAYS use this API function to acquire the POST variables! Usage: 41

Parameters:

string Optional pointer to value in POST array (basically name of POST var)

Returns:
mixed If $var is set it returns the value of $_POST[$var]. If $var is NULL (default), returns $_POST itself. In any case *slashes are stipped from the output!*

See also:
_GET(), _GP()

Definition at line 276 of file class.t3lib_div.php.
References $value, stripSlashesOnArray(), and value.
Referenced by _GP(), SC_mod_tools_em_index::checkClearCache(), SC_mod_tools_em_index::checkUploadFolder(), SC_wizard_colorpicker::colorImage(), tslib_cObj::editPanel(), freesite_admin::enteringData(), t3lib_tsfeBeUserAuth::extInitFeAdmin(), t3lib_tsfeBeUserAuth::extSaveFeAdminConfig(), tslib_fe::fe_tce(), tslib_cObj::FORM(), t3lib_userAuth::getLoginFormData(), GParrayMerged(), GPvar(), SC_mod_tools_log_index::importData(), freesite_admin::isReady(), tx_indexedsearch_modfunc1::main(), SC_file_list::main(), tx_tstemplateobjbrowser::main(), tx_tstemplateinfo::main(), tx_tstemplateceditor::main(), freesite_admin::main(), SC_db_list::main(), SC_mod_tools_config_index::main(), tx_ttpoll::main_poll(), tx_version_cm1::moduleContent(), t3lib_queryGenerator::procesData(), tslib_cObj::SEARCHRESULT(), tslib_fe::sendFormmail(), SC_mod_tools_em_index::showExtDetails(), SC_mod_user_setup_index::storeIncomingData(), SC_mod_tools_em_index::tsStyleConfigForm(), and tx_kickstarter_wizard::tx_kickstarter_wizard().

t3lib_div::addSlashesOnArray ( &$ theArray )

AddSlash array This function traverses a multidimentional array and adds slashes to the values. NOTE that the input array is and argument by reference.!! Twin-function to stripSlashesOnArray Usage: 8

Parameters:

array Multidimensional input array, (REFERENCE!)

Returns:
array

Definition at line 1394 of file class.t3lib_div.php.

t3lib_div::array2xml ( $ array,

$ NSprefix = ',

$ level = 0,

$ docTag = phparray',

$ spaceInd = 0,

$ options = array(),

$ stackData = array()

)

Converts a PHP array into an XML string. The XML output is optimized for readability since associative keys are used as tagnames. This also means that only alphanumeric characters are allowed in the tag names AND only keys NOT starting with numbers (so watch your usage of keys!). However there are options you can set to avoid this problem. Numeric keys are stored with the default tagname "numIndex" but can be overridden to other formats) The function handles input values from the PHP array in a binary-safe way; All characters below 32 (except 9,10,13) will trigger the content to be converted to a base64-string The PHP variable type of the data IS preserved as long as the types are strings, arrays, integers and booleans. Strings are the default type unless the "type" attribute is set. The output XML has been tested with the PHP XML-parser and parses OK under all tested circumstances. However using MSIE to read the XML output didn't always go well: One reason could be that the character encoding is not observed in the PHP data. The other reason may be if the tag-names are invalid in the eyes of MSIE. Also using the namespace feature will make MSIE break parsing. There might be more reasons... Usage: 5

Parameters:

array The input PHP array with any kind of data; text, binary, integers. Not objects though.

string tag-prefix, eg. a namespace prefix like "T3:"

integer Current recursion level. Don't change, stay at zero!

string Alternative document tag. Default is "phparray".

integer If set, the number of spaces corresponding to this number is used for indenting, otherwise a single chr(9) (TAB) is used

array Options for the compilation. Key "useNindex" => 0/1 (boolean: whether to use "n0, n1, n2" for num. indexes); Key "useIndexTagForNum" => "[tag for numerical indexes]"; Key "useIndexTagForAssoc" => "[tag for associative indexes"; Key "parentTagMap" => array('parentTag' => 'thisLevelTag')

string Stack data. Don't touch.

Returns:
string An XML string made from the input content in the array.

See also:
xml2array()

Definition at line 1774 of file class.t3lib_div.php.
References $content, $k, array2xml(), and index.

t3lib_div::array_merge ( $ arr1,

$ arr2

)

An array_merge function where the keys are NOT renumbered as they happen to be with the real php-array_merge function. It is "binary safe" in the sense that integer keys are overridden as well. Usage: 16

Parameters:

array First array

array Second array

Returns:
array Merged result.

Definition at line 1490 of file class.t3lib_div.php.

t3lib_div::array_merge_recursive_overrule ( $ arr0,

$ arr1,

$ notAddKeys = 0,

$ includeEmtpyValues = true

)

Merges two arrays recursively and "binary safe" (integer keys are overridden as well), overruling similar values in the first array ($arr0) with the values of the second array ($arr1) In case of identical keys, ie. keeping the values of the second. Usage: 0

Parameters:

array First array

array Second array, overruling the first array

boolean If set, keys that are NOT found in $arr0 (first array) will not be set. Thus only existing value can/will be overruled from second array.

boolean If set, values from $arr1 will overrule if they are empty. Default: true

Returns:
array Resulting array where $arr1 values has overruled $arr0 values

Definition at line 1457 of file class.t3lib_div.php.
Referenced by t3lib_TCEmain::checkValue_flex(), mod_web_dmail::cmd_compileMailGroup(), t3lib_tsStyleConfig::ext_mergeIncomingWithExisting(), t3lib_TCEmain::fillInFieldArray(), t3lib_BEfunc::getModTSconfig(), t3lib_TCEmain::getTableEntries(), t3lib_BEfunc::getTCEFORM_TSconfig(), GParrayMerged(), t3lib_extobjbase::incLocalLang(), language::includeLLFile(), mailSelect::initUserDef(), tx_kickstarter_wizard::initWizArray(), tx_belog_webinfo::localLang(), SC_rte_user::main_user(), t3lib_TStemplate::mergeConstantsFromPageTSconfig(), tslib_fe::mergingWithGetVars(), mod_web_dmail::mod_web_dmail(), tslib_pibase::pi_linkTP_keepPIvars(), tslib_pibase::pi_setPiVarDefaults(), t3lib_TCEmain::process_cmdmap(), language::sL(), template::template(), and t3lib_pageSelect::versionOL().

t3lib_div::arrayToLogString ( $ arr,

$ valueList = array(),

$ valueLength = 20

)

Converts a one dimensional array to a one line string which can be used for logging or debugging output Example: "loginType: FE; refInfo: Array; HTTP_HOST: www.example.org; REMOTE_ADDR: 192.168.1.5; REMOTE_HOST:; security_level:; showHiddenRecords: 0;"

Parameters:

array Data array which should be outputted

mixed List of keys which should be listed in the output string. Pass a comma list or an array. An empty list outputs the whole array.

integer Long string values are shortened to this length. Default: 20

Returns:
string Output string with key names and their value as string

Definition at line 3779 of file class.t3lib_div.php.
References $key, fixed_lgd(), and value.

t3lib_div::breakLinesForEmail ( $ str,

$ implChar = "\n",

$ charWidth = 76

)

Breaks up a single line of text for emails Usage: 5

Parameters:

string The string to break up

string The string to implode the broken lines with (default/typically
)

integer The line length

Returns:
string

See also:
breakTextForEmail()

Definition at line 553 of file class.t3lib_div.php.
References $count, $lines, and $parts.

t3lib_div::breakTextForEmail ( $ str,

$ implChar = "\n",

$ charWidth = 76

)

Breaks up the text for emails Usage: 1

Parameters:

string The string to break up

string The string to implode the broken lines with (default/typically
)

integer The line length

Returns:
string

Definition at line 534 of file class.t3lib_div.php.
References $lines, array_merge(), and breakLinesForEmail().

t3lib_div::calcParenthesis ( $ string )

Calculates the input with parenthesis levels Usage: 2

Parameters:

string Input string, eg "(123 + 456) / 789 - 4"

Returns:
integer Calculated value. Or error string.

See also:
calcPriority(), tslib_cObj::stdWrap()

Definition at line 1064 of file class.t3lib_div.php.
References $value, and calcPriority().

t3lib_div::calcPriority ( $ string )

Calculates the input by +,-,*,/,%,^ with priority to + and - Usage: 1

Parameters:

string Input string, eg "123 + 456 / 789 - 4"

Returns:
integer Calculated value. Or error string.

See also:
calcParenthesis()

Definition at line 1024 of file class.t3lib_div.php.
References $k.

t3lib_div::cHashParams ( $ addQueryParams )

Splits the input query-parameters into an array with certain parameters filtered out. Used to create the cHash value

Parameters:

string Query-parameters: "&xxx=yyy&zzz=uuu"

Returns:
array Array with key/value pairs of query-parameters WITHOUT a certain list of variable names (like id, type, no_cache etc) and WITH a variable, encryptionKey, specific for this server/installation

See also:
tslib_fe::makeCacheHash(), tslib_cObj::typoLink()

Definition at line 3088 of file class.t3lib_div.php.
References $GLOBALS, and inList().

t3lib_div::clientInfo ( $ useragent = ' )

Client Browser Information Usage: 4

Parameters:

string Alternative User Agent string (if empty, t3lib_div::getIndpEnv('HTTP_USER_AGENT') is used)

Returns:
array Parsed information about the HTTP_USER_AGENT in categories BROWSER, VERSION, SYSTEM and FORMSTYLE

Definition at line 2805 of file class.t3lib_div.php.
References $tmp, and getIndpEnv().

t3lib_div::cmpFQDN ( $ baseIP,

$ list

)

Match fully qualified domain name with list of strings with wildcard

Parameters:

string $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR

string $list is a comma-list of domain names to match with. *-wildcard allowed but cannot be part of a string, so it must match the full host name (eg. myhost.*.com => correct, myhost.*domain.com => wrong)

Returns:
boolean True if a domain name mask from $list matches $baseIP

Definition at line 630 of file class.t3lib_div.php.
References $val, index, and trimExplode().

t3lib_div::cmpIP ( $ baseIP,

$ list

)

Match IP number with list of numbers with wildcard Usage: 10

Parameters:

string $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR

string $list is a comma-list of IP-addresses to match with. *-wildcard allowed instead of number, plus leaving out parts in the IP number is accepted as wildcard (eg. 192.168.*.* equals 192.168)

Returns:
boolean True if an IP-mask from $list matches $baseIP

Definition at line 588 of file class.t3lib_div.php.
References $val, index, and trimExplode().

t3lib_div::compileSelectedGetVarsFromArray ( $ varList,

$ getArray,

$ GPvarAlt = 1

)

Returns an array with selected keys from incoming data. (Better read source code if you want to find out...) Usage: 3

Parameters:

string List of variable/key names

array Array from where to get values based on the keys in $varList

boolean If set, then t3lib_div::_GP() is used to fetch the value if not found (isset) in the $getArray

Returns:
array Output array with selected variables.

Definition at line 1371 of file class.t3lib_div.php.

t3lib_div::convertMicrotime ( $ microtime )

Returns microtime input to milliseconds Usage: 2

Parameters:

string Microtime

Returns:
integer Microtime input string converted to an integer (milliseconds)

Definition at line 988 of file class.t3lib_div.php.
References $parts.

t3lib_div::convUmlauts ( $ str )

Change umlaut characters to plain ASCII with normally two character target Only known characters will be converted, so don't expect a result for any character. (DEPRECIATED: Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!)
ä => ae, Ö => Oe

Parameters:

string String to convert.

Returns:
string

Definition at line 912 of file class.t3lib_div.php.

t3lib_div::csvValues ( $ row,

$ delim,

'

)

Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars. Usage: 5

Parameters:

array Input array of values

string Delimited, default is comman

string Quote-character to wrap around the values.

Returns:
string A single line of CSV

Definition at line 1503 of file class.t3lib_div.php.
References value.

t3lib_div::danish_strtoupper ( $ string )

strtoupper which converts danish (and other characters) characters as well (DEPRECIATED, use t3lib_cs::conv_case() instead or for HTML output, wrap your content in ...) Usage: 0

Parameters:

string String to process

Returns:
string

Definition at line 897 of file class.t3lib_div.php.
References $value, and value.

t3lib_div::debug ( $ var = "",

$ brOrHeader = 0

)

Makes debug output Prints $var in bold between two vertical lines If not $var the word 'debug' is printed If $var is an array, the array is printed by t3lib_div::print_array() Usage: 8

Parameters:

mixed Variable to print

mixed If the parameter is a string it will be used as header. Otherwise number of break tags to apply after (positive integer) or before (negative integer) the output.

Returns:
void

Definition at line 2470 of file class.t3lib_div.php.
References debug(), print_array(), style, table, td, and testInt().

t3lib_div::debug_ordvalue ( $ string,

$ characters = 100

)

Returns a string with a list of ascii-values for the first $characters characters in $string Usage: 0

Parameters:

string String to show ASCII value for

integer Number of characters to show

Returns:
string The string with ASCII values in separated by a space char.

Definition at line 2410 of file class.t3lib_div.php.

t3lib_div::deHSCentities ( $ str )

Re-converts HTML entities if they have been converted by htmlspecialchars() Usage: 10

Parameters:

string String which contains eg. "&amp;" which should stay "&". Or "&#1234;" to "Ӓ". Or "&#x1b;" to ""

Returns:
string Converted result.

Definition at line 1105 of file class.t3lib_div.php.
Referenced by tslib_cObj::FORM(), t3lib_BEfunc::getFuncMenu(), t3lib_TCEforms::getSingleField(), t3lib_TCEforms::getSingleField_typeSelect_checkbox(), t3lib_TCEforms::getSingleField_typeSelect_singlebox(), template::getTabMenu(), language::sL(), and tslib_cObj::stdWrap().

t3lib_div::devLog ( $ msg,

$ extKey,

$ severity = 0,

$ dataVar = FALSE

)

Developer log; This should be implemented around the source code, both frontend and backend, logging everything from the flow through an application, messages, results from comparisons to fatal errors. The result is meant to make sense to developers during development or debugging of a site. The idea is that this function is only a wrapper for external extensions which can set a hook which will be allowed to handle the logging of the information to any format they might wish and with any kind of filter they would like. If you want to implement the devLog in your applications, simply add lines like: if (TYPO3_DLOG) t3lib_div::devLog('[write message in english here]', 'extension key');

Parameters:

string Message (in english).

string Extension key (from which extension you are calling the log)

integer Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message

array Additional data you want to pass to the logger.

Returns:
void

Definition at line 3758 of file class.t3lib_div.php.
References callUserFunction().
Referenced by t3lib_modSettings::addToStoreList(), t3lib_modSettings::addToStoreListFromPrefix(), tx_sv_auth::authUser(), t3lib_userAuth::checkAuthentication(), t3lib_userAuth::compareUident(), t3lib_userAuth::createUserSession(), t3lib_svbase::devLog(), template::endPage(), tslib_feUserAuth::fetchGroupData(), t3lib_userAuth::fetchUserSession(), tx_sv_auth::getGroups(), tx_sv_auth::getUser(), tslib_fe::initUserGroups(), tx_rte_base::isAvailable(), t3lib_userAuth::logoff(), t3lib_modSettings::processStoreControl(), t3lib_userAuth::setAndSaveSessionData(), t3lib_modSettings::setStoreList(), t3lib_userAuth::start(), t3lib_modSettings::writeStoredSetting(), and t3lib_userAuth::writeUC().

t3lib_div::dirname ( $ path )

Returns the directory part of a path without trailing slash If there is no dir-part, then an empty string is returned. Behaviour:
'/dir1/dir2/script.php' => '/dir1/dir2' '/dir1/' => '/dir1' 'dir1/script.php' => 'dir1' 'd/script.php' => 'd' '/script.php' => '' '' => '' Usage: 5

Parameters:

string Directory name / path

Returns:
string Processed input value. See function description.

Definition at line 837 of file class.t3lib_div.php.
References revExplode().

t3lib_div::dirname ( $ path )

Definition at line 18 of file incfile.php.
References revExplode().
Referenced by SC_alt_main::generateJScode(), getIndpEnv(), getThisUrl(), TSpagegen::pagegenInit(), and TSpagegen::renderContentWithHeader().

t3lib_div::expandList ( $ list )

Expand a comma-separated list of integers with ranges (eg 1,3-5,7 becomes 1,3,4,5,7). Ranges are limited to 1000 values per range.

Parameters:

string $list comma-separated list of integers with ranges (string)

Returns:
string new comma-separated list of items

Author:
Martin Kutschker <martin.kutschker@activesolution.at>

Definition at line 688 of file class.t3lib_div.php.

t3lib_div::explodeUrl2Array ( $ string,

$ multidim = FALSE

)

Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array

Parameters:

string GETvars string

boolean If set, the string will be parsed into a multidimensional array if square brackets are used in variable names (using PHP function parse_str())

Returns:
array Array of values. All values AND keys are rawurldecoded() as they properly should be. But this means that any implosion of the array again must rawurlencode it!

See also:
implodeArrayForUrl()

Definition at line 1344 of file class.t3lib_div.php.

t3lib_div::fixed_lgd ( $ string,

$ origChars,

$ preStr = ...'

)

Truncate string Returns a new string of max. $chars length. If the string is longer, it will be truncated and appended with '...'. DEPRECIATED. Works ONLY for single-byte charsets! USE t3lib_div::fixed_lgd_cs() instead Usage: 39

Parameters:

string $string string to truncate

integer $chars must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.

string String to append to the output if it is truncated, default is '...'

Returns:
string new string

See also:
fixed_lgd_pre()

Definition at line 478 of file class.t3lib_div.php.
Referenced by arrayToLogString(), user_wapversion::cBodytext(), tx_install::checkTheDatabase(), mod_web_dmail::cmd_default(), mod_web_dmail::cmd_displayPageInfo(), user_wapversion::contentAbstract(), mod_web_dmail::directMail_defaultView(), tx_indexedsearch_modfunc1::drawTableOfIndexedPages(), tslib_cObj::editPanel(), SC_mod_tools_em_index::extensionListRow(), SC_mod_tools_em_index::extensionTitleIconHeader(), t3lib_timeTrack::fixCLen(), mod_user_task::fixed_lgd(), fixed_lgd_cs(), fixed_lgd_pre(), fileList::formatDirList(), fileList::formatFileList(), tx_install::generateConfigForm(), SC_mod_tools_isearch_index::getPhashExternalDocs(), SC_mod_tools_isearch_index::getPhashT3pages(), freesite_admin::getTemplateDetails(), SC_alt_shortcut::main(), SC_mod_web_perm_index::notEdit(), and tx_sysnotepad::overview_main().

t3lib_div::fixed_lgd_cs ( $ string,

$ chars

)

Truncates a string with appended/prepended "..." and takes backend character set into consideration Use only from backend! Usage: 75

Parameters:

string $string string to truncate

integer $chars must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.

Returns:
string New string

See also:
fixed_lgd()

Definition at line 517 of file class.t3lib_div.php.
References $GLOBALS, and fixed_lgd().
Referenced by t3lib_diff::addClearBuffer(), t3lib_clipboard::confirmMsg(), tx_cms_layout::dataFields(), t3lib_TCEforms::dbFileIcons(), SC_rte_select_image::expandFolder(), SC_browse_links::expandFolder(), SC_browse_links::expandPage(), tx_impexp::export_addRecord(), SC_browse_links::fileList(), t3lib_TCEforms::foreignTable(), t3lib_admin::genTree(), template::getFileheader(), template::getHeader(), t3lib_BEfunc::getProcessedValue(), t3lib_BEfunc::getRecordTitle(), t3lib_TCEforms::getSingleField_typeFlex_draw(), tx_cms_layout::getTable_tt_content(), t3lib_treeView::getTitleStr(), recordList::linkWrapItems(), TBE_browser_recordList::linkWrapItems(), tx_wizardsortpages_webfunc_2::main(), tx_wizardcrpages_webfunc_2::main(), tx_impexp_modfunc1::main(), SC_alt_shortcut::main(), SC_alt_db_navframe::main(), SC_mod_web_perm_index::main(), SC_mod_web_info_index::main(), SC_mod_web_func_index::main(), SC_mod_web_ts_index::main(), SC_mod_web_perm_index::notEdit(), tx_impexp_modfunc1::overview_main(), SC_browse_links::parseCurUrl(), t3lib_positionMap::positionTree(), t3lib_clipboard::printContentFromTab(), clickMenu::printDBClickMenu(), tx_indexedsearch_modfunc1::printPhashRow(), localFolderTree::printTree(), printAllPageTree_perms::printTree(), t3lib_loadDBGroup::readyForInterface(), tx_cms_webinfo_lang::renderL10nTable(), SC_mod_web_ts_index::renderList(), SC_db_layout::renderListContent(), SC_db_layout::renderQuickEdit(), tx_cms_layout::renderText(), t3lib_TCEforms::replaceTableWrap(), t3lib_transferData::selectAddForeign(), tx_impexp::singleRecordLines(), SC_browse_links::TBE_dragNDrop(), tx_cms_layout::tt_board_drawItem(), fileList::writeTop(), and localRecordList::writeTop().

t3lib_div::fixed_lgd_pre ( $ string,

$ chars

)

Truncate string Returns a new string of max. $chars length. If the string is longer, it will be truncated and prepended with '...'. This works like fixed_lgd, but is truncated in the start of the string instead of the end DEPRECIATED. Use either fixed_lgd() or fixed_lgd_cs() (with negative input value for $chars) Usage: 6

Parameters:

string $string string to truncate

integer $chars must be an integer of at least 4

Returns:
string new string

See also:
fixed_lgd()

Definition at line 503 of file class.t3lib_div.php.
References fixed_lgd().

t3lib_div::fixPermissions ( $ file )

Setting file system mode & group ownership of file

Parameters:

string Filepath of newly created file

Returns:
void

Definition at line 2133 of file class.t3lib_div.php.
References $GLOBALS.

t3lib_div::fixWindowsFilePath ( $ theFile )

Fixes a path for windows-backslashes and reduces double-slashes to single slashes Usage: 2

Parameters:

string File path to process

Returns:
string

Definition at line 2331 of file class.t3lib_div.php.

t3lib_div::formatForTextarea ( $ content )

Formats a string for output between <textarea>-tags All content outputted in a textarea form should be passed through this function Not only is the content htmlspecialchar'ed on output but there is also a single newline added in the top. The newline is necessary because browsers will ignore the first newline after <textarea> if that is the first character. Therefore better set it! Usage: 23

Parameters:

string Input string to be formatted.

Returns:
string Formatted for <textarea>-tags

Definition at line 1169 of file class.t3lib_div.php.
Referenced by mod_web_dmail::cmd_displayImport(), mod_web_dmail::cmd_quickmail(), t3lib_rteapi::drawRTE(), tslib_cObj::FORM(), t3lib_fullsearch::getQueryResultCode(), t3lib_TCEforms::getSingleField_typeText(), SC_file_edit::main(), tx_tstemplateinfo::main(), SC_mod_tools_log_index::makeSaveForm(), tx_sysmessages::renderMessages(), tx_kickstarter_sectionbase::renderTextareaBox(), SC_mod_tools_em_index::showExtDetails(), tx_systodos::todos_createForm(), and tx_install::typo3conf_edit().

t3lib_div::formatSize ( $ sizeInBytes,

$ labels = '

)

Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M) Usage: 53

Parameters:

integer Number of bytes to format.

string Labels for bytes, kilo, mega and giga separated by vertical bar (|) and possibly encapsulated in "". Eg: " | K| M| G" (which is the default value)

Returns:
string Formatted representation of the byte number, for output.

Definition at line 953 of file class.t3lib_div.php.
References $val.
Referenced by tslib_cObj::bytes(), tx_install::checkTheDatabase(), tx_install::checkTheImageProcessing(), t3lib_TCEmain::checkValue_group_select_file(), mod_web_dmail::cmd_default(), mod_web_dmail::cmd_displayPageInfo(), tx_install::displayTwinImage(), tx_impexp::export_addRecord(), SC_mod_tools_log_index::exportData(), SC_mod_tools_em_index::extDumpTables(), t3lib_tsfeBeUserAuth::extGetCategory_info(), fileList::formatFileList(), SC_mod_tools_em_index::getImportExtList(), SC_mod_tools_isearch_index::getPhashExternalDocs(), SC_mod_tools_isearch_index::getPhashT3pages(), SC_rte_user::main_user(), tx_indexedsearch::makeInfo(), tx_install::typo3conf_edit(), and tx_kickstarter_wizard::view_result().

t3lib_div::freetypeDpiComp ( $ font_size )

Function to compensate for FreeType2 96 dpi Usage: 21

Parameters:

integer Fontsize for freetype function call

Returns:
integer Compensated fontsize based on $GLOBALS['TYPO3_CONF_VARS']['GFX']['TTFdpi']

Definition at line 3739 of file class.t3lib_div.php.
Referenced by SC_t3lib_thumbs::fontGif(), t3lib_stdGraphic::ImageTTFBBoxWrapper(), t3lib_stdGraphic::ImageTTFTextWrapper(), and tx_install::isTTF().

t3lib_div::get_dirs ( $ path )

Returns an array with the names of folders in a specific path Will return 'error' (string) if there were an error with reading directory content. Usage: 11

Parameters:

string Path to list directories from

Returns:
array Returns an array with the directory entries as values. If no path, the return value is nothing.

Definition at line 2213 of file class.t3lib_div.php.
Referenced by SC_mod_tools_dbint_index::findFile(), SC_mod_tools_dbint_index::func_filesearch(), getAllFilesAndFoldersInPath(), t3lib_folderTree::getCount(), t3lib_folderTree::getFolderTree(), SC_mod_tools_em_index::getInstExtList(), and SC_mod_tools_em_index::makeDetailedExtensionAnalysis().

t3lib_div::get_tag_attributes ( $ tag )

Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z $tag is either a whole tag (eg '<tag option="" attrib="VALUE">') or the parameterlist (ex ' OPTION ATTRIB=VALUE>') If a attribute is empty (I call it 'an option'), then the value for the key is empty. You can check if it existed with isset() Usage: 8

Parameters:

string HTML-tag string (or attributes only)

Returns:
array Array with the attribute values.

Definition at line 1545 of file class.t3lib_div.php.
References $key, $name, $val, a, and split_tag_attributes().

t3lib_div::getAllFilesAndFoldersInPath ( $ fileArr,

$ path,

$ extList = ',

$ regDirs = 0,

$ recursivityLevels = 99

)

Recursively gather all files and folders of a path. Usage: 5

Parameters:

array $fileArr: Empty input array (will have files added to it)

string $path: The path to read recursively from (absolute) (include trailing slash!)

string $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.

boolean $regDirs: If set, directories are also included in output.

integer $recursivityLevels: The number of levels to dig down...

Returns:
array An array with the found files/directories.

Definition at line 2292 of file class.t3lib_div.php.
References get_dirs(), getAllFilesAndFoldersInPath(), and getFilesInDir().

t3lib_div::getAllFilesAndFoldersInPath ( $ fileArr,

$ path,

$ extList = ',

$ regDirs = 0,

$ recursivityLevels = 99

)

Recursively gather all files and folders of a path. Usage: 5

Parameters:

array $fileArr: Empty input array (will have files added to it)

string $path: The path to read recursively from (absolute) (include trailing slash!)

string $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.

boolean $regDirs: If set, directories are also included in output.

integer $recursivityLevels: The number of levels to dig down...

Returns:
array An array with the found files/directories.

Definition at line 2292 of file class.t3lib_div.php.
References get_dirs(), and getFilesInDir().
Referenced by t3lib_TCEforms::addSelectOptionsToItemArray(), tx_indexedsearch_modfunc1::extraIndexing(), getAllFilesAndFoldersInPath(), SC_mod_tools_em_index::getClassIndexLocallangFiles(), SC_mod_tools_em_index::getFileListOfExtension(), SC_mod_tools_em_index::makeUploadArray(), and SC_mod_tools_em_index::removeExtDirectory().

t3lib_div::getFileAbsFileName ( $ filename,

$ onlyRelative = 1,

$ relToTYPO3_mainDir = 0

)

Returns the absolute filename of a relative reference, resolves the "EXT:" prefix (way of referring to files inside extensions) and checks that the file is inside the PATH_site of the TYPO3 installation and implies a check with t3lib_div::validPathStr(). Returns false if checks failed. Does not check if the file exists. Usage: 24

Parameters:

string The input filename/filepath to evaluate

boolean If $onlyRelative is set (which it is by default), then only return values relative to the current PATH_site is accepted.

boolean If $relToTYPO3_mainDir is set, then relative paths are relative to PATH_typo3 constant - otherwise (default) they are relative to PATH_site

Returns:
string Returns the absolute filename of $filename IF valid, otherwise blank string.

Definition at line 2892 of file class.t3lib_div.php.
References $filename, t3lib_extMgm::extPath(), isAbsPath(), isFirstPartOfStr(), t3lib_extMgm::isLoaded(), and validPathStr().
Referenced by t3lib_TCEforms::addSelectOptionsToItemArray(), callUserFunction(), t3lib_TSparser::checkIncludeLines(), tx_impexp::checkOrCreateDir(), tx_impexp::export_addFilesFromRelations(), tx_indexedsearch_indexer::extractLinks(), tx_indexedsearch_modfunc1::extraIndexing(), t3lib_softrefproc::fileadminReferences(), t3lib_softrefproc::findRef_images(), t3lib_softrefproc::findRef_TStemplate(), t3lib_BEfunc::getFlexFormDS(), tx_kickstarter_wizard::getFormContent(), t3lib_TCEforms::getIcon(), t3lib_TCEforms::getSingleField_typeGroup(), getUserObj(), SC_mod_tools_log_index::importData(), tx_indexedsearch_indexer::indexRegularDocument(), SC_wizard_colorpicker::init(), t3lib_cs::initCaseFolding(), t3lib_cs::initCharset(), t3lib_recordList::initializeLanguages(), t3lib_cs::initToASCII(), t3lib_cs::initUnicodeData(), tx_tstemplateinfo::main(), SC_view_help::make_seeAlso(), tx_kickstarter_compilefiles::makeFilesArray(), makeInstanceService(), tx_indexedsearch::makeItemTypeIcon(), tx_indexedsearch_modfunc1::makeItemTypeIcon(), SC_index::makeLoginBoxImage(), tslib_fe::pageNotFoundHandler(), SC_view_help::printImage(), tx_impexp::processSoftReferences_saveFile(), tx_impexp::processSoftReferences_saveFile_createRelFile(), readLLfile(), readLLXMLfile(), tx_cssstyledcontent_pi1::render_uploads(), t3lib_TCEforms::renderWizards(), resolveSheetDefInDS(), t3lib_softrefproc::setTypoLinkPartsElement(), t3lib_parsehtml_proc::TS_images_db(), and tx_impexp::writeFileVerify().

t3lib_div::getFilesInDir ( $ path,

$ extensionList = ',

$ prependPath = 0,

$ order = '

)

Returns an array with the names of files in a specific path Usage: 18

Parameters:

string $path: Is the path to the file

string $extensionList is the comma list of extensions to read only (blank = all)

boolean If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array

string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.

Returns:
array Array of the files found

Definition at line 2238 of file class.t3lib_div.php.
Referenced by tx_install::checkTheDatabase(), SC_rte_select_image::expandFolder(), SC_browse_links::expandFolder(), SC_mod_tools_log_index::exportData(), SC_mod_tools_dbint_index::findFile(), getAllFilesAndFoldersInPath(), SC_mod_tools_em_index::getInstExtList(), SC_mod_tools_log_index::importData(), tx_impexp_modfunc1::main(), SC_rte_user::main_user(), SC_index::makeLoginBoxImage(), SC_mod_tools_log_index::makeSaveForm(), tx_install::stepOutput(), SC_browse_links::TBE_dragNDrop(), SC_browse_links::TBE_expandFolder(), tx_install::typo3conf_edit(), and tx_install::typo3TempManager().

t3lib_div::getIndpEnv ( $ getEnvName )

Abstraction method which returns System Environment Variables regardless of server OS, CGI/MODULE version etc. Basically this is SERVER variables for most of them. This should be used instead of getEnv() and HTTP_SERVER_VARS/ENV_VARS to get reliable values for all situations.
Usage: 226

Parameters:

string Name of the "environment variable"/"server variable" you wish to use. Valid values are SCRIPT_NAME, SCRIPT_FILENAME, REQUEST_URI, PATH_INFO, REMOTE_ADDR, REMOTE_HOST, HTTP_REFERER, HTTP_HOST, HTTP_USER_AGENT, HTTP_ACCEPT_LANGUAGE, QUERY_STRING, TYPO3_DOCUMENT_ROOT, TYPO3_HOST_ONLY, TYPO3_HOST_ONLY, TYPO3_REQUEST_HOST, TYPO3_REQUEST_URL, TYPO3_REQUEST_SCRIPT, TYPO3_REQUEST_DIR, TYPO3_SITE_URL, _ARRAY

Returns:
string Value based on the input key, independent of server/os environment.

Definition at line 41 of file incfile.php.
References $envTestVars, dirname(), and trimExplode().
Referenced by alt_menu_functions::adminFunctions(), tslib_fe::beLoginLinkIPList(), tslib_fe::checkAlternativeIdMethods(), t3lib_userAuth::checkAuthentication(), t3lib_tsfeBeUserAuth::checkBackendAccessSettingsFromInitPhp(), tslib_fe::checkDataSubmission(), tslib_fe::checkJumpUrl(), t3lib_beUserAuth::checkLockToIP(), t3lib_userAuthGroup::checkLogFailures(), tx_install::checkPassword(), SC_mod_tools_log_index::checkUpload(), template::clearCacheMenu(), clientInfo(), clickMenu::DB_db_list(), tslib_cObj::editIcons(), tslib_cObj::editPanelLinkWrap(), tslib_cObj::editPanelLinkWrap_doWrap(), t3lib_beUserAuth::emailAtLogin(), t3lib_userAuthGroup::fetchGroups(), SC_browse_links::fileList(), tslib_fe::findDomainRecord(), SC_alt_main::generateJScode(), t3lib_userAuth::getAuthInfoArray(), tslib_fe::getConfigArray(), tx_systodos::getEditRedirectUrlForReference(), t3lib_matchCondition::getGP_ENV_TSFE(), t3lib_BEfunc::getPathType_web_nonweb(), tx_cms_layout::getTable_tt_content(), getThisUrl(), t3lib_parsehtml::HTMLcleaner(), SC_rte_user::init(), SC_rte_cleaner::init(), SC_rte_rte::init(), SC_browse_links::init(), user_feAdmin::init(), t3lib_basicFileFunctions::init(), SC_index::init(), t3lib_userAuth::ipLockClause_remoteIPNumber(), template::issueCommand(), tx_cms_layout::languageSelector(), tx_indexedsearch::linkPage(), fileList::linkWrapFile(), mod_web_dmail::mailModule_main(), SC_wizard_list::main(), SC_wizard_add::main(), SC_tce_file::main(), SC_tce_db::main(), SC_db_list::main(), SC_alt_file_navframe::main(), SC_alt_db_navframe::main(), SC_mod_web_view_index::main(), makeRedirectUrl(), localRecordList::makeReturnUrl(), SC_mod_tools_em_index::makeReturnUrl(), template::makeShortcutIcon(), t3lib_matchCondition::match(), tslib_cObj::netprintApplication_offsiteLinkWrap(), tx_cms_layout::newContentElementOnClick(), t3lib_positionMap::onClickInsertRecord(), TSpagegen::pagegenInit(), tslib_fe::pageNotFoundHandler(), template::parseTime(), tx_install::phpinformation(), tslib_pibase::pi_getEditIcon(), tslib_fe::prefixLocalAnchorsWithScript(), SC_rte_select_image::preinit(), SC_alt_doc::preInit(), freesite_admin::previewData(), tslib_fe::printError(), SC_alt_doc::processData(), TSpagegen::renderContentWithHeader(), SC_db_layout::renderQuickEdit(), mod_user_task::sendEmail(), SC_alt_doc::setDocument(), tslib_fe::setIDfromArgV(), freesite_admin::setNoDomainUrl(), t3lib_parsehtml_proc::siteUrl(), tslib_fe::statistics(), tx_tipafriend::tipform(), tx_tipafriend::tiplink(), t3lib_beUserAuth::trackBeUser(), tx_cms_layout::tt_content_drawHeader(), tslib_cObj::typoLink(), mod_web_dmail::updatePageTS(), t3lib_BEfunc::viewOnClick(), template::viewPageIcon(), t3lib_userAuthGroup::writelog(), and tx_indexedsearch::writeSearchStat().

t3lib_div::getThisUrl ( )

Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename) Usage: 1

Returns:
string

Definition at line 2539 of file class.t3lib_div.php.
References dirname(), and getIndpEnv().

t3lib_div::getURL ( $ url )

Reads the file or url $url and returns the content If you are having trouble with proxys when reading URLs you can configure your way out of that with settings like $TYPO3_CONF_VARS['SYS']['curlUse'] etc. Usage: 83

Parameters:

string Filepath/URL to read

Returns:
string The content from the resource given as input.

Definition at line 2074 of file class.t3lib_div.php.
References $content.
Referenced by t3lib_stdGraphic::cacheImageDimensions(), mod_web_dmail::cmd_fetch(), freesite_admin::createdOutput(), freesite_admin::enteringData(), t3lib_stdGraphic::getCachedImageDimensions(), t3lib_parsehtml_proc::getURL(), and freesite_admin::printSelect().

& t3lib_div::getUserObj ( $ classRef,

$ checkPrefix = user_',

$ silent = 0

)

Creates and returns reference to a user defined object. This function can return an object reference if you like. Just prefix the function call with "&": "$objRef = &t3lib_div::getUserObj('EXT:myext/class.tx_myext_myclass.php:&tx_myext_myclass');". This will work ONLY if you prefix the class name with "&" as well. See description of function arguments. Usage: 5

Parameters:

string Class reference, '[file-reference":"]["&"]class-name'. You can prefix the class name with "[file-reference]:" and t3lib_div::getFileAbsFileName() will then be used to resolve the filename and subsequently include it by "require_once()" which means you don't have to worry about including the class file either! Example: "EXT:realurl/class.tx_realurl.php:&tx_realurl". Finally; for the class name you can prefix it with "&" and you will reuse the previous instance of the object identified by the full reference string (meaning; if you ask for the same $classRef later in another place in the code you will get a reference to the first created one!).

string Required prefix of class name. By default "tx_" is allowed.

boolean If set, no debug() error message is shown if class/function is not present.

Returns:
object The instance of the class asked for. Instance is created with t3lib_div::makeInstance

See also:
callUserFunction()

Definition at line 3441 of file class.t3lib_div.php.
References $GLOBALS, debug(), getFileAbsFileName(), isFirstPartOfStr(), makeInstance(), and revExplode().

t3lib_div::gif_compress ( $ theFile,

$ type

)

Compressing a GIF file if not already LZW compressed This function is a workaround for the fact that ImageMagick and/or GD does not compress GIF-files to their minimun size (that is RLE or no compression used)
The function takes a file-reference, $theFile, and saves it again through GD or ImageMagick in order to compress the file GIF: If $type is not set, the compression is done with ImageMagick (provided that $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw'] is pointing to the path of a lzw-enabled version of 'convert') else with GD (should be RLE-enabled!) If $type is set to either 'IM' or 'GD' the compression is done with ImageMagick and GD respectively PNG: No changes.
$theFile is expected to be a valid GIF-file! The function returns a code for the operation. Usage: 9

Parameters:

string Filepath

string See description of function

Returns:
string Returns "GD" if GD was used, otherwise "IM" if ImageMagick was used. If nothing done at all, it returns empty string.

Definition at line 376 of file class.t3lib_div.php.
References $GLOBALS, gif_compress(), and imageMagickCommand().

t3lib_div::GParrayMerged ( $ var )

Returns the GET/POST global arrays merged with POST taking precedence. Usage: 1

Parameters:

string Key (variable name) from GET or POST vars

Returns:
array Returns the GET vars merged recursively onto the POST vars.

Deprecated:

Definition at line 332 of file class.t3lib_div.php.
References _GET(), _POST(), array_merge_recursive_overrule(), and stripSlashesOnArray().

t3lib_div::GPvar ( $ var,

$ strip = 0

)

GET/POST variable Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order) Strips slashes of string-outputs, but not arrays UNLESS $strip is set. If $strip is set all output will have escaped characters unescaped. Usage: 2

Parameters:

string GET/POST var to return

boolean If set, values are stripped of return values that are *arrays!* - string/integer values returned are always strip-slashed()

Returns:
mixed POST var named $var and if not set, the GET var of the same name.

Deprecated:
Use t3lib_div::_GP instead (ALWAYS delivers a value with un-escaped values!)
See also:
_GP()

Definition at line 315 of file class.t3lib_div.php.
References $value, _POST(), stripSlashesOnArray(), and value.

t3lib_div::hideIfNotTranslated ( $ l18n_cfg_fieldValue )

Responds on input localization setting value whether the page it comes from should be hidden if no translation exists or not.

Parameters:

integer Value from "l18n_cfg" field of a page record

Returns:
boolean True if the page should be hidden

Definition at line 3111 of file class.t3lib_div.php.

t3lib_div::htmlspecialchars_decode ( $ value )

Inverse version of htmlspecialchars() Usage: 4

Parameters:

string Value where >, <, " and & should be converted to regular chars.

Returns:
string Converted result.

Definition at line 1090 of file class.t3lib_div.php.
References $value, and value.
Referenced by tx_indexedsearch_indexer::extractLinks(), t3lib_softrefproc::findRef_images(), t3lib_softrefproc::findRef_TStemplate(), t3lib_parsehtml::get_tag_attributes(), tx_indexedsearch_modfunc1::indexExtUrlRecursively(), SC_alt_doc::makeDocSel(), and user_plaintext::parseBody().

t3lib_div::imageMagickCommand ( $ command,

$ parameters,

$ path = '

)

Compile the command for running ImageMagick/GraphicsMagick.

Parameters:

string Command to be run

string The parameters string

string Override the default path

Returns:
string Compiled command that deals with IM6 & GraphicsMagick

Definition at line 3802 of file class.t3lib_div.php.
References $GLOBALS, $tmp, and unQuoteFilenames().
Referenced by t3lib_stdGraphic::combineExec(), gif_compress(), t3lib_stdGraphic::imageMagickExec(), t3lib_stdGraphic::imageMagickIdentify(), SC_t3lib_thumbs::main(), and png_to_gif_by_imagemagick().

t3lib_div::implodeArrayForUrl ( $ name,

$ theArray,

$ str = ',

$ skipBlank = 0,

$ rawurlencodeParamName = 0

)

Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3) Usage: 24

Parameters:

string Name prefix for entries. Set to blank if you wish none.

array The (multidim) array to implode

string (keep blank)

boolean If set, parameters which were blank strings would be removed.

boolean If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.

Returns:
string Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3

See also:
explodeUrl2Array()

Definition at line 1319 of file class.t3lib_div.php.
Referenced by SC_alt_doc::compileStoreDat(), SC_alt_doc::functionMenus(), t3lib_BEfunc::getFuncCheck(), t3lib_BEfunc::getFuncInput(), t3lib_BEfunc::getFuncMenu(), template::getTabMenu(), tslib_cObj::getTypoLink(), SC_browse_links::init(), SC_alt_doc::init(), tx_indexedsearch::linkPage(), tx_cms_layout::linkRTEbutton(), tslib_fe::makeCacheHash(), tx_indexedsearch_indexer::makeCHash(), template::makeShortcutUrl(), TSpagegen::pagegenInit(), tx_indexedsearch_modfunc1::printPhashRow(), SC_alt_doc::processData(), SC_db_new_content_el::removeInvalidElements(), and SC_db_layout::renderQuickEdit().

t3lib_div::implodeAttributes ( $ arr,

$ xhtmlSafe = FALSE,

$ dontOmitBlankAttribs = FALSE

)

Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes) Usage: 14

Parameters:

array Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0

boolean If set the resulting attribute list will have a) all attributes in lowercase (and duplicates weeded out, first entry taking precedence) and b) all values htmlspecialchar()'ed. It is recommended to use this switch!

boolean If true, don't check if values are blank. Default is to omit attributes with blank values.

Returns:
string Imploded attributes, eg. 'bgcolor="red" border="0"'

Definition at line 1616 of file class.t3lib_div.php.

t3lib_div::implodeParams ( $ arr,

$ xhtmlSafe = FALSE,

$ dontOmitBlankAttribs = FALSE

)

Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)

Parameters:

array See implodeAttributes()

boolean See implodeAttributes()

boolean See implodeAttributes()

Returns:
string See implodeAttributes()

Deprecated:
Name was changed into implodeAttributes
See also:
implodeAttributes()

Definition at line 1643 of file class.t3lib_div.php.
References implodeAttributes().

t3lib_div::inArray ( $ in_array,

$ item

)

Check if an item exists in an array Please note that the order of parameters is reverse compared to the php4-function in_array()!!! Usage: 3

Parameters:

array $in_array one-dimensional array of items

string $item item to check for

Returns:
boolean true if $item is in the one-dimensional array $in_array

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

t3lib_div::int_from_ver ( $ verNumberStr )

Returns an integer from a three part version number, eg '4.12.3' -> 4012003 Usage: 2

Parameters:

string Version number on format x.x.x

Returns:
integer Integer version of version number (where each part can count to 999)

Definition at line 748 of file class.t3lib_div.php.

t3lib_div::intval_positive ( $ theInt )

Returns the $integer if greater than zero, otherwise returns zero. Usage: 1

Parameters:

integer Integer string to process

Returns:
integer

Definition at line 735 of file class.t3lib_div.php.

t3lib_div::isAbsPath ( $ path )

Checks if the $path is absolute or relative (detecting either '/' or 'x:/' as first part of string) and returns true if so. Usage: 8

Parameters:

string Filepath to evaluate

Returns:
boolean

Definition at line 2939 of file class.t3lib_div.php.
Referenced by tx_indexedsearch_modfunc1::extraIndexing(), tslib_fe::getConfigArray(), getFileAbsFileName(), tx_indexedsearch_indexer::indexRegularDocument(), loadTCA(), alt_menu_functions::mIconFile(), alt_menu_functions::mIconFilename(), SC_alt_shortcut::mIconFilename(), and t3lib_stdGraphic::prependAbsolutePath().

t3lib_div::isAllowedAbsPath ( $ path )

Returns true if the path is absolute, without backpath '..' and within the PATH_site OR within the lockRootPath Usage: 5

Parameters:

string Filepath to evaluate

Returns:
boolean

Definition at line 2950 of file class.t3lib_div.php.
Referenced by t3lib_svbase::checkInputFile(), t3lib_clipboard::exportClipElementParameters(), SC_mod_tools_log_index::exportData(), tx_indexedsearch_modfunc1::extraIndexing(), tslib_fe::getConfigArray(), tx_indexedsearch_indexer::indexRegularDocument(), SC_show_item::init(), t3lib_clipboard::printContentFromTab(), clickMenu::printFileClickMenu(), and t3lib_svbase::writeFile().

t3lib_div::isFirstPartOfStr ( $ str,

$ partStr

)

Returns true if the first part of $str matches the string $partStr Usage: 59

Parameters:

string Full string to check

string Reference string which must be found as the "first part" of the full string

Returns:
boolean True if $partStr was found to be equal to the first part of $str

Definition at line 937 of file class.t3lib_div.php.
Referenced by tx_sysaction::action_getUserMainDir(), t3lib_userAuthGroup::addFileMount(), t3lib_extMgm::addService(), tslib_cObj::callUserFunction(), callUserFunction(), freesite_admin::createDirs(), SC_browse_links::createFolder(), SC_view_help::createGlossaryIndex(), t3lib_stdGraphic::createTempSubDir(), SC_rte_rte::filterStyleEl(), tx_ttproducts::finalizeOrder(), t3lib_softrefproc::findRef_images(), t3lib_softrefproc::findRef_TStemplate(), t3lib_extFileFunctions::func_copy(), t3lib_extFileFunctions::func_move(), SC_mod_tools_em_index::getClassIndexLocallangFiles(), getFileAbsFileName(), tx_tstemplatestyler_modfunc1::getFileName(), t3lib_BEfunc::getPathType_web_nonweb(), tx_impexp::getRTEoriginalFilename(), getUserObj(), t3lib_parsehtml::HTMLcleaner(), t3lib_basicFileFunctions::is_webpath(), SC_browse_links::isWebFolder(), fileList::linkWrapFile(), SC_mod_tools_em_index::makeDetailedExtensionAnalysis(), t3lib_matchCondition::match(), tslib_fe::pageNotFoundHandler(), SC_browse_links::parseCurUrl(), tx_impexp::processSoftReferences_saveFile(), tx_impexp::processSoftReferences_saveFile_createRelFile(), SC_mod_tools_em_index::removeExtDirectory(), removePrefixPathFromList(), SC_view_help::render_TOC(), SC_show_item::renderFileInfo(), t3lib_softrefproc::setTypoLinkPartsElement(), SC_mod_tools_em_index::showExtDetails(), tslib_fe::statistics(), t3lib_parsehtml_proc::TS_images_db(), tx_install::typo3conf_edit(), tx_impexp::unlinkTempFiles(), SC_rte_select_image::uploadForm(), SC_browse_links::uploadForm(), tx_impexp::verifyFolderAccess(), writeFileToTypo3tempDir(), and tx_tstemplatestyler_modfunc1::writeResourceFile().

t3lib_div::linkThisScript ( $ getParams = array() )

Returns the link-url to the current script. In $getParams you can set associative keys corresponding to the GET-vars you wish to add to the URL. If you set them empty, they will remove existing GET-vars from the current URL. REMEMBER to always use htmlspecialchars() for content in href-properties to get ampersands converted to entities (XHTML requirement and XSS precaution) Usage: 52

Parameters:

array Array of GET parameters to include

Returns:
string

Definition at line 2555 of file class.t3lib_div.php.
Referenced by t3lib_clipboard::deleteUrl(), ext_posMap_tt_content::linkPageTitle(), ext_posMap_pages::linkPageTitle(), tx_cms_layout::linkRTEbutton(), tx_kickstarter_sectionbase::linkThisCmd(), SC_db_layout::local_linkThisScript(), t3lib_clipboard::pasteUrl(), t3lib_clipboard::printClipboard(), template::redirectUrls(), t3lib_clipboard::removeUrl(), t3lib_clipboard::selUrlDB(), t3lib_clipboard::selUrlFile(), SC_alt_doc::shortCutLink(), SC_mod_tools_em_index::showExtDetails(), t3lib_TCEforms::thisReturnUrl(), and SC_mod_tools_em_index::updatesForm().

t3lib_div::linkThisUrl ( $ url,

$ getParams = array()

)

Takes a full URL, $url, possibly with a querystring and overlays the $getParams arrays values onto the quirystring, packs it all together and returns the URL again. So basically it adds the parameters in $getParams to an existing URL, $url Usage: 2

Parameters:

string URL string

array Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.

Returns:
string Output URL with added getParams.

Definition at line 2579 of file class.t3lib_div.php.

t3lib_div::loadTCA ( $ table )

Loads the $TCA (Table Configuration Array) for the $table
Requirements: 1) must be configured table (the ctrl-section configured), 2) columns must not be an array (which it is always if whole table loaded), and 3) there is a value for dynamicConfigFile (filename in typo3conf) Usage: 84

Parameters:

string Table name for which to load the full TCA array part into the global $TCA

Returns:
void

Definition at line 3262 of file class.t3lib_div.php.
References $TCA, isAbsPath(), and table.
Referenced by t3lib_extMgm::addPiFlexFormValue(), t3lib_extMgm::addPlugin(), t3lib_extMgm::addStaticFile(), t3lib_extMgm::addTCAcolumns(), t3lib_extMgm::addToAllTCAtypes(), t3lib_extMgm::addToInsertRecords(), t3lib_userAuthGroup::checkAuthMode(), t3lib_TCEmain::checkValue(), mod_web_dmail::cmd_fetch(), t3lib_TCEmain::copyRecord(), t3lib_TCEmain::copyRecord_localize(), t3lib_TCEmain::copyRecord_raw(), tx_cms_layout::dataFields(), user_feAdmin::deleteFilesFromRecord(), freesite_admin::displayDataForms(), local_beUserAuth::ext_printOverview(), t3lib_TCEmain::extFileFields(), t3lib_TCEmain::extFileFunctions(), t3lib_transferData::fetchRecord(), localRecordList::fieldSelectBox(), t3lib_TCEmain::fillInFieldArray(), t3lib_TCEmain::fixCopyAfterDuplFields(), t3lib_TCEmain::fixUniqueInPid(), recordList::generateList(), tslib_fe::getCompressedTCarray(), t3lib_TCEforms::getDefaultRecord(), t3lib_BEfunc::getExcludeFields(), t3lib_TCEmain::getExcludeListArray(), t3lib_BEfunc::getExplicitAuthFieldValues(), t3lib_BEfunc::getItemLabel(), t3lib_BEfunc::getLabelFromItemlist(), t3lib_TCEforms::getListedFields(), t3lib_TCEforms::getMainFields(), t3lib_TCEforms::getPaletteFields(), t3lib_BEfunc::getProcessedValue(), t3lib_TCEforms::getSingleField(), t3lib_TCEforms::getSingleHiddenField(), t3lib_TCEforms::getSoloField(), tx_cms_layout::getTable(), localRecordList::getTable(), t3lib_BEfunc::getTCAtypes(), t3lib_BEfunc::getTCAtypeValue(), t3lib_TCEmain::getUnique(), tx_cms_layout::headerFields(), tx_install::includeTCA(), SC_show_item::init(), t3lib_treeView::init(), t3lib_queryGenerator::init(), t3lib_recordList::initializeLanguages(), t3lib_admin::lostRecords(), SC_wizard_edit::main(), tx_tstemplateinfo::main(), SC_mod_tools_config_index::main(), SC_view_help::make_seeAlso(), localRecordList::makeControl(), SC_mod_tools_em_index::makeDetailedExtensionAnalysis(), recordList::makeFieldList(), t3lib_queryGenerator::makeFieldList(), recordList::makeSearchString(), mod_web_dmail::mod_web_dmail(), tx_version_cm1::moduleContent(), t3lib_TCEmain::newFieldArray(), SC_view_help::printItem(), user_feAdmin::processFiles(), tx_impexp::processSoftReferences(), t3lib_userAuthGroup::recordEditAccessInternals(), transferData::regItem(), t3lib_TCEmain::remapListedDBRecords(), recordHistory::removeFilefields(), SC_db_new_content_el::removeInvalidElements(), tx_kickstarter_section_fields::render_extPart(), SC_view_help::render_Table(), recordHistory::renderEntry(), SC_db_layout::renderListContent(), t3lib_transferData::renderRecord(), t3lib_transferData::renderRecordRaw(), t3lib_fullsearch::search(), tx_impexp::setFlexFormRelations(), recordList::showSysNotesForPage(), tslib_feTCE::start(), t3lib_BEfunc::thumbCode(), tx_cms_layout::tt_content_drawHeader(), and t3lib_admin::whereIsRecordReferenced().

t3lib_div::locationHeaderUrl ( $ path )

Prefixes a URL used with 'header-location' with 'http://...' depending on whether it has it already.

If already having a scheme, nothing is prepended
If having REQUEST_URI slash '/', then prefixing 'http://[host]' (relative to host)
Otherwise prefixed with TYPO3_REQUEST_DIR (relative to current dir / TYPO3_REQUEST_DIR) Usage: 30

Parameters:

string URL / path to prepend full URL addressing to.

Returns:
string

Definition at line 2370 of file class.t3lib_div.php.
Referenced by SC_index::checkRedirect(), tx_install::checkTheDatabase(), SC_alt_doc::closeDocument(), SC_tce_file::finish(), SC_tce_db::finish(), tslib_fe::getConfigArray(), SC_wizard_table::getConfigCode(), SC_wizard_forms::getConfigCode(), SC_wizard_add::init(), SC_index::init(), SC_logout::logout(), SC_wizard_list::main(), SC_wizard_edit::main(), SC_wizard_add::main(), SC_mod_help_quick_index::main(), tx_install::outputExitBasedOnStep(), tslib_fe::pageNotFoundHandler(), SC_mod_web_view_index::printContent(), tx_sysaction::renderActions(), SC_db_layout::renderQuickEdit(), recordHistory::revertToPreviousValues(), SC_alt_doc::setDocument(), SC_mod_tools_be_user_index::switchUser(), and mod_web_dmail::updatePageTS().

& t3lib_div::makeInstance ( $ className )

Make instance of class Takes the class-extensions API of TYPO3 into account Please USE THIS instead of the PHP "new" keyword. Eg. "$obj = new myclass;" should be "$obj = t3lib_div::makeInstance("myclass")" instead! Usage: 447

Parameters:

string Class name to instantiate

Returns:
object The object

Definition at line 3499 of file class.t3lib_div.php.
References makeInstance().

t3lib_div Class Reference

Public Member Functions

Detailed Description

Member Function Documentation