Inheritance diagram for AbstractService:

Public Member Functions
	getServiceInfo ()

	getServiceKey ()

	getServiceTitle ()

	getServiceOption ($optionName, $defaultValue= '', $includeDefaultConfig=true)

	devLog ($msg, $severity=0, $dataVar=false)

	errorPush ($errNum=T3_ERR_SV_GENERAL, $errMsg= 'Unspecified error occurred')

	errorPull ()

	getLastError ()

	getLastErrorMsg ()

	getErrorMsgArray ()

	getLastErrorArray ()

	resetErrors ()

	checkExec ($progList)

	deactivateService ()

	checkInputFile ($absFile)

	readFile ($absFile, $length=0)

	writeFile ($content, $absFile= '')

	tempFile ($filePrefix)

	registerTempFile ($absFile)

	unlinkTempFiles ()

	setInput ($content, $type= '')

	setInputFile ($absFile, $type= '')

	getInput ()

	getInputFile ($createFile= '')

	setOutputFile ($absFile)

	getOutput ()

	getOutputFile ($absFile= '')

	init ()

	reset ()

	__destruct ()

Public Attributes
	$info = array()

	$error = array()

	$writeDevLog = false

	$out = ''

	$inputFile = ''

	$inputContent = ''

	$inputType = ''

	$outputFile = ''

	$tempFiles = array()

Protected Attributes
	$shutdownRegistry = array()

	$prefixId = ''

Detailed Description

Parent class for "Services" classes

Definition at line 20 of file AbstractService.php.

Constructor & Destructor Documentation

__destruct ( )

Clean up the service. Child classes should explicitly call parent::__destruct() in their destructors for this to work

Returns: void

Definition at line 556 of file AbstractService.php.

References AbstractService\unlinkTempFiles().

Member Function Documentation

checkExec ( $progList )

check the availability of external programs

Parameters

string $progList Comma list of programs 'perl,python,pdftotext'

Returns: bool Return FALSE if one program was not found

Definition at line 261 of file AbstractService.php.

References AbstractService\errorPush().

Referenced by AbstractService\init().

checkInputFile ( $absFile )

Check if a file exists and is readable.

Parameters

string $absFile File name with absolute path.

Returns: string|boolean File name or FALSE.

Definition at line 296 of file AbstractService.php.

References AbstractService\errorPush(), and GeneralUtility\isAllowedAbsPath().

Referenced by AbstractService\getInputFile(), and AbstractService\readFile().

deactivateService ( )

Deactivate the service. Use this if the service fails at runtime and will not be available.

Returns: void

Definition at line 280 of file AbstractService.php.

devLog	(	$msg,
		$severity = `0`,
		$dataVar = `false`
	)

Logs debug messages to ::devLog()

Parameters

string	$msg	Debug message
int	$severity	Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
array \| bool	$dataVar	dditional data you want to pass to the logger.

Returns: void

Definition at line 151 of file AbstractService.php.

errorPull ( )

Removes the last error from the error stack.

Returns: void

Definition at line 178 of file AbstractService.php.

errorPush	(	$errNum = `T3_ERR_SV_GENERAL`,
		$errMsg = `'Unspecified error occurred'`
	)

Puts an error on the error stack. Calling without parameter adds a general error.

Parameters

int	$errNum	Error number (see T3_ERR_SV_* constants)
string	$errMsg	Error message

Returns: void

Definition at line 165 of file AbstractService.php.

References $GLOBALS.

Referenced by AbstractService\checkExec(), AbstractService\checkInputFile(), AbstractService\readFile(), AbstractService\tempFile(), and AbstractService\writeFile().

getErrorMsgArray ( )

Returns all error messages as array.

Returns: array Error messages

Definition at line 219 of file AbstractService.php.

References AbstractService\$error.

getInput ( )

Get the input content. Will be read from input file if needed. (That is if ->inputContent is empty and ->inputFile is not)

Returns: mixed

Definition at line 440 of file AbstractService.php.

References AbstractService\$inputContent, and AbstractService\readFile().

getInputFile ( $createFile = '' )

Get the input file name. If the content was set by setContent a file will be created.

Parameters

string $createFile File name. If empty a temp file will be created.

Returns: string File name or FALSE if no input or file error.

Definition at line 455 of file AbstractService.php.

References AbstractService\$inputFile, AbstractService\checkInputFile(), elseif, and AbstractService\writeFile().

getLastError ( )

Returns the last error number from the error stack.

Returns: int|bool Error number (or TRUE if no error)

Definition at line 188 of file AbstractService.php.

References AbstractService\$error.

Referenced by AbstractService\init().

getLastErrorArray ( )

Returns the last array from the error stack.

Returns: array Error number and message

Definition at line 235 of file AbstractService.php.

getLastErrorMsg ( )

Returns the last message from the error stack.

Returns: string Error message

Definition at line 204 of file AbstractService.php.

References AbstractService\$error.

getOutput ( )

Get the output content.

Returns: mixed

Definition at line 486 of file AbstractService.php.

References AbstractService\$out, and AbstractService\readFile().

getOutputFile ( $absFile = '' )

Get the output file name. If no output file is set, the ->out buffer is written to the file given by input parameter filename

Parameters

string $absFile Absolute filename to write to

Returns: mixed

Definition at line 500 of file AbstractService.php.

References AbstractService\$outputFile, and AbstractService\writeFile().

getServiceInfo ( )

Returns internal information array for service

Returns: array Service description array

Definition at line 90 of file AbstractService.php.

References AbstractService\$info.

getServiceKey ( )

Returns the service key of the service

Returns: string Service key

Definition at line 100 of file AbstractService.php.

getServiceOption	(	$optionName,
		$defaultValue = `''`,
		$includeDefaultConfig = `true`
	)

Returns service configuration values from the $TYPO3_CONF_VARS['SVCONF'] array

Parameters

string	$optionName	Name of the config option
mixed	$defaultValue	Default configuration if no special config is available
bool	$includeDefaultConfig	If set the 'default' config will be returned if no special config for this service is available (default: TRUE)

Returns: mixed Configuration value for the service

Definition at line 123 of file AbstractService.php.

References $GLOBALS, and elseif.

Referenced by AbstractAuthenticationService\initAuth().

getServiceTitle ( )

Returns the title of the service

Returns: string Service title

Definition at line 110 of file AbstractService.php.

init ( )

Initialization of the service.

The class have to do a strict check if the service is available. example: check if the perl interpreter is available which is needed to run an extern perl script.