changed wrong param description
authorRené Fritz <r.fritz@colorcube.de>
Tue, 3 May 2005 23:24:43 +0000 (23:24 +0000)
committerRené Fritz <r.fritz@colorcube.de>
Tue, 3 May 2005 23:24:43 +0000 (23:24 +0000)
git-svn-id: https://svn.typo3.org/TYPO3v4/Core/trunk@705 709f56b5-9817-0410-a4d7-c38de5d9e867

t3lib/class.t3lib_svbase.php

index 2d0f23e..23cbd6e 100755 (executable)
@@ -178,19 +178,13 @@ class t3lib_svbase {
 
 
 
-
-
-
-
-
-
-
        /***************************************
         *
         *       Get service meta information
         *
         ***************************************/
 
+
        /**
         * Returns internal information array for service
         *
@@ -200,6 +194,7 @@ class t3lib_svbase {
                return $this->info;
        }
 
+
        /**
         * Returns the service key of the service
         *
@@ -209,6 +204,7 @@ class t3lib_svbase {
                return $this->info['serviceKey'];
        }
 
+
        /**
         * Returns the title of the service
         *
@@ -218,12 +214,13 @@ class t3lib_svbase {
                return $this->info['title'];
        }
 
+
        /**
         * Returns service configuration values from the $TYPO3_CONF_VARS['SVCONF'] array
         *
         * @param       string          Name of the config option
+        * @return      mixed           Default configuration value for the service. Will be returned if no value found.
         * @param       boolean         If set the 'default' config will be return if no special config for this service is available (default: true)
-        * @param       boolean         If set, the option value will be searched for in the "default" configuration (service key = "default") if not found for the service key of the service.
         * @return      mixed           configuration value for the service
         */
        function getServiceOption($optionName, $defaultValue='', $includeDefaultConfig=TRUE) {
@@ -246,20 +243,13 @@ class t3lib_svbase {
 
 
 
-
-
-
-
-
-
-
-
        /***************************************
         *
         *       Error handling
         *
         ***************************************/
 
+
        /**
         * Logs debug messages to t3lib_div::devLog()
         *
@@ -274,6 +264,7 @@ class t3lib_svbase {
                }
        }
 
+
        /**
         * Puts an error on the error stack. Calling without parameter adds a general error.
         *
@@ -290,6 +281,7 @@ class t3lib_svbase {
 
        }
 
+
        /**
         * Removes the last error from the error stack.
         *
@@ -301,6 +293,7 @@ class t3lib_svbase {
                // pop for $GLOBALS['TT']->setTSlogMessage is not supported
        }
 
+
        /**
         * Returns the last error number from the error stack.
         *
@@ -315,6 +308,7 @@ class t3lib_svbase {
                }
        }
 
+
        /**
         * Returns the last message from the error stack.
         *
@@ -329,6 +323,7 @@ class t3lib_svbase {
                }
        }
 
+
        /**
         * Returns all error messages as array.
         *
@@ -346,6 +341,7 @@ class t3lib_svbase {
                return $errArr;
        }
 
+
        /**
         * Returns the last array from the error stack.
         *
@@ -366,21 +362,14 @@ class t3lib_svbase {
 
 
 
-
-
-
-
-
-
-
-
-
        /***************************************
         *
         *       General service functions
         *
         ***************************************/
 
+
+
        /**
         * check the availability of external programs
         *
@@ -388,7 +377,7 @@ class t3lib_svbase {
         * @return      boolean         return FALSE if one program was not found
         */
        function checkExec($progList) {
-               global $TYPO3_CONF_VARS;
+               global $T3_VAR, $TYPO3_CONF_VARS;
 
                $ret = TRUE;
 
@@ -405,6 +394,7 @@ class t3lib_svbase {
                return $ret;
        }
 
+
        /**
         * Deactivate the service. Use this if the service fails at runtime and will not be available.
         *
@@ -422,16 +412,14 @@ class t3lib_svbase {
 
 
 
-
-
-
-
        /***************************************
         *
         *       IO tools
         *
         ***************************************/
 
+
+
        /**
         * Check if a file exists and is readable.
         *
@@ -451,6 +439,7 @@ class t3lib_svbase {
                return FALSE;
        }
 
+
        /**
         * Read content from a file a file.
         *
@@ -475,6 +464,7 @@ class t3lib_svbase {
                return $out;
        }
 
+
        /**
         * Write content to a file.
         *
@@ -544,23 +534,13 @@ class t3lib_svbase {
        }
 
 
-
-
-
-
-
-
-
-
-
-
-
        /***************************************
         *
         *       IO input
         *
         ***************************************/
 
+
        /**
         * Set the input content for service processing.
         *
@@ -574,6 +554,7 @@ class t3lib_svbase {
                $this->inputType = $type;
        }
 
+
        /**
         * Set the input file name for service processing.
         *
@@ -587,6 +568,7 @@ class t3lib_svbase {
                $this->inputType = $type;
        }
 
+
        /**
         * Get the input content.
         * Will be read from input file if needed. (That is if ->inputContent is empty and ->inputFile is not)
@@ -600,6 +582,7 @@ class t3lib_svbase {
                return $this->inputContent;
        }
 
+
        /**
         * Get the input file name.
         * If the content was set by setContent a file will be created.
@@ -619,19 +602,13 @@ class t3lib_svbase {
 
 
 
-
-
-
-
-
-
-
        /***************************************
         *
         *       IO output
         *
         ***************************************/
 
+
        /**
         * Set the output file name.
         *
@@ -642,6 +619,7 @@ class t3lib_svbase {
                $this->outputFile = $absFile;
        }
 
+
        /**
         * Get the output content.
         *
@@ -654,6 +632,7 @@ class t3lib_svbase {
                return $this->out;
        }
 
+
        /**
         * Get the output file name. If no output file is set, the ->out buffer is written to the file given by input parameter filename
         *
@@ -670,14 +649,6 @@ class t3lib_svbase {
 
 
 
-
-
-
-
-
-
-
-
        /***************************************
         *
         *       Service implementation
@@ -709,6 +680,7 @@ class t3lib_svbase {
                return $this->getLastError();
        }
 
+
        /**
         * Resets the service.
         * Will be called by init(). Should be used before every use if a service instance is used multiple times.
@@ -734,10 +706,12 @@ class t3lib_svbase {
                $this->unlinkTempFiles();
        }
 
+
        /* every service type has it's own API
        function process($content='', $type='', $conf=array())  {       //
        }
        */
+
 }
 
 /**