t3lib_svbase Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	getServiceInfo ()
	getServiceKey ()
	getServiceTitle ()
	getServiceOption ($optionName, $defaultValue='', $includeDefaultConfig=TRUE)
	devLog ($msg, $severity=0, $dataVar=FALSE)
	errorPush ($errNum=T3_ERR_SV_GENERAL, $errMsg='Unspecified error occured')
	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 ()
Öffentliche Attribute
	$info = array()
	$error = array()
	$writeDevLog = false
	$out = ''
	$inputFile = ''
	$inputContent = ''
	$inputType = ''
	$outputFile = ''

---

Beschreibung der Konstruktoren und Destruktoren

t3lib_svbase::__destruct

(

)

Clean up the service.

Rückgabe:

void

---

Dokumentation der Elementfunktionen

t3lib_svbase::checkExec

(

$

progList

)

check the availability of external programs

Parameter:

string

comma list of programs 'perl,python,pdftotext'

Rückgabe:

boolean return FALSE if one program was not found

t3lib_svbase::checkInputFile

(

$

absFile

)

Check if a file exists and is readable.

Parameter:

string

File name with absolute path.

Rückgabe:

string File name or FALSE.

t3lib_svbase::deactivateService

(

)

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

Rückgabe:

void

t3lib_svbase::devLog	(	$	msg,
		$	severity = 0,
		$	dataVar = FALSE
	)

Logs debug messages to t3lib_div::devLog()

Parameter:

	string	Debug message
	integer	Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
	array	Additional data you want to pass to the logger.

Rückgabe:

void

t3lib_svbase::errorPull

(

)

Removes the last error from the error stack.

Rückgabe:

void

t3lib_svbase::errorPush	(	$	errNum = T3_ERR_SV_GENERAL,
		$	errMsg = 'Unspecified error occured'
	)

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

Parameter:

	string	error message
	string	error number (see T3_ERR_SV_* constants)

Rückgabe:

void

t3lib_svbase::getErrorMsgArray

(

)

Returns all error messages as array.

Rückgabe:

array error messages

t3lib_svbase::getInput

(

)

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

Rückgabe:

mixed

t3lib_svbase::getInputFile

(

$

createFile = ''

)

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

Parameter:

string

File name. If empty a temp file will be created.

Rückgabe:

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

t3lib_svbase::getLastError

(

)

Returns the last error number from the error stack.

Rückgabe:

string error number

t3lib_svbase::getLastErrorArray

(

)

Returns the last array from the error stack.

Rückgabe:

array error nr and message

t3lib_svbase::getLastErrorMsg

(

)

Returns the last message from the error stack.

Rückgabe:

string error message

t3lib_svbase::getOutput

(

)

Get the output content.

Rückgabe:

mixed

t3lib_svbase::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

Parameter:

string

Absolute filename to write to

Rückgabe:

mixed

t3lib_svbase::getServiceInfo

(

)

Returns internal information array for service

Rückgabe:

array service description array

t3lib_svbase::getServiceKey

(

)

Returns the service key of the service

Rückgabe:

string service key

t3lib_svbase::getServiceOption	(	$	optionName,
		$	defaultValue = '',
		$	includeDefaultConfig = TRUE
	)

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

Parameter:

	string	Name of the config option
	boolean	If set the 'default' config will be return if no special config for this service is available (default: true)
	[type]	$includeDefaultConfig: ...

Rückgabe:

mixed configuration value for the service

t3lib_svbase::getServiceTitle

(

)

Returns the title of the service

Rückgabe:

string service title

t3lib_svbase::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.

Rückgabe:

boolean TRUE if the service is available

t3lib_svbase::readFile	(	$	absFile,
		$	length = 0
	)

Read content from a file a file.

Parameter:

	string	File name to read from.
	integer	Maximum length to read. If empty the whole file will be read.

Rückgabe:

string $content or FALSE

t3lib_svbase::registerTempFile

(

$

absFile

)

Register file which should be deleted afterwards.

Parameter:

string

File name with absolute path.

Rückgabe:

void

t3lib_svbase::reset

(

)

Resets the service. Will be called by init(). Should be used before every use if a service instance is used multiple times.

Rückgabe:

void

t3lib_svbase::resetErrors

(

)

Reset the error stack.

Rückgabe:

void

t3lib_svbase::setInput	(	$	content,
		$	type = ''
	)

Set the input content for service processing.

Parameter:

	mixed	Input content (going into ->inputContent)
	string	The type of the input content (or file). Might be the same as the service subtypes.

Rückgabe:

void

t3lib_svbase::setInputFile	(	$	absFile,
		$	type = ''
	)

Set the input file name for service processing.

Parameter:

	string	file name
	string	The type of the input content (or file). Might be the same as the service subtypes.

Rückgabe:

void

t3lib_svbase::setOutputFile

(

$

absFile

)

Set the output file name.

Parameter:

string

file name

Rückgabe:

void

t3lib_svbase::tempFile

(

$

filePrefix

)

Create a temporary file.

Parameter:

string

File prefix.

Rückgabe:

string File name or FALSE

t3lib_svbase::unlinkTempFiles

(

)

Delete registered temporary files.

Parameter:

string

File name with absolute path.

Rückgabe:

void

t3lib_svbase::writeFile	(	$	content,
		$	absFile = ''
	)

Write content to a file.

Parameter:

	string	Content to write to the file
	string	File name to write into. If empty a temp file will be created.

Rückgabe:

string File name or FALSE

---

Dokumentation der Datenelemente

t3lib_svbase::$error = array()

error stack

t3lib_svbase::$info = array()

service description array

t3lib_svbase::$inputContent = ''

The content that should be processed.

t3lib_svbase::$inputFile = ''

The file that should be processed.

t3lib_svbase::$inputType = ''

The type of the input content (or file). Might be the same as the service subtypes.

t3lib_svbase::$out = ''

The output content. That's what the services produced as result.

t3lib_svbase::$outputFile = ''

The file where the output should be written to.

t3lib_svbase::$writeDevLog = false

Defines if debug messages should be written with t3lib_div::devLog

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_svbase.php