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_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)

Detailed Description

Definition at line 10 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 stripSlashesOnArray().

Referenced by SC_alt_main::editPageHandling(), SC_mod_tools_dbint_index::func_records(), SC_show_item::init(), linkThisScript(), 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(), 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 addSlashesOnArray().

Referenced by tslib_fe::mergingWithGetVars(), and SC_rte_select_image::preinit().

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

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(), SC_t3lib_thumbs::init(), t3lib_SCbase::init(), SC_tslib_showpic::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(), tx_install::loginForm(), 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_log_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(), 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_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 stripSlashesOnArray().

Referenced by 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(), t3lib_userAuth::getLoginFormData(), 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.

Referenced by _GETset().

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.

Referenced by t3lib_TCEmain::checkValue_flexArray2Xml(), SC_wizard_table::getConfigCode(), SC_wizard_forms::getConfigCode(), and t3lib_transferData::renderRecord_flexProc().

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.

Referenced by breakTextForEmail(), and tslib_feUserAuth::fetchGroupData().

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(), linkThisUrl(), tx_belog_webinfo::localLang(), SC_rte_user::main_user(), tslib_fe::mergingWithGetVars(), mod_web_dmail::mod_web_dmail(), tslib_pibase::pi_linkTP_keepPIvars(), tslib_pibase::pi_setPiVarDefaults(), t3lib_TCEmain::process_cmdmap(), t3lib_BEfunc::RTEsetup(), language::sL(), 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 fixed_lgd().

Referenced by t3lib_userAuth::checkAuthentication(), tslib_feUserAuth::fetchGroupData(), tx_sv_auth::getUser(), t3lib_modSettings::processStoreControl(), and t3lib_userAuth::start().

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.

Referenced by tx_sysmessages::breakLines(), user_plaintext::breakLines(), and breakTextForEmail().

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 array_merge(), and breakLinesForEmail().

Referenced by mod_web_dmail::cmd_quickmail().

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

Referenced by tslib_cObj::stdWrap().

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.

Referenced by calcParenthesis().

t3lib_div::callUserFunction (  $  funcName,
&$  params,
&$  ref,
$  checkPrefix = 'user_',
$  silent = 0
) 
 

Calls a userdefined function/method in class Such a function/method should look like this: "function proc(&$params, &$ref) {...}" Usage: 17

Parameters:
string Function/Method reference, '[file-reference":"]["&"]class/function["->"method-name]'. You can prefix this reference 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->encodeSpURL". Finally; you can prefix the class name with "&" if you want to reuse a former instance of the same object call ("singleton").
mixed Parameters to be pass along (typically an array) (REFERENCE!)
mixed Reference to be passed along (typically "$this" - being a reference to the calling object) (REFERENCE!)
string Required prefix of class or function name
boolean If set, no debug() error message is shown if class/function is not present.
Returns:
mixed Content from method/function call
See also:
getUserObj()

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

References getFileAbsFileName(), isFirstPartOfStr(), makeInstance(), and revExplode().

Referenced by t3lib_userAuthGroup::calcPerms(), tslib_fe::checkAlternativeIdMethods(), t3lib_TCEmain::clear_cache(), tslib_fe::connectToDB(), tslib_fe::determineId(), devLog(), t3lib_pageSelect::enableFields(), t3lib_tsfeBeUserAuth::extEditAction(), tslib_fe::generatePage_postProcessing(), t3lib_userAuthGroup::getPagePermsClause(), t3lib_TCEforms::getSingleField_typeUser(), tslib_fe::headerNoCache(), tslib_fe::hook_eofe(), t3lib_parsehtml::HTMLcleaner(), tslib_fe::initFEuser(), tslib_fe::isOutputting(), t3lib_userAuth::logoff(), tslib_fe::pageNotFoundHandler(), tx_kickstarter_sectionbase::process_hook(), tslib_fe::processOutput(), t3lib_transferData::procItems(), t3lib_TCEforms::procItems(), tx_kickstarter_section_tsconfig::render_wizard(), tx_kickstarter_section_ts::render_wizard(), tx_kickstarter_section_tables::render_wizard(), tx_kickstarter_section_sv::render_wizard(), tx_kickstarter_section_pi::render_wizard(), tx_kickstarter_section_modulefunction::render_wizard(), tx_kickstarter_section_module::render_wizard(), tx_kickstarter_section_languages::render_wizard(), tx_kickstarter_section_fields::render_wizard(), tx_kickstarter_section_emconf::render_wizard(), t3lib_TCEforms::renderWizards(), tx_kickstarter_wizard::sidemenu(), tslib_gifBuilder::start(), t3lib_userAuth::start(), tslib_fe::tslib_fe(), and SC_mod_tools_em_index::tsStyleConfigForm().

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

Referenced by tslib_fe::cHashParams(), tslib_fe::makeCacheHash(), tx_indexedsearch_indexer::makeCHash(), and tslib_cObj::typoLink().

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

Referenced by t3lib_TCEforms::t3lib_TCEforms(), and tslib_fe::tslib_fe().

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

Referenced by t3lib_matchCondition::match().

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

Referenced by tslib_fe::beLoginLinkIPList(), t3lib_tsfeBeUserAuth::checkBackendAccessSettingsFromInitPhp(), t3lib_beUserAuth::checkLockToIP(), tx_sv_auth::getGroups(), t3lib_matchCondition::match(), and tslib_fe::statistics().

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.

Referenced by SC_alt_doc::compileStoreDat(), and template::makeShortcutUrl().

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.

Referenced by tx_install::checkTheImageProcessing().

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 = ',',
$  quote = '"'
) 
 

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.

Referenced by t3lib_fullsearch::csvValues(), mod_web_dmail::downloadCSV(), and localRecordList::setCsvRow().

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.

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 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;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
Returns:
string Converted result.

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

Referenced by 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