API: class.t3lib

class.t3lib_div.php

The legendary "t3lib_div" class - Miscellaneous functions for general purpose.
Most of the functions does not relate specifically to TYPO3
However a section of functions requires certain TYPO3 features available
See comments in the source.
You are encouraged to use this library in your own scripts!

USE:
The class is intended to be used without creating an instance of it.
So: Don't instantiate - call functions with "t3lib_div::" prefixed the function name.
So use t3lib_div::[method-name] to refer to the functions, eg. 't3lib_div::milliseconds()'

Files: 1
Total filesizes: 162 Kbytes
Functions and classes: 139

class.t3lib_div.php

class t3lib_div

@package: TYPO3

@subpackage: t3lib

GET/POST Variables
Background:
Input GET/POST variables in PHP may have their quotes escaped with "\" or not depending on configuration.
TYPO3 has always converted quotes to BE escaped if the configuration told that they would not be so.
But the clean solution is that quotes are never escaped and that is what the functions below offers.
Eventually TYPO3 should provide this in the global space as well.
In the transitional phase (or forever..?) we need to encourage EVERY to read and write GET/POST vars through the API functions below.

function _GP($var)

function _GET($var=NULL)

function _POST($var=NULL)

function _GETset($inputGet,$key='')

function GPvar($var,$strip=0)

function GParrayMerged($var)

IMAGE FUNCTIONS

function gif_compress($theFile, $type)

function png_to_gif_by_imagemagick($theFile)

function read_png_gif($theFile,$output_png=0)

STRING FUNCTIONS

function fixed_lgd($string,$origChars,$preStr='...')

function fixed_lgd_pre($string,$chars)

function fixed_lgd_cs($string,$chars)

function breakTextForEmail($str,$implChar="\n",$charWidth=76)

function breakLinesForEmail($str,$implChar="\n",$charWidth=76)

function cmpIP($baseIP, $list)

function cmpIPv4($baseIP, $list)

function cmpIPv6($baseIP, $list)

function IPv6Hex2Bin ($hex)

function normalizeIPv6($address)

function validIPv6($ip)

function cmpFQDN($baseIP, $list)

function inList($list,$item)

function rmFromList($element,$list)

function expandList($list)

function intInRange($theInt,$min,$max=2000000000,$zeroValue=0)

function intval_positive($theInt)

function int_from_ver($verNumberStr)

function compat_version($verNumberStr)

function md5int($str)

function shortMD5($input, $len=10)

function uniqueList($in_list, $secondParameter=NULL)

function split_fileref($fileref)

function dirname($path)

function modifyHTMLColor($color,$R,$G,$B)

function modifyHTMLColorAll($color,$all)

function rm_endcomma($string)

function danish_strtoupper($string)

function convUmlauts($str)

function testInt($var)

function isFirstPartOfStr($str,$partStr)

function formatSize($sizeInBytes,$labels='')

function convertMicrotime($microtime)

function splitCalc($string,$operators)

function calcPriority($string)

function calcParenthesis($string)

function htmlspecialchars_decode($value)

function deHSCentities($str)

function slashJS($string,$extended=0,$char="'")

function rawUrlEncodeJS($str)

function rawUrlEncodeFP($str)

function validEmail($email)

function formatForTextarea($content)

ARRAY FUNCTIONS

function inArray($in_array,$item)

function intExplode($delim, $string)

function revExplode($delim, $string, $count=0)

function trimExplode($delim, $string, $onlyNonEmptyValues=0)

function uniqueArray($valueArray)

function removeArrayEntryByValue($array,$cmpValue)

function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0)

function explodeUrl2Array($string,$multidim=FALSE)

function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1)

function addSlashesOnArray(&$theArray)

function stripSlashesOnArray(&$theArray)

function slashArray($arr,$cmd)

function array_merge_recursive_overrule($arr0,$arr1,$notAddKeys=0,$includeEmtpyValues=true)

function array_merge($arr1,$arr2)

function csvValues($row,$delim=',',$quote='"')

HTML/XML PROCESSING

function get_tag_attributes($tag)

function split_tag_attributes($tag)

function implodeAttributes($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)

function implodeParams($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)

function wrapJS($string, $linebreak=TRUE)

function xml2tree($string,$depth=999)

function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0, $options=array(),$stackData=array())

function xml2array($string,$NSprefix='',$reportDocTag=FALSE)

function xmlRecompileFromStructValArray($vals)

function xmlGetHeaderAttribs($xmlData)

FILES FUNCTIONS

function getURL($url, $includeHeader=0)

function writeFile($file,$content)

function fixPermissions($file)

function writeFileToTypo3tempDir($filepath,$content)

function mkdir($theNewFolder)

function mkdir_deep($destination,$deepDir)

function get_dirs($path)

function getFilesInDir($path,$extensionList='',$prependPath=0,$order='')

function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99)

function removePrefixPathFromList($fileArr,$prefixToRemove)

function fixWindowsFilePath($theFile)

function resolveBackPath($pathStr)

function locationHeaderUrl($path)

DEBUG helper FUNCTIONS

function debug_ordvalue($string,$characters=100)

function view_array($array_in)

function print_array($array_in)

function debug($var="",$brOrHeader=0)

function debug_trail()

function debugRows($rows,$header='')

SYSTEM INFORMATION

function getThisUrl()

function linkThisScript($getParams=array())

function linkThisUrl($url,$getParams=array())

function getIndpEnv($getEnvName)

function milliseconds()

function clientInfo($useragent='')

TYPO3 SPECIFIC FUNCTIONS

function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0)

function validPathStr($theFile)

@todo: Possible improvement: Should it rawurldecode the string first to check if any of these characters is encoded ?

function isAbsPath($path)

function isAllowedAbsPath($path)

function verifyFilenameAgainstDenyPattern($filename)

function upload_copy_move($source,$destination)

function upload_to_tempfile($uploadedFileName)

function unlink_tempfile($uploadedTempFileName)

function tempnam($filePrefix)

function stdAuthCode($uid_or_record,$fields='',$codeLength=8)

function cHashParams($addQueryParams)

function hideIfNotTranslated($l18n_cfg_fieldValue)

function readLLfile($fileRef,$langKey)

function readLLXMLfile($fileRef,$langKey)

function llXmlAutoFileName($fileRef,$language)

function loadTCA($table)

function resolveSheetDefInDS($dataStructArray,$sheet='sDEF')

function resolveAllSheetsInDS($dataStructArray)

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

function &getUserObj($classRef,$checkPrefix='user_',$silent=0)

function &makeInstance($className)

function makeInstanceClassName($className)

function &makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys=array())

function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='',$dontEncodeHeader=false)

function quoted_printable($string,$maxlen=76)

function encodeHeader($line,$enc='',$charset='ISO-8859-1')

function substUrlsInPlainText($message,$urlmode='76',$index_script_url='')

function makeRedirectUrl($inUrl,$l=0,$index_script_url='')

function freetypeDpiComp($font_size)

function initSysLog()

function sysLog($msg, $extKey, $severity=0)

function devLog($msg, $extKey, $severity=0, $dataVar=FALSE)

function arrayToLogString($arr, $valueList=array(), $valueLength=20)

function imageMagickCommand($command, $parameters, $path='')

function unQuoteFilenames($parameters,$unQuote=FALSE)

function quoteJSvalue($value, $inScriptTags = false)

Detailed descriptions:

class.t3lib_div.php

Filesize:	162 K
Func/Classes:	139
Tags:	@author Kasper Skaarhoj <kasperYYYY@typo3.com> @package TYPO3 @subpackage t3lib

class t3lib_div

Returns:	[type]	...
	@author Kasper Skaarhoj <kasperYYYY@typo3.com>
	@package TYPO3
	@subpackage t3lib

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

$var	string	GET/POST var to return
Returns:	mixed	POST var named $var and if not set, the GET var of the same name.
	@see GPvar()

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

$var=NULL	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 _POST(), _GP(), _GETset()

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

$var=NULL	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 _GET(), _GP()

function _GETset($inputGet,$key='')

Writes input value to $_GET
Usage: 2

$inputGet	array	Array to write to $_GET. Values should NOT be escaped at input time (but will be escaped before writing according to TYPO3 standards).
$key=''	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

function 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

$var	string	GET/POST var to return
$strip=0	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 _GP()

function GParrayMerged($var)

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

$var	string	Key (variable name) from GET or POST vars
Returns:	array	Returns the GET vars merged recursively onto the POST vars.
	@deprecated

function 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

$theFile	string	Filepath
$type	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.
	@internal

function png_to_gif_by_imagemagick($theFile)

Converts a png file to gif
This converts a png file to gif IF the FLAG $GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif'] is set true.
Usage: 5

$theFile	string	$theFile the filename with path
Returns:	string	new filename
	@internal

function read_png_gif($theFile,$output_png=0)

Returns filename of the png/gif version of the input file (which can be png or gif).
If input file type does not match the wanted output type a conversion is made and temp-filename returned.
Usage: 2

$theFile	string	Filepath of image file
$output_png=0	boolean	If set, then input file is converted to PNG, otherwise to GIF
Returns:	string	If the new image file exists, it's filepath is returned
	@internal

function 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 '...'.
DEPRECATED. Works ONLY for single-byte charsets! USE t3lib_div::fixed_lgd_cs() instead
Usage: 39

$string	string	string to truncate
$origChars	integer	must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
$preStr='...'	string	String to append to the output if it is truncated, default is '...'
Returns:	string	new string
	@see fixed_lgd_pre()

function 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
DEPRECATED. Use either fixed_lgd() or fixed_lgd_cs() (with negative input value for $chars)
Usage: 6

$string	string	string to truncate
$chars	integer	must be an integer of at least 4
Returns:	string	new string
	@see fixed_lgd()

function fixed_lgd_cs($string,$chars)

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

$string	string	string to truncate
$chars	integer	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 fixed_lgd()

function breakTextForEmail($str,$implChar="\n",$charWidth=76)

Breaks up the text for emails
Usage: 1

$str	string	The string to break up
$implChar="\n"	string	The string to implode the broken lines with (default/typically \n)
$charWidth=76	integer	The line length
Returns:	string

function breakLinesForEmail($str,$implChar="\n",$charWidth=76)

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

$str	string	The string to break up
$implChar="\n"	string	The string to implode the broken lines with (default/typically \n)
$charWidth=76	integer	The line length
Returns:	string
	@see breakTextForEmail()

function cmpIP($baseIP, $list)

Match IP number with list of numbers with wildcard
Dispatcher method for switching into specialised IPv4 and IPv6 methods.
Usage: 10

$baseIP	string	$baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
$list	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). If list is "*" no check is done and the function returns TRUE immediately.
Returns:	boolean	True if an IP-mask from $list matches $baseIP

function cmpIPv4($baseIP, $list)

Match IPv4 number with list of numbers with wildcard

$baseIP	string	$baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
$list	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

function cmpIPv6($baseIP, $list)

Match IPv6 address with a list of IPv6 prefixes

$baseIP	string	$baseIP is the current remote IP address for instance
$list	string	$list is a comma-list of IPv6 prefixes, could also contain IPv4 addresses
Returns:	boolean	True if an baseIP matches any prefix

function IPv6Hex2Bin ($hex)

[Describe function...]

$hex	[type]	$hex: ...
Returns:	[type]	...

function normalizeIPv6($address)

Normalize an IPv6 address to full length

$address	string	Given IPv6 address
Returns:	string	Normalized address

function validIPv6($ip)

Validate a given IP address to the IPv6 address format.

Example for possible format: 43FB::BB3F:A0A0:0 | ::1

$ip	string	IP address to be tested
Returns:	boolean	True if $ip is of IPv6 format.

function cmpFQDN($baseIP, $list)

Match fully qualified domain name with list of strings with wildcard

$baseIP	string	The current remote IP address for instance, typ. REMOTE_ADDR
$list	string	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

function inList($list,$item)

Check for item in list
Check if an item exists in a comma-separated list of items.
Usage: 163

$list	string	comma-separated list of items (string)
$item	string	item to check for
Returns:	boolean	true if $item is in $list

function rmFromList($element,$list)

Removes an item from a comma-separated list of items.
Usage: 1

$element	string	element to remove
$list	string	comma-separated list of items (string)
Returns:	string	new comma-separated list of items

function 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.

$list	string	comma-separated list of integers with ranges (string)
Returns:	string	new comma-separated list of items
	@author Martin Kutschker <martin.kutschker@activesolution.at>

function intInRange($theInt,$min,$max=2000000000,$zeroValue=0)

Forces the integer $theInt into the boundaries of $min and $max. If the $theInt is 'false' then the $zeroValue is applied.
Usage: 224

$theInt	integer	Input value
$min	integer	Lower limit
$max=2000000000	integer	Higher limit
$zeroValue=0	integer	Default value if input is false.
Returns:	integer	The input value forced into the boundaries of $min and $max

function intval_positive($theInt)

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

$theInt	integer	Integer string to process
Returns:	integer

function int_from_ver($verNumberStr)

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

$verNumberStr	string	Version number on format x.x.x
Returns:	integer	Integer version of version number (where each part can count to 999)

function compat_version($verNumberStr)

Returns true if the current TYPO3 version (or compatibility version) is compatible to the input version

$verNumberStr	string	Minimum version number required (format x.y.z)
Returns:	boolean	true or false

function md5int($str)

Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
Usage: 5

$str	string	String to md5-hash
Returns:	integer	Returns 28bit integer-hash

function shortMD5($input, $len=10)

Returns the first 10 positions of the MD5-hash (changed from 6 to 10 recently)

Usage: 37

$input	string	Input string to be md5-hashed
$len=10	integer	The string-length of the output
Returns:	string	Substring of the resulting md5-hash, being $len chars long (from beginning)

function uniqueList($in_list, $secondParameter=NULL)

Takes comma-separated lists and arrays and removes all duplicates
If a value in the list is trim(empty), the value is ignored.
Usage: 16

$in_list	string	Accept multiple parameters wich can be comma-separated lists of values and arrays.
$secondParameter=NULL	mixed	$secondParameter: Dummy field, which if set will show a warning!
Returns:	string	Returns the list without any duplicates of values, space around values are trimmed

function split_fileref($fileref)

Splits a reference to a file in 5 parts
Usage: 43

$fileref	string	Filename/filepath to be analysed
Returns:	array	Contains keys [path], [file], [filebody], [fileext], [realFileext]

function 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

$path	string	Directory name / path
Returns:	string	Processed input value. See function description.

function modifyHTMLColor($color,$R,$G,$B)

Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
Usage: 11

$color	string	A hexadecimal color code, #xxxxxx
$R	integer	Offset value 0-255
$G	integer	Offset value 0-255
$B	integer	Offset value 0-255
Returns:	string	A hexadecimal color code, #xxxxxx, modified according to input vars
	@see modifyHTMLColorAll()

function modifyHTMLColorAll($color,$all)

Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
Usage: 6

$color	string	A hexadecimal color code, #xxxxxx
$all	integer	Offset value 0-255 for all three channels.
Returns:	string	A hexadecimal color code, #xxxxxx, modified according to input vars
	@see modifyHTMLColor()

function rm_endcomma($string)

Removes comma (if present) in the end of string
Usage: 2

$string	string	String from which the comma in the end (if any) will be removed.
Returns:	string

function danish_strtoupper($string)

strtoupper which converts danish (and other characters) characters as well
(DEPRECATED, use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
Usage: 0

$string	string	String to process
Returns:	string

function 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.
(DEPRECATED: Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!)

ä => ae, Ö => Oe

$str	string	String to convert.
Returns:	string

function testInt($var)

Tests if the input is an integer.
Usage: 77

$var	mixed	Any input variable to test.
Returns:	boolean	Returns true if string is an integer

function isFirstPartOfStr($str,$partStr)

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

$str	string	Full string to check
$partStr	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

function formatSize($sizeInBytes,$labels='')

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

$sizeInBytes	integer	Number of bytes to format.
$labels=''	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.

function convertMicrotime($microtime)

Returns microtime input to milliseconds
Usage: 2

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

function splitCalc($string,$operators)

This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
Usage: 2

$string	string	Input string, eg "123 + 456 / 789 - 4"
$operators	string	Operators to split by, typically "/+-*"
Returns:	array	Array with operators and operands separated.
	@see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()

function calcPriority($string)

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

$string	string	Input string, eg "123 + 456 / 789 - 4"
Returns:	integer	Calculated value. Or error string.
	@see calcParenthesis()

function calcParenthesis($string)

Calculates the input with parenthesis levels
Usage: 2

$string	string	Input string, eg "(123 + 456) / 789 - 4"
Returns:	integer	Calculated value. Or error string.
	@see calcPriority(), tslib_cObj::stdWrap()

function htmlspecialchars_decode($value)

Inverse version of htmlspecialchars()
Usage: 4

$value	string	Value where >, <, " and & should be converted to regular chars.
Returns:	string	Converted result.

function deHSCentities($str)

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

$str	string	String which contains eg. "&amp;" which should stay "&". Or "&#1234;" to "Ӓ". Or "&#x1b;" to ""
Returns:	string	Converted result.

function slashJS($string,$extended=0,$char="'")

This function is used to escape any ' -characters when transferring text to JavaScript!
Usage: 3

$string	string	String to escape
$extended=0	boolean	If set, also backslashes are escaped.
$char="'"	string	The character to escape, default is ' (single-quote)
Returns:	string	Processed input string

function rawUrlEncodeJS($str)

Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
Usage: 4

$str	string	String to raw-url-encode with spaces preserved
Returns:	string	Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.

function rawUrlEncodeFP($str)

rawurlencode which preserves "/" chars
Usefull when filepaths should keep the "/" chars, but have all other special chars encoded.
Usage: 5

$str	string	Input string
Returns:	string	Output string

function validEmail($email)

Checking syntax of input email address
Usage: 5

$email	string	Input string to evaluate
Returns:	boolean	Returns true if the $email address (input string) is valid; Has a "@", domain name with at least one period and only allowed a-z characters.

function 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

$content	string	Input string to be formatted.
Returns:	string	Formatted for <textarea>-tags

function 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

$in_array	array	one-dimensional array of items
$item	string	item to check for
Returns:	boolean	true if $item is in the one-dimensional array $in_array
	@internal

function intExplode($delim, $string)

Explodes a $string delimited by $delim and passes each item in the array through intval().
Corresponds to explode(), but with conversion to integers for all values.
Usage: 76

$delim	string	Delimiter string to explode with
$string	string	The string to explode
Returns:	array	Exploded values, all converted to integers

function revExplode($delim, $string, $count=0)

Reverse explode which explodes the string counting from behind.
Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
Usage: 8

$delim	string	Delimiter string to explode with
$string	string	The string to explode
$count=0	integer	Number of array entries
Returns:	array	Exploded values

function trimExplode($delim, $string, $onlyNonEmptyValues=0)

Explodes a string and trims all values for whitespace in the ends.
If $onlyNonEmptyValues is set, then all blank ('') values are removed.
Usage: 256

$delim	string	Delimiter string to explode with
$string	string	The string to explode
$onlyNonEmptyValues=0	boolean	If set, all empty values (='') will NOT be set in output
Returns:	array	Exploded values

function uniqueArray($valueArray)

Remove duplicate values from an array
This function is deprecated, use the PHP function array_unique instead
Usage: 0

$valueArray	array	Array of values to make unique
Returns:	array
	@deprecated

function removeArrayEntryByValue($array,$cmpValue)

Removes the value $cmpValue from the $array if found there. Returns the modified array
Usage: 3

$array	array	Array containing the values
$cmpValue	string	Value to search for and if found remove array entry where found.
Returns:	array	Output array with entries removed if search string is found

function 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

$name	string	Name prefix for entries. Set to blank if you wish none.
$theArray	array	The (multidim) array to implode
$str=''	string	(keep blank)
$skipBlank=0	boolean	If set, parameters which were blank strings would be removed.
$rawurlencodeParamName=0	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 explodeUrl2Array()

function explodeUrl2Array($string,$multidim=FALSE)

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

$string	string	GETvars string
$multidim=FALSE	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 implodeArrayForUrl()

function 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

$varList	string	List of variable/key names
$getArray	array	Array from where to get values based on the keys in $varList
$GPvarAlt=1	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.

function 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

&$theArray	array	Multidimensional input array, (REFERENCE!)
Returns:	array

function stripSlashesOnArray(&$theArray)

StripSlash array
This function traverses a multidimentional array and strips slashes to the values.
NOTE that the input array is and argument by reference.!!
Twin-function to addSlashesOnArray
Usage: 10

&$theArray	array	Multidimensional input array, (REFERENCE!)
Returns:	array

function slashArray($arr,$cmd)

Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
Usage: 0

$arr	array	Multidimensional input array
$cmd	string	"add" or "strip", depending on usage you wish.
Returns:	array

function 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

$arr0	array	First array
$arr1	array	Second array, overruling the first array
$notAddKeys=0	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.
$includeEmtpyValues=true	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

function 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

$arr1	array	First array
$arr2	array	Second array
Returns:	array	Merged result.

function 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

$row	array	Input array of values
$delim=','	string	Delimited, default is comman
$quote='"'	string	Quote-character to wrap around the values.
Returns:	string	A single line of CSV

function 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

$tag	string	HTML-tag string (or attributes only)
Returns:	array	Array with the attribute values.

function split_tag_attributes($tag)

Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
Removes tag-name if found
Usage: 2

$tag	string	HTML-tag string (or attributes only)
Returns:	array	Array with the attribute values.
	@internal

function 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

$arr	array	Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
$xhtmlSafe=FALSE	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!
$dontOmitBlankAttribs=FALSE	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"'

function implodeParams($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)

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

$arr	array	See implodeAttributes()
$xhtmlSafe=FALSE	boolean	See implodeAttributes()
$dontOmitBlankAttribs=FALSE	boolean	See implodeAttributes()
Returns:	string	See implodeAttributes()
	@deprecated Name was changed into implodeAttributes
	@see implodeAttributes()

function wrapJS($string, $linebreak=TRUE)

Wraps JavaScript code XHTML ready with <script>-tags
Automatic re-identing of the JS code is done by using the first line as ident reference.
This is nice for identing JS code with PHP code on the same level.

$string	string	JavaScript code
$linebreak=TRUE	boolean	Wrap script element in linebreaks? Default is TRUE.
Returns:	string	The wrapped JS code, ready to put into a XHTML page
	@author Ingmar Schlecht <ingmars@web.de>
	@author René Fritz <r.fritz@colorcube.de>

function xml2tree($string,$depth=999)

Parses XML input into a PHP array with associative keys
Usage: 0

$string	string	XML data input
$depth=999	integer	Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
Returns:	mixed	The array with the parsed structure unless the XML parser returns with an error in which case the error message string is returned.
	@author bisqwit at iki dot fi dot not dot for dot ads dot invalid / http://dk.php.net/xml_parse_into_struct + kasperYYYY@typo3.com

function 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

$array	array	The input PHP array with any kind of data; text, binary, integers. Not objects though.
$NSprefix=''	string	tag-prefix, eg. a namespace prefix like "T3:"
$level=0	integer	Current recursion level. Don't change, stay at zero!
$docTag='phparray'	string	Alternative document tag. Default is "phparray".
$spaceInd=0	integer	If set, the number of spaces corresponding to this number is used for indenting, otherwise a single chr(9) (TAB) is used
$options=array()	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')
$stackData=array()	string	Stack data. Don't touch.
Returns:	string	An XML string made from the input content in the array.
	@see xml2array()

function xml2array($string,$NSprefix='',$reportDocTag=FALSE)

Converts an XML string to a PHP array.
This is the reverse function of array2xml()
Usage: 17

$string	string	XML content to convert into an array
$NSprefix=''	string	The tag-prefix resolve, eg. a namespace like "T3:"
$reportDocTag=FALSE	boolean	If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
Returns:	mixed	If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
	@see array2xml()

function xmlRecompileFromStructValArray($vals)

This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
Usage: 2

$vals	array	A array of XML parts, see xml2tree
Returns:	string	Re-compiled XML data.

function xmlGetHeaderAttribs($xmlData)

Extract the encoding scheme as found in the first line of an XML document (typically)
Usage: 1

$xmlData	string	XML data
Returns:	string	Encoding scheme (lowercase), if found.

function getURL($url, $includeHeader=0)

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

$url	string	Filepath/URL to read
$includeHeader=0	integer	Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only (will be ignored when using CURL)
Returns:	string	The content from the resource given as input.

function writeFile($file,$content)

Writes $content to the file $file
Usage: 30

$file	string	Filepath to write to
$content	string	Content to write
Returns:	boolean	True if the file was successfully opened and written to.

function fixPermissions($file)

Setting file system mode & group ownership of file

$file	string	Filepath of newly created file
Returns:	void

function writeFileToTypo3tempDir($filepath,$content)

Writes $content to a filename in the typo3temp/ folder (and possibly one or two subfolders...)
Accepts an additional subdirectory in the file path!

$filepath	string	Absolute filepath to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/"
$content	string	Content string to write
Returns:	string	Returns false on success, otherwise an error string telling about the problem.

function mkdir($theNewFolder)

Wrapper function for mkdir, setting folder permissions according to $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'] and group ownership according to $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']
Usage: 6

$theNewFolder	string	Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
Returns:	boolean	TRUE if @mkdir went well!

function mkdir_deep($destination,$deepDir)

Creates a directory - including parent directories if necessary - in the file system

$destination	string	Base folder. This must exist! Must have trailing slash! Example "/root/typo3site/"
$deepDir	string	Deep directory to create, eg. "xx/yy/" which creates "/root/typo3site/xx/yy/" if $destination is "/root/typo3site/"
Returns:	string	If error, returns error string.

function 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

$path	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.

function getFilesInDir($path,$extensionList='',$prependPath=0,$order='')

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

$path	string	$path: Is the path to the file
$extensionList=''	string	$extensionList is the comma list of extensions to read only (blank = all)
$prependPath=0	boolean	If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
$order=''	string	$order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
Returns:	array	Array of the files found

function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99)

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

$fileArr	array	$fileArr: Empty input array (will have files added to it)
$path	string	$path: The path to read recursively from (absolute) (include trailing slash!)
$extList=''	string	$extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
$regDirs=0	boolean	$regDirs: If set, directories are also included in output.
$recursivityLevels=99	integer	$recursivityLevels: The number of levels to dig down...
Returns:	array	An array with the found files/directories.

function removePrefixPathFromList($fileArr,$prefixToRemove)

Removes the absolute part of all files/folders in fileArr
Usage: 2

$fileArr	array	$fileArr: The file array to remove the prefix from
$prefixToRemove	string	$prefixToRemove: The prefix path to remove (if found as first part of string!)
Returns:	array	The input $fileArr processed.

function fixWindowsFilePath($theFile)

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

$theFile	string	File path to process
Returns:	string

function resolveBackPath($pathStr)

Resolves "../" sections in the input path string.
For example "fileadmin/directory/../other_directory/" will be resolved to "fileadmin/other_directory/"
Usage: 2

$pathStr	string	File path in which "/../" is resolved
Returns:	string

function 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

$path	string	URL / path to prepend full URL addressing to.
Returns:	string

function debug_ordvalue($string,$characters=100)

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

$string	string	String to show ASCII value for
$characters=100	integer	Number of characters to show
Returns:	string	The string with ASCII values in separated by a space char.
	@internal

function view_array($array_in)

Returns HTML-code, which is a visual representation of a multidimensional array
use t3lib_div::print_array() in order to print an array
Returns false if $array_in is not an array
Usage: 31

$array_in	array	Array to view
Returns:	string	HTML output

function print_array($array_in)

Prints an array
Usage: 6

$array_in	array	Array to print visually (in a table).
Returns:	void
	@internal
	@see view_array()

function 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

$var=""	mixed	Variable to print
$brOrHeader=0	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

function debug_trail()

Displays the "path" of the function call stack in a string, using debug_backtrace

Returns:

string

function debugRows($rows,$header='')

Displays an array as rows in a table. Useful to debug output like an array of database records.

$rows	array	Array of arrays with similar keys
$header=''	string	Table header
Returns:	void	Outputs to browser.

function getThisUrl()

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

Returns:

string

function 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

$getParams=array()	array	Array of GET parameters to include
Returns:	string

function 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

$url	string	URL string
$getParams=array()	array	Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.
Returns:	string	Output URL with added getParams.

function 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 $_SERVER/ENV_VARS to get reliable values for all situations.
Usage: 221

$getEnvName	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.

function milliseconds()

milliseconds
microtime recalculated to t3lib_div::milliseconds(1/1000 sec)
Usage: 20

Returns:

integer

function clientInfo($useragent='')

Client Browser Information
Usage: 4

$useragent=''	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

function 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

$filename	string	The input filename/filepath to evaluate
$onlyRelative=1	boolean	If $onlyRelative is set (which it is by default), then only return values relative to the current PATH_site is accepted.
$relToTYPO3_mainDir=0	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.

function validPathStr($theFile)

Checks for malicious file paths.
Returns true if no '//', '..' or '\' is in the $theFile
This should make sure that the path is not pointing 'backwards' and further doesn't contain double/back slashes.
So it's compatible with the UNIX style path strings valid for TYPO3 internally.
Usage: 14

$theFile	string	Filepath to evaluate
Returns:	boolean	True, if no '//', '..' or '\' is in the $theFile
	@todo Possible improvement: Should it rawurldecode the string first to check if any of these characters is encoded ?

function 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

$path	string	Filepath to evaluate
Returns:	boolean

function isAllowedAbsPath($path)

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

$path	string	Filepath to evaluate
Returns:	boolean

function verifyFilenameAgainstDenyPattern($filename)

Verifies the input filename againts the 'fileDenyPattern'. Returns true if OK.
Usage: 2

$filename	string	Filepath to evaluate
Returns:	boolean

function upload_copy_move($source,$destination)

Moves $source file to $destination if uploaded, otherwise try to make a copy
Usage: 4

$source	string	Source file, absolute path
$destination	string	Destination file, absolute path
Returns:	boolean	Returns true if the file was moved.
	@coauthor Dennis Petersen <fessor@software.dk>
	@see upload_to_tempfile()

function upload_to_tempfile($uploadedFileName)

Will move an uploaded file (normally in "/tmp/xxxxx") to a temporary filename in PATH_site."typo3temp/" from where TYPO3 can use it under safe_mode.
Use this function to move uploaded files to where you can work on them.
REMEMBER to use t3lib_div::unlink_tempfile() afterwards - otherwise temp-files will build up! They are NOT automatically deleted in PATH_site."typo3temp/"!
Usage: 6

$uploadedFileName	string	The temporary uploaded filename, eg. $_FILES['[upload field name here]']['tmp_name']
Returns:	string	If a new file was successfully created, return its filename, otherwise blank string.
	@see unlink_tempfile(), upload_copy_move()

function unlink_tempfile($uploadedTempFileName)

Deletes (unlink) a temporary filename in 'PATH_site."typo3temp/"' given as input.
The function will check that the file exists, is in PATH_site."typo3temp/" and does not contain back-spaces ("../") so it should be pretty safe.
Use this after upload_to_tempfile() or tempnam() from this class!
Usage: 9

$uploadedTempFileName	string	Filepath for a file in PATH_site."typo3temp/". Must be absolute.
Returns:	boolean	Returns true if the file was unlink()'ed
	@see upload_to_tempfile(), tempnam()

function tempnam($filePrefix)

Create temporary filename (Create file with unique file name)
This function should be used for getting temporary filenames - will make your applications safe for open_basedir = on
REMEMBER to delete the temporary files after use! This is done by t3lib_div::unlink_tempfile()
Usage: 7

$filePrefix	string	Prefix to temp file (which will have no extension btw)
Returns:	string	result from PHP function tempnam() with PATH_site.'typo3temp/' set for temp path.
	@see unlink_tempfile(), upload_to_tempfile()

function stdAuthCode($uid_or_record,$fields='',$codeLength=8)

Standard authentication code (used in Direct Mail, checkJumpUrl and setfixed links computations)
Usage: 2

$uid_or_record	mixed	Uid (integer) or record (array)
$fields=''	string	List of fields from the record if that is given.
$codeLength=8	integer	Length of returned authentication code.
Returns:	string	MD5 hash of 8 chars.
	@internal

function cHashParams($addQueryParams)

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

$addQueryParams	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 tslib_fe::makeCacheHash(), tslib_cObj::typoLink()

function 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.

$l18n_cfg_fieldValue	integer	Value from "l18n_cfg" field of a page record
Returns:	boolean	True if the page should be hidden

function readLLfile($fileRef,$langKey)

Includes a locallang file and returns the $LOCAL_LANG array found inside.

$fileRef	string	Input is a file-reference (see t3lib_div::getFileAbsFileName) which, if exists, is included. That file is expected to be a 'local_lang' file containing a $LOCAL_LANG array.
$langKey	string	Language key
Returns:	array	Value of $LOCAL_LANG found in the included file. If that array is found it's returned. Otherwise an empty array

function readLLXMLfile($fileRef,$langKey)

Includes a locallang-xml file and returns the $LOCAL_LANG array
Works only when the frontend or backend has been initialized with a charset conversion object. See first code lines.

$fileRef	string	Absolute reference to locallang-XML file
$langKey	string	TYPO3 language key, eg. "dk" or "de" or "default"
Returns:	array	LOCAL_LANG array in return.

function llXmlAutoFileName($fileRef,$language)

Returns auto-filename for locallang-XML localizations.

$fileRef	string	Absolute file reference to locallang-XML file. Must be inside system/global/local extension
$language	string	Language key
Returns:	string	Returns the filename reference for the language unless error occured (or local mode is used) in which case it will be NULL

function 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

$table	string	Table name for which to load the full TCA array part into the global $TCA
Returns:	void

function resolveSheetDefInDS($dataStructArray,$sheet='sDEF')

Looks for a sheet-definition in the input data structure array. If found it will return the data structure for the sheet given as $sheet (if found).
If the sheet definition is in an external file that file is parsed and the data structure inside of that is returned.
Usage: 5

$dataStructArray	array	Input data structure, possibly with a sheet-definition and references to external data source files.
$sheet='sDEF'	string	The sheet to return, preferably.
Returns:	array	An array with two num. keys: key0: The data structure is returned in this key (array) UNLESS an error happend in which case an error string is returned (string). key1: The used sheet key value!

function resolveAllSheetsInDS($dataStructArray)

Resolves ALL sheet definitions in dataStructArray
If no sheet is found, then the default "sDEF" will be created with the dataStructure inside.

$dataStructArray	array	Input data structure, possibly with a sheet-definition and references to external data source files.
Returns:	array	Output data structure with all sheets resolved as arrays.

function 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

$funcName	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").
&$params	mixed	Parameters to be pass along (typically an array) (REFERENCE!)
&$ref	mixed	Reference to be passed along (typically "$this" - being a reference to the calling object) (REFERENCE!)
$checkPrefix='user_'	string	Required prefix of class or function name
$silent=0	boolean	If set, no debug() error message is shown if class/function is not present.
Returns:	mixed	Content from method/function call
	@see getUserObj()

function &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

$classRef	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!).
$checkPrefix='user_'	string	Required prefix of class name. By default "tx_" is allowed.
$silent=0	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 callUserFunction()

function &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

$className	string	Class name to instantiate
Returns:	object	The object

function makeInstanceClassName($className)

Return classname for new instance
Takes the class-extensions API of TYPO3 into account
Usage: 17

$className	string	Base Class name to evaluate
Returns:	string	Final class name to instantiate with "new [classname]"

function &makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys=array())

Find the best service and check if it works.
Returns object of the service class.

$serviceType	string	Type of service (service key).
$serviceSubType=''	string	Sub type like file extensions or similar. Defined by the service.
$excludeServiceKeys=array()	mixed	List of service keys which should be exluded in the search for a service. Array or comma list.
Returns:	object	The service object or an array with error info's.
	@author René Fritz <r.fritz@colorcube.de>

function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='',$dontEncodeHeader=false)

Simple substitute for the PHP function mail() which allows you to specify encoding and character set
The fifth parameter, $enc, will allow you to specify 'base64' encryption for the output (set $enc=base64)
Further the output has the charset set to ISO-8859-1 by default.
Usage: 4

$email	string	Email address to send to. (see PHP function mail())
$subject	string	Subject line, non-encoded. (see PHP function mail())
$message	string	Message content, non-encoded. (see PHP function mail())
$headers=''	string	Headers, separated by chr(10)
$enc=''	string	Encoding type: "base64", "quoted-printable", "8bit". Default value is "quoted-printable".
$charset=''	string	Charset used in encoding-headers (only if $enc is set to a valid value which produces such a header)
$dontEncodeHeader=false	boolean	If set, the header content will not be encoded.
Returns:	void

function quoted_printable($string,$maxlen=76)

Implementation of quoted-printable encode.
This functions is buggy. It seems that in the part where the lines are breaked every 76th character, that it fails if the break happens right in a quoted_printable encode character!
See RFC 1521, section 5.1 Quoted-Printable Content-Transfer-Encoding
Usage: 2

$string	string	Content to encode
$maxlen=76	integer	Length of the lines, default is 76
Returns:	string	The QP encoded string

function encodeHeader($line,$enc='',$charset='ISO-8859-1')

Encode header lines
Email headers must be ASCII, therefore they will be encoded to quoted_printable (default) or base64.

$line	string	Content to encode
$enc=''	string	Encoding type: "base64" or "quoted-printable". Default value is "quoted-printable".
$charset='ISO-8859-1'	string	Charset used for encoding
Returns:	string	The encoded string

function substUrlsInPlainText($message,$urlmode='76',$index_script_url='')

Takes a clear-text message body for a plain text email, finds all 'http://' links and if they are longer than 76 chars they are converted to a shorter URL with a hash parameter. The real parameter is stored in the database and the hash-parameter/URL will be redirected to the real parameter when the link is clicked.
This function is about preserving long links in messages.
Usage: 3

$message	string	Message content
$urlmode='76'	string	URL mode; "76" or "all"
$index_script_url=''	string	URL of index script (see makeRedirectUrl())
Returns:	string	Processed message content
	@see makeRedirectUrl()

function makeRedirectUrl($inUrl,$l=0,$index_script_url='')

Subfunction for substUrlsInPlainText() above.
Usage: 2

$inUrl	string	Input URL
$l=0	integer	URL string length limit
$index_script_url=''	string	URL of "index script" - the prefix of the "?RDCT=..." parameter. If not supplyed it will default to t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR')
Returns:	string	Processed URL
	@internal

function freetypeDpiComp($font_size)

Function to compensate for FreeType2 96 dpi
Usage: 21

$font_size	integer	Fontsize for freetype function call
Returns:	integer	Compensated fontsize based on $GLOBALS['TYPO3_CONF_VARS']['GFX']['TTFdpi']

function initSysLog()

Init system error log.

Returns:	void
	@see sysLog()

function sysLog($msg, $extKey, $severity=0)

System error log; This should be implemented around the source code, including the Core and both frontend and backend, logging serious errors.
If you want to implement the sysLog in your applications, simply add lines like:
t3lib_div::sysLog('[write message in English here]', 'extension key');

$msg	string	Message (in English).
$extKey	string	Extension key (from which extension you are calling the log) or "Core"
$severity=0	integer	Severity: 0 is info, 1 is notice, 2 is warning, 3 is error, 4 is fatal error
Returns:	void

function 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');

$msg	string	Message (in english).
$extKey	string	Extension key (from which extension you are calling the log)
$severity=0	integer	Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
$dataVar=FALSE	array	Additional data you want to pass to the logger.
Returns:	void

function 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;"

$arr	array	Data array which should be outputted
$valueList=array()	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.
$valueLength=20	integer	Long string values are shortened to this length. Default: 20
Returns:	string	Output string with key names and their value as string

function imageMagickCommand($command, $parameters, $path='')

Compile the command for running ImageMagick/GraphicsMagick.

$command	string	Command to be run: identify, convert or combine/composite
$parameters	string	The parameters string
$path=''	string	Override the default path
Returns:	string	Compiled command that deals with IM6 & GraphicsMagick

function unQuoteFilenames($parameters,$unQuote=FALSE)

Explode a string (normally a list of filenames) with whitespaces by considering quotes in that string. This is mostly needed by the imageMagickCommand function above.

$parameters	string	The whole parameters string
$unQuote=FALSE	boolean	If set, the elements of the resulting array are unquoted.
Returns:	array	Exploded parameters

function quoteJSvalue($value, $inScriptTags = false)

Quotes a string for usage as JS parameter. Depends wheter the value is used in script tags (it doesn't need/must not get htmlspecialchared in this case)

$value	string	The string to encode.
$inScriptTags = false	boolean	If the values get's used in <script> tags.
Returns:	string	The encoded value already quoted