Solutions Open Source

Référence de la classe t3lib_svbase

Graphe d'héritage de t3lib_svbase:

Inheritance graph
[légende]

Liste de tous les membres

Fonctions membres publiques

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

Attributs publics

 $info = array()
 $error = array()
 $writeDevLog = false
 $out = ''
 $inputFile = ''
 $inputContent = ''
 $inputType = ''
 $outputFile = ''

Attributs privés

 $tempFiles = array()

Documentation des contructeurs et destructeur

t3lib_svbase::__destruct (  ) 

Clean up the service.

Renvoie:
void

Documentation des fonctions membres

t3lib_svbase::getServiceInfo (  ) 

Returns internal information array for service

Renvoie:
array service description array

t3lib_svbase::getServiceKey (  ) 

Returns the service key of the service

Renvoie:
string service key

t3lib_svbase::getServiceTitle (  ) 

Returns the title of the service

Renvoie:
string service title

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

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

Paramètres:
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: ...
Renvoie:
mixed configuration value for the service

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

Logs debug messages to t3lib_div::devLog()

Paramètres:
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.
Renvoie:
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.

Paramètres:
string error message
string error number (see T3_ERR_SV_* constants)
Renvoie:
void

t3lib_svbase::errorPull (  ) 

Removes the last error from the error stack.

Renvoie:
void

t3lib_svbase::getLastError (  ) 

Returns the last error number from the error stack.

Renvoie:
string error number

t3lib_svbase::getLastErrorMsg (  ) 

Returns the last message from the error stack.

Renvoie:
string error message

t3lib_svbase::getErrorMsgArray (  ) 

Returns all error messages as array.

Renvoie:
array error messages

t3lib_svbase::getLastErrorArray (  ) 

Returns the last array from the error stack.

Renvoie:
array error nr and message

t3lib_svbase::resetErrors (  ) 

Reset the error stack.

Renvoie:
void

t3lib_svbase::checkExec ( $  progList  ) 

check the availability of external programs

Paramètres:
string comma list of programs 'perl,python,pdftotext'
Renvoie:
boolean return FALSE if one program was not found

t3lib_svbase::deactivateService (  ) 

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

Renvoie:
void

t3lib_svbase::checkInputFile ( $  absFile  ) 

Check if a file exists and is readable.

Paramètres:
string File name with absolute path.
Renvoie:
string File name or FALSE.

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

Read content from a file a file.

Paramètres:
string File name to read from.
integer Maximum length to read. If empty the whole file will be read.
Renvoie:
string $content or FALSE

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

Write content to a file.

Paramètres:
string Content to write to the file
string File name to write into. If empty a temp file will be created.
Renvoie:
string File name or FALSE

t3lib_svbase::tempFile ( $  filePrefix  ) 

Create a temporary file.

Paramètres:
string File prefix.
Renvoie:
string File name or FALSE

t3lib_svbase::registerTempFile ( $  absFile  ) 

Register file which should be deleted afterwards.

Paramètres:
string File name with absolute path.
Renvoie:
void

t3lib_svbase::unlinkTempFiles (  ) 

Delete registered temporary files.

Paramètres:
string File name with absolute path.
Renvoie:
void

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

Set the input content for service processing.

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

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

Set the input file name for service processing.

Paramètres:
string file name
string The type of the input content (or file). Might be the same as the service subtypes.
Renvoie:
void

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)

Renvoie:
mixed

t3lib_svbase::getInputFile ( $  createFile = ''  ) 

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

Paramètres:
string File name. If empty a temp file will be created.
Renvoie:
string File name or FALSE if no input or file error.

t3lib_svbase::setOutputFile ( $  absFile  ) 

Set the output file name.

Paramètres:
string file name
Renvoie:
void

t3lib_svbase::getOutput (  ) 

Get the output content.

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

Paramètres:
string Absolute filename to write to
Renvoie:
mixed

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.

Renvoie:
boolean TRUE if the service is available

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.

Renvoie:
void

Documentation des données membres

t3lib_svbase::$info = array()

service description array

t3lib_svbase::$error = array()

error stack

t3lib_svbase::$writeDevLog = false

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

Réimplémentée dans tx_sv_authbase.

t3lib_svbase::$out = ''

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

t3lib_svbase::$inputFile = ''

The file that should be processed.

t3lib_svbase::$inputContent = ''

The content 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::$outputFile = ''

The file where the output should be written to.

t3lib_svbase::$tempFiles = array() [private]

Temporary files which have to be deleted

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:42:40 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3