"TYPO3 4.0.1: t3lib_arrayBrowser Class Reference", "datetime" => "Sat Dec 2 19:25:43 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

t3lib_arrayBrowser Class Reference

List of all members.

Public Member Functions

 tree ($arr, $depth_in, $depthData)
 wrapValue ($theValue, $depth)
 wrapArrayKey ($label, $depth, $theValue)
 getSearchKeys ($keyArr, $depth_in, $searchString, $keyArray)
 fixed_lgd ($string, $chars)
 depthKeys ($arr, $settings)

Public Attributes

 $expAll = FALSE
 $dontLinkVar = FALSE
 $depthKeys = array()
 $searchKeys = array()
 $fixedLgd = 1
 $regexMode = 0
 $varName = ''

Detailed Description

Definition at line 77 of file class.t3lib_arraybrowser.php.

Member Function Documentation

t3lib_arrayBrowser::depthKeys (  $  arr,
$  settings
) 
 

Function modifying the depthKey array

Parameters:
array Array with instructions to open/close nodes.
array Input depth_key array
Returns:
array Output depth_key array with entries added/removed based on $arr
See also:
SC_mod_tools_config_index::main()

Definition at line 245 of file class.t3lib_arraybrowser.php.

Referenced by tree().

t3lib_arrayBrowser::fixed_lgd (  $  string,
$  chars
) 
 

Fixed length function

Parameters:
string String to process
integer Max number of chars
Returns:
string Processed string

Definition at line 228 of file class.t3lib_arraybrowser.php.

Referenced by tree().

t3lib_arrayBrowser::getSearchKeys (  $  keyArr,
$  depth_in,
$  searchString,
$  keyArray
) 
 

Creates an array with "depthKeys" which will expand the array to show the search results

Parameters:
array The array to search for the value
string Depth string - blank for first call (will build up during recursive calling creating an id of the position: [key1].[key2].[key3]
string The string to search for
array Key array, for first call pass empty array
Returns:
array

Definition at line 196 of file class.t3lib_arraybrowser.php.

t3lib_arrayBrowser::tree (  $  arr,
$  depth_in,
$  depthData
) 
 

Make browsable tree Before calling this function you may want to set some of the internal vars like depthKeys, regexMode and fixedLgd. For examples see SC_mod_tools_config_index::main()

Parameters:
array The array to display
string Key-position id. Build up during recursive calls - [key1].[key2].[key3] - an so on.
string Depth-data - basically a prefix for the icons. For calling this function from outside, let it stay blank.
Returns:
string HTML for the tree
See also:
SC_mod_tools_config_index::main()

Definition at line 96 of file class.t3lib_arraybrowser.php.

References depthKeys(), fixed_lgd(), t3lib_iconWorks::skinImg(), and wrapArrayKey().

t3lib_arrayBrowser::wrapArrayKey (  $  label,
$  depth,
$  theValue
) 
 

Wrapping the value in bold tags etc.

Parameters:
string The title string
string Depth path
string The value for the array entry.
Returns:
string Title string, htmlspecialchars()'ed

Definition at line 172 of file class.t3lib_arraybrowser.php.

References t3lib_div::testInt().

Referenced by tree().

t3lib_arrayBrowser::wrapValue (  $  theValue,
$  depth
) 
 

Wrapping the value in bold tags etc.

Parameters:
string The title string
string Depth path
Returns:
string Title string, htmlspecialchars()'ed

Definition at line 160 of file class.t3lib_arraybrowser.php.

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