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

t3lib_exec Class Reference

List of all members.

Public Member Functions

 checkCommand ($cmd, $handler='')
 getCommand ($cmd, $handler='', $handlerOpt='')
 addPaths ($paths)
 getPaths ($addInvalid=false)
 _init ()
 _initPaths ($paths='')
 _getConfiguredApps ()
 _getPaths ()
 _fixPath ($path)

Detailed Description

Definition at line 85 of file class.t3lib_exec.php.

Member Function Documentation

t3lib_exec::_fixPath (  $  path  ) 
 

Set a path to the right format

Parameters:
string Input path
Returns:
string Output path

Definition at line 400 of file class.t3lib_exec.php.

Referenced by _getPaths().

t3lib_exec::_getConfiguredApps (   ) 
 

Processes and returns the paths from $TYPO3_CONF_VARS['SYS']['binSetup']

Returns:
array Array of commands and path

Definition at line 312 of file class.t3lib_exec.php.

References t3lib_div::trimExplode().

Referenced by _init().

t3lib_exec::_getPaths (   ) 
 

Set the search paths from different sources, internal

Returns:
array Array of absolute paths (keys and values are equal)

Definition at line 339 of file class.t3lib_exec.php.

References _fixPath(), and t3lib_div::trimExplode().

Referenced by _initPaths().

t3lib_exec::_init (   ) 
 

Initialization, internal

Returns:
void

Definition at line 237 of file class.t3lib_exec.php.

References _getConfiguredApps(), and _initPaths().

Referenced by checkCommand(), getCommand(), and getPaths().

t3lib_exec::_initPaths (  $  paths = ''  ) 
 

Init and extend the preset paths with own

Parameters:
string Comma seperated list of extra paths where a command should be searched. Relative paths (without leading "/") are prepend with site root path (PATH_site).
Returns:
void

Definition at line 259 of file class.t3lib_exec.php.

References _getPaths(), and t3lib_div::trimExplode().

Referenced by _init(), and addPaths().

t3lib_exec::addPaths (  $  paths  ) 
 

Extend the preset paths. This way an extension can install an executable and provide the path to t3lib_exec.

Parameters:
string comma seperated list of extra paths where a command should be searched. Relative paths (without leading "/") are prepend with site root path (PATH_site).
Returns:
void

Definition at line 199 of file class.t3lib_exec.php.

References _initPaths().

t3lib_exec::checkCommand (  $  cmd,
$  handler = ''
) 
 

Checks if a command is valid or not updates global vars

Parameters:
string the command that should be executed. eg: "convert"
string executer for the command. eg: "perl"
Returns:
boolean false if cmd is not found, or -1 if the handler is not found

Definition at line 95 of file class.t3lib_exec.php.

References _init().

Referenced by t3lib_svbase::checkExec(), t3lib_extMgm::findService(), and getCommand().

t3lib_exec::getCommand (  $  cmd,
$  handler = '',
$  handlerOpt = ''
) 
 

Returns a command string for exec(), system()

Parameters:
string the command that should be executed. eg: "convert"
string handler (executor) for the command. eg: "perl"
string options for the handler, like '-w' for "perl"
Returns:
mixed returns command string, or false if cmd is not found, or -1 if the handler is not found

Definition at line 166 of file class.t3lib_exec.php.

References _init(), and checkCommand().

t3lib_exec::getPaths (  $  addInvalid = false  ) 
 

Returns an array of search paths

Parameters:
boolean If set the array contains invalid path too. Then the key is the path and the value is empty
Returns:
array Array of search paths (empty if exec is disabled)

Definition at line 211 of file class.t3lib_exec.php.

References _init().

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