Typo3 4.1.3 : Vue détaillée de class.t3lib

Classe: t3lib_div - X-Ref

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

_GP($var) X-Ref

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

param: string GET/POST var to return
return: mixed POST var named $var and if not set, the GET var of the same name.

_GET($var=NULL) X-Ref

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

param: string Optional pointer to value in GET array (basically name of GET var)
return: 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!*

_POST($var=NULL) X-Ref

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

param: string Optional pointer to value in POST array (basically name of POST var)
return: 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!*

_GETset($inputGet,$key='') X-Ref

Writes input value to $_GET
Usage: 2

param: array Array to write to $_GET. Values should NOT be escaped at input time (but will be escaped before writing according to TYPO3 standards).
param: string Alternative key; If set, this will not set the WHOLE GET array, but only the key in it specified by this value!
return: void

GPvar($var,$strip=0) X-Ref

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

param: string        GET/POST var to return
param: boolean        If set, values are stripped of return values that are *arrays!* - string/integer values returned are always strip-slashed()
return: mixed        POST var named $var and if not set, the GET var of the same name.

GParrayMerged($var) X-Ref

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

param: string Key (variable name) from GET or POST vars
return: array Returns the GET vars merged recursively onto the POST vars.

gif_compress($theFile, $type) X-Ref

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

param: string        Filepath
param: string        See description of function
return: string        Returns "GD" if GD was used, otherwise "IM" if ImageMagick was used. If nothing done at all, it returns empty string.

png_to_gif_by_imagemagick($theFile) X-Ref

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

param: string $theFile the filename with path
return: string new filename

read_png_gif($theFile,$output_png=0) X-Ref

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

param: string        Filepath of image file
param: boolean        If set, then input file is converted to PNG, otherwise to GIF
return: string        If the new image file exists, it's filepath is returned

fixed_lgd($string,$origChars,$preStr='...') X-Ref

Truncate string
Returns a new string of max. $chars length.
If the string is longer, it will be truncated and appended with '...'.
Usage: 39

param: string        string to truncate
param: integer        must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
param: string        String to append to the output if it is truncated, default is '...'
return: string        new string

fixed_lgd_pre($string,$chars) X-Ref

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
Usage: 6

param: string        string to truncate
param: integer        must be an integer of at least 4
return: string        new string

fixed_lgd_cs($string,$chars) X-Ref

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

param: string        string to truncate
param: integer        must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
return: string        New string

breakTextForEmail($str,$implChar="\n",$charWidth=76) X-Ref

Breaks up the text for emails
Usage: 1

param: string        The string to break up
param: string        The string to implode the broken lines with (default/typically \n)
param: integer        The line length
return: string

breakLinesForEmail($str,$implChar="\n",$charWidth=76) X-Ref

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

param: string        The string to break up
param: string        The string to implode the broken lines with (default/typically \n)
param: integer        The line length
return: string

cmpIP($baseIP, $list) X-Ref

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

param: string        $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
param: 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.
return: boolean        True if an IP-mask from $list matches $baseIP

cmpIPv4($baseIP, $list) X-Ref

Match IPv4 number with list of numbers with wildcard

param: string        $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
param: 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)
return: boolean        True if an IP-mask from $list matches $baseIP

cmpIPv6($baseIP, $list) X-Ref

Match IPv6 address with a list of IPv6 prefixes

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

IPv6Hex2Bin($hex) X-Ref

[Describe function...]

param: [type] $hex: ...
return: [type] ...

normalizeIPv6($address) X-Ref

Normalize an IPv6 address to full length

param: string Given IPv6 address
return: string Normalized address

validIPv6($ip) X-Ref

Validate a given IP address to the IPv6 address format.

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

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

cmpFQDN($baseIP, $list) X-Ref

Match fully qualified domain name with list of strings with wildcard

param: string        The current remote IP address for instance, typ. REMOTE_ADDR
param: 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)
return: boolean        True if a domain name mask from $list matches $baseIP

inList($list,$item) X-Ref

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

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

rmFromList($element,$list) X-Ref

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

param: string        element to remove
param: string        comma-separated list of items (string)
return: string        new comma-separated list of items

expandList($list) X-Ref

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.

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

intInRange($theInt,$min,$max=2000000000,$zeroValue=0) X-Ref

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

param: integer        Input value
param: integer        Lower limit
param: integer        Higher limit
param: integer        Default value if input is false.
return: integer        The input value forced into the boundaries of $min and $max

intval_positive($theInt) X-Ref

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

param: integer Integer string to process
return: integer

int_from_ver($verNumberStr) X-Ref

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

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

compat_version($verNumberStr) X-Ref

Returns true if the current TYPO3 version (or compatibility version) is compatible to the input version
Notice that this function compares branches, not versions (4.0.1 would be > 4.0.0 although they use the same compat_version)

param: string Minimum branch number required (format x.y / e.g. "4.0" NOT "4.0.0"!)
return: boolean Returns true if this setup is compatible with the provided version number

md5int($str) X-Ref

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

param: string String to md5-hash
return: integer Returns 28bit integer-hash

shortMD5($input, $len=10) X-Ref

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

Usage: 37

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

uniqueList($in_list, $secondParameter=NULL) X-Ref

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

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

split_fileref($fileref) X-Ref

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

param: string Filename/filepath to be analysed
return: array Contains keys [path], [file], [filebody], [fileext], [realFileext]

dirname($path) X-Ref

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

param: string Directory name / path
return: string Processed input value. See function description.

modifyHTMLColor($color,$R,$G,$B) X-Ref

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

param: string        A hexadecimal color code, #xxxxxx
param: integer        Offset value 0-255
param: integer        Offset value 0-255
param: integer        Offset value 0-255
return: string        A hexadecimal color code, #xxxxxx, modified according to input vars

modifyHTMLColorAll($color,$all) X-Ref

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

param: string        A hexadecimal color code, #xxxxxx
param: integer        Offset value 0-255 for all three channels.
return: string        A hexadecimal color code, #xxxxxx, modified according to input vars

rm_endcomma($string) X-Ref

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

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

danish_strtoupper($string) X-Ref

strtoupper which converts danish (and other characters) characters as well
Usage: 0

param: string String to process
return: string

convUmlauts($str) X-Ref

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.

ä => ae, Ö => Oe

param: string String to convert.
return: string

testInt($var) X-Ref

Tests if the input is an integer.
Usage: 77

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

isFirstPartOfStr($str,$partStr) X-Ref

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

param: string        Full string to check
param: string        Reference string which must be found as the "first part" of the full string
return: boolean        True if $partStr was found to be equal to the first part of $str

formatSize($sizeInBytes,$labels='') X-Ref

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

param: integer        Number of bytes to format.
param: 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)
return: string        Formatted representation of the byte number, for output.

convertMicrotime($microtime) X-Ref

Returns microtime input to milliseconds
Usage: 2

param: string Microtime
return: integer Microtime input string converted to an integer (milliseconds)

splitCalc($string,$operators) X-Ref

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

param: string        Input string, eg "123 + 456 / 789 - 4"
param: string        Operators to split by, typically "/+-*"
return: array        Array with operators and operands separated.

calcPriority($string) X-Ref

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

param: string Input string, eg "123 + 456 / 789 - 4"
return: integer Calculated value. Or error string.

calcParenthesis($string) X-Ref

Calculates the input with parenthesis levels
Usage: 2

param: string Input string, eg "(123 + 456) / 789 - 4"
return: integer Calculated value. Or error string.

htmlspecialchars_decode($value) X-Ref

Inverse version of htmlspecialchars()
Usage: 4

param: string Value where >, <, " and & should be converted to regular chars.
return: string Converted result.

deHSCentities($str) X-Ref

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

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

slashJS($string,$extended=0,$char="'") X-Ref

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

param: string        String to escape
param: boolean        If set, also backslashes are escaped.
param: string        The character to escape, default is ' (single-quote)
return: string        Processed input string

rawUrlEncodeJS($str) X-Ref

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

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

rawUrlEncodeFP($str) X-Ref

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

param: string Input string
return: string Output string

validEmail($email) X-Ref

Checking syntax of input email address
Usage: 5

param: string Input string to evaluate
return: 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.

formatForTextarea($content) X-Ref

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

param: string Input string to be formatted.
return: string Formatted for <textarea>-tags

inArray($in_array,$item) X-Ref

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

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

intExplode($delim, $string) X-Ref

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

param: string        Delimiter string to explode with
param: string        The string to explode
return: array        Exploded values, all converted to integers

revExplode($delim, $string, $count=0) X-Ref

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

param: string        Delimiter string to explode with
param: string        The string to explode
param: integer        Number of array entries
return: array        Exploded values

trimExplode($delim, $string, $onlyNonEmptyValues=0) X-Ref

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

param: string        Delimiter string to explode with
param: string        The string to explode
param: boolean        If set, all empty values (='') will NOT be set in output
return: array        Exploded values

uniqueArray($valueArray) X-Ref

Remove duplicate values from an array
Usage: 0

param: array Array of values to make unique
return: array

removeArrayEntryByValue($array,$cmpValue) X-Ref

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

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

implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0) X-Ref

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

param: string        Name prefix for entries. Set to blank if you wish none.
param: array        The (multidim) array to implode
param: string        (keep blank)
param: boolean        If set, parameters which were blank strings would be removed.
param: boolean        If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.
return: string        Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3

explodeUrl2Array($string,$multidim=FALSE) X-Ref

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

param: string        GETvars string
param: 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())
return: 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!

compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1) X-Ref

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

param: string        List of variable/key names
param: array        Array from where to get values based on the keys in $varList
param: boolean        If set, then t3lib_div::_GP() is used to fetch the value if not found (isset) in the $getArray
return: array        Output array with selected variables.

addSlashesOnArray(&$theArray) X-Ref

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

param: array Multidimensional input array, (REFERENCE!)
return: array

stripSlashesOnArray(&$theArray) X-Ref

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

param: array Multidimensional input array, (REFERENCE!)
return: array

slashArray($arr,$cmd) X-Ref

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

param: array Multidimensional input array
param: string "add" or "strip", depending on usage you wish.
return: array

array_merge_recursive_overrule($arr0,$arr1,$notAddKeys=0,$includeEmtpyValues=true) X-Ref

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

param: array        First array
param: array        Second array, overruling the first array
param: 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.
param: boolean        If set, values from $arr1 will overrule if they are empty or zero. Default: true
return: array        Resulting array where $arr1 values has overruled $arr0 values

array_merge($arr1,$arr2) X-Ref

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

param: array        First array
param: array        Second array
return: array        Merged result.

csvValues($row,$delim=',',$quote='"') X-Ref

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

param: array        Input array of values
param: string        Delimited, default is comman
param: string        Quote-character to wrap around the values.
return: string        A single line of CSV

removeDotsFromTS($ts) X-Ref

Removes dots "." from end of a key identifier of TypoScript styled array.
array('key.' => array('property.' => 'value')) --> array('key' => array('property' => 'value'))

param: array $ts: TypoScript configuration array
return: array TypoScript configuration array without dots at the end of all keys

get_tag_attributes($tag) X-Ref

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

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

split_tag_attributes($tag) X-Ref

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

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

implodeAttributes($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) X-Ref

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

param: array        Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
param: 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!
param: boolean        If true, don't check if values are blank. Default is to omit attributes with blank values.
return: string        Imploded attributes, eg. 'bgcolor="red" border="0"'

implodeParams($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) X-Ref

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

param: array        See implodeAttributes()
param: boolean        See implodeAttributes()
param: boolean        See implodeAttributes()
return: string        See implodeAttributes()

wrapJS($string, $linebreak=TRUE) X-Ref

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.

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

xml2tree($string,$depth=999) X-Ref

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

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
param: string        XML data input
param: integer        Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
return: mixed        The array with the parsed structure unless the XML parser returns with an error in which case the error message string is returned.

array2xml_cs($array,$docTag='phparray',$options=array() X-Ref

Turns PHP array into XML. See array2xml()

param: array        The input PHP array with any kind of data; text, binary, integers. Not objects though.
param: string        Alternative document tag. Default is "phparray".
param: array        Options for the compilation. See array2xml() for description.
param: string        Forced charset to prologue
return: string        An XML string made from the input content in the array.

array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0, $options=array() X-Ref

Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)

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 with 4.x versions. However, with PHP5 there seems to be the need to add an XML prologue a la <?xml version="1.0" encoding="[charset]" standalone="yes" ?> - otherwise UTF-8 is assumed! Unfortunately, many times the output from this function is used without adding that prologue meaning that non-ASCII characters will break the parsing!! This suchs of course! Effectively it means that the prologue should always be prepended setting the right characterset, alternatively the system should always run as utf-8!
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

param: array        The input PHP array with any kind of data; text, binary, integers. Not objects though.
param: string        tag-prefix, eg. a namespace prefix like "T3:"
param: integer        Current recursion level. Don't change, stay at zero!
param: string        Alternative document tag. Default is "phparray".
param: integer        If greater than zero, then the number of spaces corresponding to this number is used for indenting, if less than zero - no indentation, if zero - a single chr(9) (TAB) is used
param: 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')
param: string        Stack data. Don't touch.
return: string        An XML string made from the input content in the array.

xml2array($string,$NSprefix='',$reportDocTag=FALSE) X-Ref

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

param: string        XML content to convert into an array
param: string        The tag-prefix resolve, eg. a namespace like "T3:"
param: boolean        If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
return: mixed        If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.

xmlRecompileFromStructValArray($vals) X-Ref

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

param: array A array of XML parts, see xml2tree
return: string Re-compiled XML data.

xmlGetHeaderAttribs($xmlData) X-Ref

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

param: string XML data
return: string Encoding scheme (lowercase), if found.

getURL($url, $includeHeader = 0, $requestHeaders = false) X-Ref

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

param: string        Filepath/URL to read
param: integer        Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
param: array        HTTP headers to be used in the request
return: string        The content from the resource given as input.

writeFile($file,$content) X-Ref

Writes $content to the file $file
Usage: 30

param: string        Filepath to write to
param: string        Content to write
return: boolean        True if the file was successfully opened and written to.

fixPermissions($file) X-Ref

Setting file system mode & group ownership of file

param: string Filepath of newly created file
return: void

writeFileToTypo3tempDir($filepath,$content) X-Ref

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

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

mkdir($theNewFolder) X-Ref

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

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

mkdir_deep($destination,$deepDir) X-Ref

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

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

get_dirs($path) X-Ref

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

param: string Path to list directories from
return: array Returns an array with the directory entries as values. If no path, the return value is nothing.

getFilesInDir($path,$extensionList='',$prependPath=0,$order='',$excludePattern='') X-Ref

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

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

getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99,$excludePattern='') X-Ref

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

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

removePrefixPathFromList($fileArr,$prefixToRemove) X-Ref

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

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

fixWindowsFilePath($theFile) X-Ref

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

param: string File path to process
return: string

resolveBackPath($pathStr) X-Ref

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

param: string File path in which "/../" is resolved
return: string

locationHeaderUrl($path) X-Ref

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

param: string URL / path to prepend full URL addressing to.
return: string

debug_ordvalue($string,$characters=100) X-Ref

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

param: string        String to show ASCII value for
param: integer        Number of characters to show
return: string        The string with ASCII values in separated by a space char.

view_array($array_in) X-Ref

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

param: array Array to view
return: string HTML output

print_array($array_in) X-Ref

Prints an array
Usage: 6

param: array Array to print visually (in a table).
return: void

debug($var="",$brOrHeader=0) X-Ref

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

param: mixed Variable to print
param: 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.
return: void

debug_trail() X-Ref

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

return: string

debugRows($rows,$header='') X-Ref

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

param: array        Array of arrays with similar keys
param: string        Table header
return: void        Outputs to browser.

getThisUrl() X-Ref

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

return: string

linkThisScript($getParams=array() X-Ref

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

param: array Array of GET parameters to include
return: string

linkThisUrl($url,$getParams=array() X-Ref

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

param: string        URL string
param: array        Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.
return: string        Output URL with added getParams.

getIndpEnv($getEnvName) X-Ref

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

param: 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
return: string Value based on the input key, independent of server/os environment.

milliseconds() X-Ref

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

return: integer

clientInfo($useragent='') X-Ref

Client Browser Information
Usage: 4

param: string Alternative User Agent string (if empty, t3lib_div::getIndpEnv('HTTP_USER_AGENT') is used)
return: array Parsed information about the HTTP_USER_AGENT in categories BROWSER, VERSION, SYSTEM and FORMSTYLE

getHostname($requestHost=TRUE) X-Ref

Get the fully-qualified domain name of the host.
Usage: 2

param: boolean Use request host (when not in CLI mode).
return: string The fully-qualified host name.

getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0) X-Ref

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

param: string        The input filename/filepath to evaluate
param: boolean        If $onlyRelative is set (which it is by default), then only return values relative to the current PATH_site is accepted.
param: boolean        If $relToTYPO3_mainDir is set, then relative paths are relative to PATH_typo3 constant - otherwise (default) they are relative to PATH_site
return: string        Returns the absolute filename of $filename IF valid, otherwise blank string.

validPathStr($theFile) X-Ref

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

param: string Filepath to evaluate
return: boolean True, if no '//', '\', '/../' is in the $theFile and $theFile doesn't begin with '../'

isAbsPath($path) X-Ref

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

param: string Filepath to evaluate
return: boolean

isAllowedAbsPath($path) X-Ref

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

param: string Filepath to evaluate
return: boolean

verifyFilenameAgainstDenyPattern($filename) X-Ref

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

param: string Filepath to evaluate
return: boolean

upload_copy_move($source,$destination) X-Ref

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

param: string        Source file, absolute path
param: string        Destination file, absolute path
return: boolean        Returns true if the file was moved.

upload_to_tempfile($uploadedFileName) X-Ref

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

param: string The temporary uploaded filename, eg. $_FILES['[upload field name here]']['tmp_name']
return: string If a new file was successfully created, return its filename, otherwise blank string.

unlink_tempfile($uploadedTempFileName) X-Ref

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

param: string Filepath for a file in PATH_site."typo3temp/". Must be absolute.
return: boolean Returns true if the file was unlink()'ed

tempnam($filePrefix) X-Ref

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

param: string Prefix to temp file (which will have no extension btw)
return: string result from PHP function tempnam() with PATH_site.'typo3temp/' set for temp path.

stdAuthCode($uid_or_record,$fields='',$codeLength=8) X-Ref

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

param: mixed        Uid (integer) or record (array)
param: string        List of fields from the record if that is given.
param: integer        Length of returned authentication code.
return: string        MD5 hash of 8 chars.

cHashParams($addQueryParams) X-Ref

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

param: string Query-parameters: "&xxx=yyy&zzz=uuu"
return: 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

hideIfNotTranslated($l18n_cfg_fieldValue) X-Ref

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

param: integer Value from "l18n_cfg" field of a page record
return: boolean True if the page should be hidden

readLLfile($fileRef,$langKey) X-Ref

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

param: 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.
param: string        Language key
return: array        Value of $LOCAL_LANG found in the included file. If that array is found it's returned. Otherwise an empty array

readLLXMLfile($fileRef,$langKey) X-Ref

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.

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

llXmlAutoFileName($fileRef,$language) X-Ref

Returns auto-filename for locallang-XML localizations.

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

loadTCA($table) X-Ref

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)

Note: For the frontend this loads only 'ctrl' and 'feInterface' parts.
For complete TCA use $GLOBALS['TSFE']->includeTCA() instead.

Usage: 84

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

resolveSheetDefInDS($dataStructArray,$sheet='sDEF') X-Ref

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

param: array        Input data structure, possibly with a sheet-definition and references to external data source files.
param: string        The sheet to return, preferably.
return: 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!

resolveAllSheetsInDS($dataStructArray) X-Ref

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

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

callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0) X-Ref

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

param: 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").
param: mixed        Parameters to be pass along (typically an array) (REFERENCE!)
param: mixed        Reference to be passed along (typically "$this" - being a reference to the calling object) (REFERENCE!)
param: string        Required prefix of class or function name
param: boolean        If set, no debug() error message is shown if class/function is not present.
return: mixed        Content from method/function call

getUserObj($classRef,$checkPrefix='user_',$silent=0) X-Ref

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

param: 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!).
param: string        Required prefix of class name. By default "tx_" is allowed.
param: boolean        If set, no debug() error message is shown if class/function is not present.
return: object        The instance of the class asked for. Instance is created with t3lib_div::makeInstance

makeInstance($className) X-Ref

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

param: string Class name to instantiate
return: object A reference to the object

makeInstanceClassName($className) X-Ref

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

param: string Base Class name to evaluate
return: string Final class name to instantiate with "new [classname]"

makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys=array() X-Ref

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

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

requireOnce($requireFile) X-Ref

Require a class for TYPO3
Useful to require classes from inside other classes (not global scope). A limited set of global variables are available (see function)

plainMailEncoded($email,$subject,$message,$headers='',$encoding='quoted-printable',$charset='',$dontEncodeHeader=false) X-Ref

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

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

quoted_printable($string,$maxlen=76) X-Ref

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

param: string        Content to encode
param: integer        Length of the lines, default is 76
return: string        The QP encoded string

encodeHeader($line,$enc='quoted-printable',$charset='ISO-8859-1') X-Ref

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

param: string        Content to encode
param: string        Encoding type: "base64" or "quoted-printable". Default value is "quoted-printable".
param: string        Charset used for encoding
return: string        The encoded string

substUrlsInPlainText($message,$urlmode='76',$index_script_url='') X-Ref

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

param: string        Message content
param: string        URL mode; "76" or "all"
param: string        URL of index script (see makeRedirectUrl())
return: string        Processed message content

makeRedirectUrl($inUrl,$l=0,$index_script_url='') X-Ref

Subfunction for substUrlsInPlainText() above.
Usage: 2

param: string        Input URL
param: integer        URL string length limit
param: string        URL of "index script" - the prefix of the "?RDCT=..." parameter. If not supplyed it will default to t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR').'index.php'
return: string        Processed URL

freetypeDpiComp($font_size) X-Ref

Function to compensate for FreeType2 96 dpi
Usage: 21

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

initSysLog() X-Ref

Init system error log.

return: void

sysLog($msg, $extKey, $severity=0) X-Ref

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

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

devLog($msg, $extKey, $severity=0, $dataVar=FALSE) X-Ref

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

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

arrayToLogString($arr, $valueList=array() X-Ref

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

param: array        Data array which should be outputted
param: 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.
param: integer        Long string values are shortened to this length. Default: 20
return: string        Output string with key names and their value as string

imageMagickCommand($command, $parameters, $path='') X-Ref

Compile the command for running ImageMagick/GraphicsMagick.

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

unQuoteFilenames($parameters,$unQuote=FALSE) X-Ref

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.

param: string        The whole parameters string
param: boolean        If set, the elements of the resulting array are unquoted.
return: array        Exploded parameters

quoteJSvalue($value, $inScriptTags = false) X-Ref

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

param: string        The string to encode.
param: boolean        If the values get's used in <script> tags.
return: string        The encoded value already quoted

Author:	Kasper Skaarhoj <kasperYYYY@typo3.com>
Poids:	4634 lignes (173 kb)
Inclus ou requis:	1 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de Typo3 4.1.3

/t3lib/ -> class.t3lib_div.php (sommaire)

Définit 1 class

Généré le : Sun Nov 25 17:13:16 2007	par Balluche grâce à PHPXref 0.7