[TASK] Remove the "@todo define visibility" in ext:core 75/33275/2
authorWouter Wolters <typo3@wouterwolters.nl>
Sun, 12 Oct 2014 15:08:46 +0000 (17:08 +0200)
committerMarkus Klein <klein.t3@reelworx.at>
Mon, 13 Oct 2014 14:26:31 +0000 (16:26 +0200)
The "@todo Define visibility" is not very helpful because:

 * Nobody knows what breaks if changing the visibility
 * The code is flooded with todos which makes it hard
   to work with in an IDE

During ACME it was decided to remove the @todo again.

Resolves: #62178
Related: #61957
Releases: master
Change-Id: I814739b00128a8ce7403abb42338b10dd598c8c4
Reviewed-on: http://review.typo3.org/33275
Reviewed-by: Stefan Froemken <froemken@gmail.com>
Tested-by: Stefan Froemken <froemken@gmail.com>
Reviewed-by: Alexander Opitz <opitz.alexander@googlemail.com>
Tested-by: Alexander Opitz <opitz.alexander@googlemail.com>
Reviewed-by: Markus Klein <klein.t3@reelworx.at>
Tested-by: Markus Klein <klein.t3@reelworx.at>
17 files changed:
typo3/sysext/core/Classes/Charset/CharsetConverter.php
typo3/sysext/core/Classes/Controller/CommandLineController.php
typo3/sysext/core/Classes/Database/DatabaseConnection.php
typo3/sysext/core/Classes/Database/ReferenceIndex.php
typo3/sysext/core/Classes/Database/SoftReferenceIndex.php
typo3/sysext/core/Classes/Html/HtmlParser.php
typo3/sysext/core/Classes/Html/RteHtmlParser.php
typo3/sysext/core/Classes/Imaging/GraphicalFunctions.php
typo3/sysext/core/Classes/Integrity/DatabaseIntegrityCheck.php
typo3/sysext/core/Classes/Service/AbstractService.php
typo3/sysext/core/Classes/TimeTracker/TimeTracker.php
typo3/sysext/core/Classes/TypoScript/ConfigurationForm.php
typo3/sysext/core/Classes/TypoScript/Parser/TypoScriptParser.php
typo3/sysext/core/Classes/Utility/DiffUtility.php
typo3/sysext/core/Classes/Utility/File/BasicFileUtility.php
typo3/sysext/core/Classes/Utility/File/ExtendedFileUtility.php
typo3/sysext/core/Tests/Unit/Log/Processor/AbstractMemoryTest.php

index a5535c1..3f4ff0e 100644 (file)
@@ -60,31 +60,31 @@ class CharsetConverter {
 
        // ASCII Value for chars with no equivalent.
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $noCharByteVal = 63;
 
        // This is the array where parsed conversion tables are stored (cached)
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $parsedCharsets = array();
 
        // An array where case folding data will be stored (cached)
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $caseFolding = array();
 
        // An array where charset-to-ASCII mappings are stored (cached)
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $toASCII = array();
 
        // This tells the converter which charsets has two bytes per char:
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $twoByteSets = array(
                'ucs-2' => 1
@@ -92,7 +92,7 @@ class CharsetConverter {
 
        // This tells the converter which charsets has four bytes per char:
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $fourByteSets = array(
                'ucs-4' => 1,
@@ -102,7 +102,7 @@ class CharsetConverter {
 
        // This tells the converter which charsets use a scheme like the Extended Unix Code:
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $eucBasedSets = array(
                'gb2312' => 1,
@@ -117,7 +117,7 @@ class CharsetConverter {
        // See  http://developer.apple.com/documentation/macos8/TextIntlSvcs/TextEncodingConversionManager/TEC1.5/TEC.b0.html
        // http://czyborra.com/charsets/iso8859.html
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $synonyms = array(
                'us' => 'ascii',
@@ -207,7 +207,7 @@ class CharsetConverter {
 
        // Mapping of iso-639-1 language codes to script names
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $lang_to_script = array(
                // iso-639-1 language codes, see http://www.loc.gov/standards/iso639-2/php/code_list.php
@@ -464,7 +464,7 @@ class CharsetConverter {
 
        // Mapping of language (family) names to charsets on Unix
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $script_to_charset_unix = array(
                'west_european' => 'iso-8859-1',
@@ -492,7 +492,7 @@ class CharsetConverter {
 
        // Mapping of language (family) names to charsets on Windows
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $script_to_charset_windows = array(
                'east_european' => 'windows-1250',
@@ -518,7 +518,7 @@ class CharsetConverter {
 
        // Mapping of locale names to charsets
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $locale_to_charset = array(
                'japanese.euc' => 'euc-jp',
@@ -533,7 +533,7 @@ class CharsetConverter {
        // TYPO3 specific: Array with the system charsets used for each system language in TYPO3:
        // Empty values means "iso-8859-1"
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $charSetArray = array(
                'af' => '',
@@ -616,7 +616,6 @@ class CharsetConverter {
         *
         * @param string $charset Input charset
         * @return string Normalized charset
-        * @todo Define visibility
         */
        public function parse_charset($charset) {
                $charset = trim(strtolower($charset));
@@ -636,7 +635,6 @@ class CharsetConverter {
         *
         * @param string $locale Locale string
         * @return string Charset resolved for locale string
-        * @todo Define visibility
         */
        public function get_locale_charset($locale) {
                $locale = strtolower($locale);
@@ -682,7 +680,6 @@ class CharsetConverter {
         * @param boolean $useEntityForNoChar If set, then characters that are not available in the destination character set will be encoded as numeric entities
         * @return string Converted string
         * @see convArray()
-        * @todo Define visibility
         */
        public function conv($str, $fromCS, $toCS, $useEntityForNoChar = 0) {
                if ($fromCS == $toCS) {
@@ -731,7 +728,6 @@ class CharsetConverter {
         * @param boolean $useEntityForNoChar If set, then characters that are not available in the destination character set will be encoded as numeric entities
         * @return void
         * @see conv()
-        * @todo Define visibility
         */
        public function convArray(&$array, $fromCS, $toCS, $useEntityForNoChar = 0) {
                foreach ($array as $key => $value) {
@@ -749,7 +745,6 @@ class CharsetConverter {
         * @param string $str String in local charset to convert to UTF-8
         * @param string $charset Charset, lowercase. Must be found in csconvtbl/ folder.
         * @return string Output string, converted to UTF-8
-        * @todo Define visibility
         */
        public function utf8_encode($str, $charset) {
                if ($charset === 'utf-8') {
@@ -809,7 +804,6 @@ class CharsetConverter {
         * @param string $charset Charset, lowercase. Must be found in csconvtbl/ folder.
         * @param boolean $useEntityForNoChar If set, then characters that are not available in the destination character set will be encoded as numeric entities
         * @return string Output string, converted to local charset
-        * @todo Define visibility
         */
        public function utf8_decode($str, $charset, $useEntityForNoChar = 0) {
                if ($charset === 'utf-8') {
@@ -876,7 +870,6 @@ class CharsetConverter {
         *
         * @param string $str Input string
         * @return string Output string
-        * @todo Define visibility
         */
        public function utf8_to_entities($str) {
                $strLen = strlen($str);
@@ -922,7 +915,6 @@ class CharsetConverter {
         * @param string $str Input string, UTF-8
         * @param boolean $alsoStdHtmlEnt If set, then all string-HTML entities (like &amp; or &pound; will be converted as well)
         * @return string Output string
-        * @todo Define visibility
         */
        public function entities_to_utf8($str, $alsoStdHtmlEnt = FALSE) {
                if ($alsoStdHtmlEnt) {
@@ -964,7 +956,6 @@ class CharsetConverter {
         * @param boolean $convEntities If set, then all HTML entities (like &amp; or &pound; or &#123; or &#x3f5d;) will be detected as characters.
         * @param boolean $retChar If set, then instead of integer numbers the real UTF-8 char is returned.
         * @return array Output array with the char numbers
-        * @todo Define visibility
         */
        public function utf8_to_numberarray($str, $convEntities = 0, $retChar = 0) {
                // If entities must be registered as well...:
@@ -1028,7 +1019,6 @@ class CharsetConverter {
         * @param integer $cbyte UNICODE integer
         * @return string UTF-8 multibyte character string
         * @see utf8CharToUnumber()
-        * @todo Define visibility
         */
        public function UnumberToChar($cbyte) {
                $str = '';
@@ -1084,7 +1074,6 @@ class CharsetConverter {
         * @param boolean $hex If set, then a hex. number is returned.
         * @return integer UNICODE integer
         * @see UnumberToChar()
-        * @todo Define visibility
         */
        public function utf8CharToUnumber($str, $hex = 0) {
                // First char
@@ -1125,7 +1114,6 @@ class CharsetConverter {
         * @param string The charset to be initialized. Use lowercase charset always (the charset must match exactly with a filename in csconvtbl/ folder ([charset].tbl)
         * @return integer Returns '1' if already loaded. Returns FALSE if charset conversion table was not found. Returns '2' if the charset conversion table was found and parsed.
         * @acces private
-        * @todo Define visibility
         */
        public function initCharset($charset) {
                // Only process if the charset is not yet loaded:
@@ -1191,7 +1179,6 @@ class CharsetConverter {
         * @param string $mode Mode ("case", "ascii", ...)
         * @return integer Returns FALSE on error, a TRUE value on success: 1 table already loaded, 2, cached version, 3 table parsed (and cached).
         * @access private
-        * @todo Define visibility
         */
        public function initUnicodeData($mode = NULL) {
                // Cache files
@@ -1433,7 +1420,6 @@ class CharsetConverter {
         * @param string $charset Charset for which to initialize case folding.
         * @return integer Returns FALSE on error, a TRUE value on success: 1 table already loaded, 2, cached version, 3 table parsed (and cached).
         * @access private
-        * @todo Define visibility
         */
        public function initCaseFolding($charset) {
                // Only process if the case table is not yet loaded:
@@ -1495,7 +1481,6 @@ class CharsetConverter {
         * @param string $charset Charset for which to initialize conversion.
         * @return integer Returns FALSE on error, a TRUE value on success: 1 table already loaded, 2, cached version, 3 table parsed (and cached).
         * @access private
-        * @todo Define visibility
         */
        public function initToASCII($charset) {
                // Only process if the case table is not yet loaded:
@@ -1545,7 +1530,6 @@ class CharsetConverter {
         * @param integer $len Length (in characters)
         * @return string The substring
         * @see substr(), mb_substr()
-        * @todo Define visibility
         */
        public function substr($charset, $string, $start, $len = NULL) {
                if ($len === 0 || $string === '') {
@@ -1598,7 +1582,6 @@ class CharsetConverter {
         * @param string $string Character string
         * @return integer The number of characters
         * @see strlen()
-        * @todo Define visibility
         */
        public function strlen($charset, $string) {
                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['t3lib_cs_utils'] == 'mbstring') {
@@ -1650,7 +1633,6 @@ class CharsetConverter {
         * @param string $crop Crop signifier
         * @return string The shortened string
         * @see substr(), mb_strimwidth()
-        * @todo Define visibility
         */
        public function crop($charset, $string, $len, $crop = '') {
                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['t3lib_cs_utils'] == 'mbstring') {
@@ -1698,7 +1680,6 @@ class CharsetConverter {
         * @param integer $len The byte length
         * @return string The shortened string
         * @see mb_strcut()
-        * @todo Define visibility
         */
        public function strtrunc($charset, $string, $len) {
                if ($len <= 0) {
@@ -1736,7 +1717,6 @@ class CharsetConverter {
         * @param string $case Case keyword: "toLower" means lowercase conversion, anything else is uppercase (use "toUpper" )
         * @return string The converted string
         * @see strtolower(), strtoupper()
-        * @todo Define visibility
         */
        public function conv_case($charset, $string, $case) {
                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['t3lib_cs_utils'] == 'mbstring') {
@@ -1778,7 +1758,6 @@ class CharsetConverter {
         * @param string $charset Character set of string
         * @param string $string Input string to convert
         * @return string The converted string
-        * @todo Define visibility
         */
        public function specCharsToASCII($charset, $string) {
                if ($charset === 'utf-8') {
@@ -1858,7 +1837,6 @@ class CharsetConverter {
         * @param string $mode Mode: 'case' (case folding) or 'ascii' (ASCII transliteration)
         * @param string $opt 'case': conversion 'toLower' or 'toUpper'
         * @return string The converted string
-        * @todo Define visibility
         */
        public function sb_char_mapping($str, $charset, $mode, $opt = '') {
                switch ($mode) {
@@ -1905,7 +1883,6 @@ class CharsetConverter {
         * @param integer $len Length (in characters)
         * @return string The substring
         * @see substr()
-        * @todo Define visibility
         */
        public function utf8_substr($str, $start, $len = NULL) {
                if ((string)$len === '0') {
@@ -1942,7 +1919,6 @@ class CharsetConverter {
         * @param string $str UTF-8 multibyte character string
         * @return integer The number of characters
         * @see strlen()
-        * @todo Define visibility
         */
        public function utf8_strlen($str) {
                $n = 0;
@@ -1966,7 +1942,6 @@ class CharsetConverter {
         * @param integer $len The byte length
         * @return string The shortened string
         * @see mb_strcut()
-        * @todo Define visibility
         */
        public function utf8_strtrunc($str, $len) {
                $i = $len - 1;
@@ -1998,7 +1973,6 @@ class CharsetConverter {
         * @param integer $offset Positition to start the search
         * @return integer The character position
         * @see strpos()
-        * @todo Define visibility
         */
        public function utf8_strpos($haystack, $needle, $offset = 0) {
                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['t3lib_cs_utils'] == 'mbstring') {
@@ -2026,7 +2000,6 @@ class CharsetConverter {
         * @param string $needle UTF-8 character to search for (single character)
         * @return integer The character position
         * @see strrpos()
-        * @todo Define visibility
         */
        public function utf8_strrpos($haystack, $needle) {
                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['t3lib_cs_utils'] == 'mbstring') {
@@ -2049,7 +2022,6 @@ class CharsetConverter {
         * @param string $str UTF-8 string
         * @param integer $pos Character position (negative values start from the end)
         * @return integer Byte position
-        * @todo Define visibility
         */
        public function utf8_char2byte_pos($str, $pos) {
                // Number of characters found
@@ -2096,7 +2068,6 @@ class CharsetConverter {
         * @param string $str UTF-8 string
         * @param integer $pos Byte position
         * @return integer Character position
-        * @todo Define visibility
         */
        public function utf8_byte2char_pos($str, $pos) {
                // Number of characters
@@ -2125,7 +2096,6 @@ class CharsetConverter {
         * @param string $mode Mode: 'case' (case folding) or 'ascii' (ASCII transliteration)
         * @param string $opt 'case': conversion 'toLower' or 'toUpper'
         * @return string The converted string
-        * @todo Define visibility
         */
        public function utf8_char_mapping($str, $mode, $opt = '') {
                if (!$this->initUnicodeData($mode)) {
@@ -2185,7 +2155,6 @@ class CharsetConverter {
         * @param string $charset The charset
         * @return string The shortened string
         * @see mb_strcut()
-        * @todo Define visibility
         */
        public function euc_strtrunc($str, $len, $charset) {
                $sjis = $charset == 'shift_jis';
@@ -2221,7 +2190,6 @@ class CharsetConverter {
         * @param string $charset The charset
         * @param integer $len Length (in characters)
         * @return string the substring
-        * @todo Define visibility
         */
        public function euc_substr($str, $start, $charset, $len = NULL) {
                $byte_start = $this->euc_char2byte_pos($str, $start, $charset);
@@ -2250,7 +2218,6 @@ class CharsetConverter {
         * @param string $charset The charset
         * @return integer The number of characters
         * @see strlen()
-        * @todo Define visibility
         */
        public function euc_strlen($str, $charset) {
                $sjis = $charset == 'shift_jis';
@@ -2278,7 +2245,6 @@ class CharsetConverter {
         * @param integer $pos Character position (negative values start from the end)
         * @param string $charset The charset
         * @return integer Byte position
-        * @todo Define visibility
         */
        public function euc_char2byte_pos($str, $pos, $charset) {
                $sjis = $charset == 'shift_jis';
@@ -2325,7 +2291,6 @@ class CharsetConverter {
         * @param string $mode Mode: 'case' (case folding) or 'ascii' (ASCII transliteration)
         * @param string $opt 'case': conversion 'toLower' or 'toUpper'
         * @return string The converted string
-        * @todo Define visibility
         */
        public function euc_char_mapping($str, $charset, $mode, $opt = '') {
                switch ($mode) {
index 6fee5fc..ffb1dc0 100644 (file)
@@ -27,12 +27,12 @@ class CommandLineController {
 
        // Command line arguments, exploded into key => value-array pairs
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $cli_args = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $cli_options = array(
                array('-s', 'Silent operation, will only output errors and important messages.'),
@@ -41,7 +41,7 @@ class CommandLineController {
        );
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $cli_help = array(
                'name' => 'CLI base class (overwrite this...)',
@@ -54,7 +54,7 @@ class CommandLineController {
        );
 
        /**
-        * @todo Define visibility
+        * @var resource
         */
        public $stdin = NULL;
 
@@ -63,7 +63,6 @@ class CommandLineController {
         * Make sure child classes also call this!
         *
         * @return void
-        * @todo Define visibility
         */
        public function __construct() {
                // Loads the cli_args array with command line arguments
@@ -77,7 +76,6 @@ class CommandLineController {
         * @param string $option Option string, eg. "-s
         * @param array $argv Input argv array
         * @return array Output argv array with all options AFTER the found option.
-        * @todo Define visibility
         */
        public function cli_getArgArray($option, $argv) {
                while (count($argv) && (string)$argv[0] !== (string)$option) {
@@ -94,7 +92,6 @@ class CommandLineController {
         *
         * @param string $option Option string, eg. "-s
         * @return boolean TRUE if option found
-        * @todo Define visibility
         */
        public function cli_isArg($option) {
                return isset($this->cli_args[$option]);
@@ -106,7 +103,6 @@ class CommandLineController {
         * @param string $option Option string, eg. "-s
         * @param integer $idx Value index, default is 0 (zero) = the first one...
         * @return boolean TRUE if option found
-        * @todo Define visibility
         */
        public function cli_argValue($option, $idx = 0) {
                return is_array($this->cli_args[$option]) ? $this->cli_args[$option][$idx] : '';
@@ -119,7 +115,6 @@ class CommandLineController {
         *
         * @param array $argv Configuration options
         * @return array
-        * @todo Define visibility
         */
        public function cli_getArgIndex(array $argv = array()) {
                $cli_options = array();
@@ -147,7 +142,6 @@ class CommandLineController {
         * Validates if the input arguments in this->cli_args are all listed in this->cli_options and if not,
         * will exit with an error.
         *
-        * @todo Define visibility
         */
        public function cli_validateArgs() {
                $cli_args_copy = $this->cli_args;
@@ -195,7 +189,6 @@ class CommandLineController {
         * Asks stdin for keyboard input and returns the line (after enter is pressed)
         *
         * @return string
-        * @todo Define visibility
         */
        public function cli_keyboardInput() {
                // Have to open the stdin stream only ONCE! otherwise I cannot read multiple lines from it... :
@@ -213,7 +206,6 @@ class CommandLineController {
         *
         * @param string $msg String to ask before...
         * @return boolean TRUE if "y" or "yes" is the input (case insensitive)
-        * @todo Define visibility
         */
        public function cli_keyboardInput_yes($msg = '') {
                // ONLY makes sense to echo it out since we are awaiting keyboard input - that cannot be silenced
@@ -227,7 +219,6 @@ class CommandLineController {
         * @param string $string The string
         * @param boolean $force If string should be written even if -s is set (-ss will subdue it!)
         * @return boolean Returns TRUE if string was outputted.
-        * @todo Define visibility
         */
        public function cli_echo($string = '', $force = FALSE) {
                if (isset($this->cli_args['-ss'])) {
@@ -248,7 +239,6 @@ class CommandLineController {
         * Prints help-output from ->cli_help array
         *
         * @return void
-        * @todo Define visibility
         */
        public function cli_help() {
                foreach ($this->cli_help as $key => $value) {
@@ -291,7 +281,6 @@ class CommandLineController {
         * @param string $str String to break and indent.
         * @param integer $indent Number of space chars to indent.
         * @return string Result
-        * @todo Define visibility
         */
        public function cli_indent($str, $indent) {
                $lines = explode(LF, wordwrap($str, 75 - $indent));
index 9fa3359..74123e6 100644 (file)
@@ -61,26 +61,26 @@ class DatabaseConnection {
 
        // Set "TRUE" or "1" if you want database errors outputted. Set to "2" if you also want successful database actions outputted.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $debugOutput = FALSE;
 
        // Internally: Set to last built query (not necessarily executed...)
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $debug_lastBuiltQuery = '';
 
        // Set "TRUE" if you want the last built query to be stored in $debug_lastBuiltQuery independent of $this->debugOutput
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $store_lastBuiltQuery = FALSE;
 
        // Set this to 1 to get queries explained (devIPmask must match). Set the value to 2 to the same but disregarding the devIPmask.
        // There is an alternative option to enable explain output in the admin panel under "TypoScript", which will produce much nicer output, but only works in FE.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $explainOutput = 0;
 
@@ -150,7 +150,7 @@ class DatabaseConnection {
 
        // Default character set, applies unless character set or collation are explicitly set
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $default_charset = 'utf8';
 
@@ -1761,7 +1761,6 @@ class DatabaseConnection {
         * @param string $func Function calling debug()
         * @param string $query Last query if not last built query
         * @return void
-        * @todo Define visibility
         */
        public function debug($func, $query = '') {
                $error = $this->sql_error();
@@ -1786,7 +1785,6 @@ class DatabaseConnection {
         *
         * @param boolean|\mysqli_result|object MySQLi result object / DBAL object
         * @return boolean TRUE if the  record set is valid, FALSE otherwise
-        * @todo Define visibility
         */
        public function debug_check_recordset($res) {
                if ($res !== FALSE) {
index 7700a65..162baad 100644 (file)
@@ -32,38 +32,38 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 class ReferenceIndex {
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $temp_flexRelations = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $errorLog = array();
 
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $WSOL = FALSE;
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $relations = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $words_strings = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $words = array();
 
        // Number which we can increase if a change in the code means we will have to force a re-generation of the index.
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $hashVersion = 1;
 
@@ -98,7 +98,6 @@ class ReferenceIndex {
         * @param integer $uid UID of record
         * @param boolean $testOnly If set, nothing will be written to the index but the result value will still report statistics on what is added, deleted and kept. Can be used for mere analysis.
         * @return array Array with statistics about how many index records were added, deleted and not altered plus the complete reference set for the record.
-        * @todo Define visibility
         */
        public function updateRefIndexTable($table, $uid, $testOnly = FALSE) {
                // First, secure that the index table is not updated with workspace tainted relations:
@@ -159,7 +158,6 @@ class ReferenceIndex {
         * @param string $table Table name from $GLOBALS['TCA']
         * @param integer $uid Record UID
         * @return array Index Rows
-        * @todo Define visibility
         */
        public function generateRefIndexData($table, $uid) {
                if (isset($GLOBALS['TCA'][$table])) {
@@ -240,7 +238,6 @@ class ReferenceIndex {
         * @param string $softref_key If the reference is a soft reference, this is the soft reference parser key. Otherwise empty.
         * @param string $softref_id Soft reference ID for key. Might be useful for replace operations.
         * @return array Array record to insert into table.
-        * @todo Define visibility
         */
        public function createEntryData($table, $uid, $field, $flexpointer, $deleted, $ref_table, $ref_uid, $ref_string = '', $sort = -1, $softref_key = '', $softref_id = '') {
                return array(
@@ -269,7 +266,6 @@ class ReferenceIndex {
         * @param integer $deleted Whether record is deleted-flagged or not
         * @param array $items Data array with databaes relations (table/id)
         * @return void
-        * @todo Define visibility
         */
        public function createEntryData_dbRels($table, $uid, $fieldname, $flexpointer, $deleted, $items) {
                foreach ($items as $sort => $i) {
@@ -287,7 +283,6 @@ class ReferenceIndex {
         * @param integer $deleted Whether record is deleted-flagged or not
         * @param array $items Data array with file relations
         * @return      void
-        * @todo Define visibility
         */
        public function createEntryData_fileRels($table, $uid, $fieldname, $flexpointer, $deleted, $items) {
                foreach ($items as $sort => $i) {
@@ -309,7 +304,6 @@ class ReferenceIndex {
         * @param integer $deleted
         * @param array $keys Data array with soft reference keys
         * @return void
-        * @todo Define visibility
         */
        public function createEntryData_softreferences($table, $uid, $fieldname, $flexpointer, $deleted, $keys) {
                if (is_array($keys)) {
@@ -353,7 +347,6 @@ class ReferenceIndex {
         * @param string $onlyField Specific field to fetch for.
         * @return array Array with information about relations
         * @see export_addRecord()
-        * @todo Define visibility
         */
        public function getRelations($table, $row, $onlyField = '') {
                // Initialize:
@@ -459,7 +452,6 @@ class ReferenceIndex {
         * @param object $pObj Object reference to caller
         * @return void
         * @see \TYPO3\CMS\Core\DataHandling\DataHandler::checkValue_flex_procInData_travDS()
-        * @todo Define visibility
         */
        public function getRelations_flexFormCallBack($dsArr, $dataValue, $PA, $structurePath, $pObj) {
                // Removing "data/" in the beginning of path (which points to location in data array)
@@ -524,7 +516,6 @@ class ReferenceIndex {
         * @param array $conf Field configuration array of type "TCA/columns
         * @param integer $uid Field uid
         * @return bool|array If field type is OK it will return an array with the files inside. Else FALSE
-        * @todo Define visibility
         */
        public function getRelations_procFiles($value, $conf, $uid) {
                if ($conf['type'] !== 'group' || ($conf['internal_type'] !== 'file' && $conf['internal_type'] !== 'file_reference')) {
@@ -587,7 +578,6 @@ class ReferenceIndex {
         * @param string $table Table name
         * @param string $field Field name
         * @return array If field type is OK it will return an array with the database relations. Else FALSE
-        * @todo Define visibility
         */
        public function getRelations_procDB($value, $conf, $uid, $table = '', $field = '') {
                // Get IRRE relations
@@ -648,7 +638,6 @@ class ReferenceIndex {
         * @param boolean $returnDataArray Return $dataArray only, do not submit it to database.
         * @param boolean $bypassWorkspaceAdminCheck If set, it will bypass check for workspace-zero and admin user
         * @return string If a return string, that carries an error message, otherwise FALSE (=OK) (except if $returnDataArray is set!)
-        * @todo Define visibility
         */
        public function setReferenceValue($hash, $newValue, $returnDataArray = FALSE, $bypassWorkspaceAdminCheck = FALSE) {
                if ($GLOBALS['BE_USER']->workspace === 0 && $GLOBALS['BE_USER']->isAdmin() || $bypassWorkspaceAdminCheck) {
@@ -754,7 +743,6 @@ class ReferenceIndex {
         * @param array $dataArray Data array in which the new value is set (passed by reference)
         * @param string $flexpointer Flexform pointer, if in a flex form field.
         * @return string Error message if any, otherwise FALSE = OK
-        * @todo Define visibility
         */
        public function setReferenceValue_dbRels($refRec, $itemArray, $newValue, &$dataArray, $flexpointer = '') {
                if ((int)$itemArray[$refRec['sorting']]['id'] === (int)$refRec['ref_uid'] && (string)$itemArray[$refRec['sorting']]['table'] === (string)$refRec['ref_table']) {
@@ -792,7 +780,6 @@ class ReferenceIndex {
         * @param array $dataArray Data array in which the new value is set (passed by reference)
         * @param string $flexpointer Flexform pointer, if in a flex form field.
         * @return string Error message if any, otherwise FALSE = OK
-        * @todo Define visibility
         */
        public function setReferenceValue_fileRels($refRec, $itemArray, $newValue, &$dataArray, $flexpointer = '') {
                $ID_absFile = \TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix($itemArray[$refRec['sorting']]['ID_absFile']);
@@ -831,7 +818,6 @@ class ReferenceIndex {
         * @param array $dataArray Data array in which the new value is set (passed by reference)
         * @param string $flexpointer Flexform pointer, if in a flex form field.
         * @return string Error message if any, otherwise FALSE = OK
-        * @todo Define visibility
         */
        public function setReferenceValue_softreferences($refRec, $softref, $newValue, &$dataArray, $flexpointer = '') {
                if (is_array($softref['keys'][$refRec['softref_key']][$refRec['softref_id']])) {
@@ -870,7 +856,6 @@ class ReferenceIndex {
         *
         * @param array $conf Config array for TCA/columns field
         * @return boolean TRUE if DB reference field (group/db or select with foreign-table)
-        * @todo Define visibility
         */
        public function isReferenceField($conf) {
                return (
@@ -887,7 +872,6 @@ class ReferenceIndex {
         *
         * @param string $folder Folder relative to PATH_site
         * @return string Input folder prefixed with PATH_site. No checking for existence is done. Output must be a folder without trailing slash.
-        * @todo Define visibility
         */
        public function destPathFromUploadFolder($folder) {
                if (!$folder) {
@@ -901,7 +885,6 @@ class ReferenceIndex {
         *
         * @param string $msg Error message
         * @return void
-        * @todo Define visibility
         */
        public function error($msg) {
                $this->errorLog[] = $msg;
index 415d868..132f348 100644 (file)
@@ -74,19 +74,18 @@ class SoftReferenceIndex {
 
        // External configuration
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $fileAdminDir = '';
 
        // Internal:
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $tokenID_basePrefix = '';
 
        /**
         * Class construct to set global variable
-        *
         */
        public function __construct() {
                $this->fileAdminDir = !empty($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir']) ? rtrim($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '/') : 'fileadmin';
@@ -103,7 +102,6 @@ class SoftReferenceIndex {
         * @param array $spParams Parameters of the softlink parser. Basically this is the content inside optional []-brackets after the softref keys. Parameters are exploded by ";
         * @param string $structurePath If running from inside a FlexForm structure, this is the path of the tag.
         * @return array Result array on positive matches, see description above. Otherwise FALSE
-        * @todo Define visibility
         */
        public function findRef($table, $field, $uid, $content, $spKey, $spParams, $structurePath = '') {
                $retVal = FALSE;
@@ -176,7 +174,6 @@ class SoftReferenceIndex {
         * @param string $content The input content to analyse
         * @param array $spParams Parameters set for the softref parser key in TCA/columns
         * @return array Result array on positive matches, see description above. Otherwise FALSE
-        * @todo Define visibility
         */
        public function findRef_images($content, $spParams) {
                // Start HTML parser and split content by image tag:
@@ -239,7 +236,6 @@ class SoftReferenceIndex {
         * @param array $spParams Parameters set for the softref parser key in TCA/columns. value "linkList" will split the string by comma before processing.
         * @return array Result array on positive matches, see description above. Otherwise FALSE
         * @see tslib_content::typolink(), getTypoLinkParts()
-        * @todo Define visibility
         */
        public function findRef_typolink($content, $spParams) {
                // First, split the input string by a comma if the "linkList" parameter is set.
@@ -275,7 +271,6 @@ class SoftReferenceIndex {
         * @param array $spParams Parameters set for the softref parser key in TCA/columns
         * @return array Result array on positive matches, see description above. Otherwise FALSE
         * @see tslib_content::typolink(), getTypoLinkParts()
-        * @todo Define visibility
         */
        public function findRef_typolink_tag($content, $spParams) {
                // Parse string for special TYPO3 <link> tag:
@@ -307,7 +302,6 @@ class SoftReferenceIndex {
         * @param string $content The input content to analyse
         * @param array $spParams Parameters set for the softref parser key in TCA/columns
         * @return array Result array on positive matches, see description above. Otherwise FALSE
-        * @todo Define visibility
         */
        public function findRef_TStemplate($content, $spParams) {
                $elements = array();
@@ -381,7 +375,6 @@ class SoftReferenceIndex {
         * @param string $content The input content to analyse
         * @param array $spParams Parameters set for the softref parser key in TCA/columns
         * @return array Result array on positive matches, see description above. Otherwise FALSE
-        * @todo Define visibility
         */
        public function findRef_TSconfig($content, $spParams) {
                $elements = array();
@@ -403,7 +396,6 @@ class SoftReferenceIndex {
         * @param string $content The input content to analyse
         * @param array $spParams Parameters set for the softref parser key in TCA/columns
         * @return array Result array on positive matches, see description above. Otherwise FALSE
-        * @todo Define visibility
         */
        public function findRef_email($content, $spParams) {
                $resultArray = array();
@@ -440,7 +432,6 @@ class SoftReferenceIndex {
         * @param string $content The input content to analyse
         * @param array $spParams Parameters set for the softref parser key in TCA/columns
         * @return array Result array on positive matches, see description above. Otherwise FALSE
-        * @todo Define visibility
         */
        public function findRef_url($content, $spParams) {
                $resultArray = array();
@@ -480,7 +471,6 @@ class SoftReferenceIndex {
         * @param string $content The input content to analyse
         * @param array $spParams Parameters set for the softref parser key in TCA/columns
         * @return array Result array on positive matches, see description above. Otherwise FALSE
-        * @todo Define visibility
         */
        public function findRef_extension_fileref($content, $spParams) {
                $resultArray = array();
@@ -515,7 +505,6 @@ class SoftReferenceIndex {
         * @param string $content Input content to analyse
         * @param array $elements Element array to be modified with new entries. Passed by reference.
         * @return string Output content, possibly with tokens inserted.
-        * @todo Define visibility
         */
        public function fileadminReferences($content, &$elements) {
                // Fileadmin files are found
@@ -555,7 +544,6 @@ class SoftReferenceIndex {
         * @param string $typolinkValue TypoLink value.
         * @return array Array with the properties of the input link specified. The key "LINK_TYPE" will reveal the type. If that is blank it could not be determined.
         * @see TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::typolink(), setTypoLinkPartsElement()
-        * @todo Define visibility
         */
        public function getTypoLinkParts($typolinkValue) {
                $finalTagParts = array();
@@ -682,7 +670,6 @@ class SoftReferenceIndex {
         * @param integer $idx Index value of the found element - user to make unique but stable tokenID
         * @return string The input content, possibly containing tokens now according to the added substitution entries in $elements
         * @see getTypoLinkParts()
-        * @todo Define visibility
         */
        public function setTypoLinkPartsElement($tLP, &$elements, $content, $idx) {
                // Initialize, set basic values. In any case a link will be shown
@@ -819,7 +806,6 @@ class SoftReferenceIndex {
         *
         * @param integer $link_param Page alias string value
         * @return integer Page uid corresponding to alias value.
-        * @todo Define visibility
         */
        public function getPageIdFromAlias($link_param) {
                $pRec = \TYPO3\CMS\Backend\Utility\BackendUtility::getRecordsByField('pages', 'alias', $link_param);
@@ -831,7 +817,6 @@ class SoftReferenceIndex {
         *
         * @param string $index Suffix value.
         * @return string Token ID
-        * @todo Define visibility
         */
        public function makeTokenID($index = '') {
                return md5($this->tokenID_basePrefix . ':' . $index);
index 49538fb..5a47558 100644 (file)
@@ -314,7 +314,6 @@ class HtmlParser {
         * @param boolean $eliminateExtraEndTags If set, excessive end tags are ignored - you should probably set this in most cases.
         * @return array Even numbers in the array are outside the blocks, Odd numbers are block-content.
         * @see splitTags(), getAllParts(), removeFirstAndLastTag()
-        * @todo Define visibility
         */
        public function splitIntoBlock($tag, $content, $eliminateExtraEndTags = FALSE) {
                $tags = array_unique(GeneralUtility::trimExplode(',', $tag, TRUE));
@@ -385,7 +384,6 @@ class HtmlParser {
         * @param integer $level Indent level
         * @return string Processed content
         * @see splitIntoBlock()
-        * @todo Define visibility
         */
        public function splitIntoBlockRecursiveProc($tag, $content, &$procObj, $callBackContent, $callBackTags, $level = 0) {
                $parts = $this->splitIntoBlock($tag, $content, TRUE);
@@ -420,7 +418,6 @@ class HtmlParser {
         * @param string $content HTML-content
         * @return array Even numbers in the array are outside the blocks, Odd numbers are block-content.
         * @see splitIntoBlock(), getAllParts(), removeFirstAndLastTag()
-        * @todo Define visibility
         */
        public function splitTags($tag, $content) {
                $tags = GeneralUtility::trimExplode(',', $tag, TRUE);
@@ -456,7 +453,6 @@ class HtmlParser {
         * @param boolean $include_tag Whether to include the tags in the tag-parts (most useful for input made by ->splitIntoBlock())
         * @return array Tag-parts/Non-tag-parts depending on input argument settings
         * @see splitIntoBlock(), splitTags()
-        * @todo Define visibility
         */
        public function getAllParts($parts, $tag_parts = TRUE, $include_tag = TRUE) {
                $newParts = array();
@@ -477,7 +473,6 @@ class HtmlParser {
         *
         * @param string $str String to process
         * @return string
-        * @todo Define visibility
         */
        public function removeFirstAndLastTag($str) {
                // End of first tag:
@@ -494,7 +489,6 @@ class HtmlParser {
         *
         * @param string $str HTML string with tags
         * @return string
-        * @todo Define visibility
         */
        public function getFirstTag($str) {
                // First:
@@ -509,7 +503,6 @@ class HtmlParser {
         * @param boolean $preserveCase If set, then the tag is NOT converted to uppercase by case is preserved.
         * @return string Tag name in upper case
         * @see getFirstTag()
-        * @todo Define visibility
         */
        public function getFirstTagName($str, $preserveCase = FALSE) {
                $matches = array();
@@ -529,7 +522,6 @@ class HtmlParser {
         * @param string $tag Tag: $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
         * @param boolean $deHSC If set, the attribute values are de-htmlspecialchar'ed. Should actually always be set!
         * @return array array(Tag attributes,Attribute meta-data)
-        * @todo Define visibility
         */
        public function get_tag_attributes($tag, $deHSC = 0) {
                list($components, $metaC) = $this->split_tag_attributes($tag);
@@ -573,7 +565,6 @@ class HtmlParser {
         * @return array
         * @access private
         * @see \TYPO3\CMS\Core\Utility\GeneralUtility::split_tag_attributes()
-        * @todo Define visibility
         */
        public function split_tag_attributes($tag) {
                $matches = array();
@@ -611,7 +602,6 @@ class HtmlParser {
         * @param string $blockTags Tag names for block tags (eg. table or div or p) in lowercase, commalist (eg. "table,div,p")
         * @param string $soloTags Tag names for solo tags (eg. img, br or input) in lowercase, commalist ("img,br,input")
         * @return array Analyse data.
-        * @todo Define visibility
         */
        public function checkTagTypeCounts($content, $blockTags = 'a,b,blockquote,body,div,em,font,form,h1,h2,h3,h4,h5,h6,i,li,map,ol,option,p,pre,select,span,strong,table,td,textarea,tr,u,ul', $soloTags = 'br,hr,img,input,area') {
                $content = strtolower($content);
@@ -699,7 +689,6 @@ class HtmlParser {
         * @param integer $hSC Values -1,0,1,2: Set to zero= disabled, set to 1 then the content BETWEEN tags is htmlspecialchar()'ed, set to -1 its the opposite and set to 2 the content will be HSC'ed BUT with preservation for real entities (eg. "&amp;" or "&#234;")
         * @param array $addConfig Configuration array send along as $conf to the internal functions ->processContent() and ->processTag()
         * @return string Processed HTML content
-        * @todo Define visibility
         */
        public function HTMLcleaner($content, $tags = array(), $keepAll = 0, $hSC = 0, $addConfig = array()) {
                $newContent = array();
@@ -969,7 +958,6 @@ class HtmlParser {
         * @param string $value Input value
         * @param int $dir Direction: forth ($dir=1, dir=2 for preserving entities) AND back ($dir=-1)
         * @return string Output value
-        * @todo Define visibility
         */
        public function bidir_htmlspecialchars($value, $dir) {
                $dir = (int)$dir;
@@ -991,7 +979,6 @@ class HtmlParser {
         * @param array $alternatives Array with alternative prefixes for certain of the tags. key=>value pairs where the keys are the tag element names in uppercase
         * @param string $suffix Suffix string (put after the resource).
         * @return string Processed HTML content
-        * @todo Define visibility
         */
        public function prefixResourcePath($main_prefix, $content, $alternatives = array(), $suffix = '') {
                $parts = $this->splitTags('embed,td,table,body,img,input,form,link,script,a,param', $content);
@@ -1086,7 +1073,6 @@ class HtmlParser {
         * @param string $suffix Suffix string
         * @return string Output path, prefixed if no scheme in input string
         * @access private
-        * @todo Define visibility
         */
        public function prefixRelPath($prefix, $srcVal, $suffix = '') {
                // Only prefix if it's not an absolute URL or
@@ -1110,7 +1096,6 @@ class HtmlParser {
         * @param boolean If set, keep "size" attribute
         * @param boolean If set, keep "color" attribute
         * @return string Processed HTML content
-        * @todo Define visibility
         */
        public function cleanFontTags($value, $keepFace = 0, $keepSize = 0, $keepColor = 0) {
                // ,1 ?? - could probably be more stable if splitTags() was used since this depends on end-tags being properly set!
@@ -1148,7 +1133,6 @@ class HtmlParser {
         * @param string $ltChar Alternative less-than char to search for (search regex string)
         * @param string $ltChar2 Alternative less-than char to replace with (replace regex string)
         * @return string Processed HTML content
-        * @todo Define visibility
         */
        public function mapTags($value, $tags = array(), $ltChar = '<', $ltChar2 = '<') {
                foreach ($tags as $from => $to) {
@@ -1163,7 +1147,6 @@ class HtmlParser {
         * @param string $content HTML content
         * @param string $tagList Tag list, separated by comma. Lowercase!
         * @return string Processed HTML content
-        * @todo Define visibility
         */
        public function unprotectTags($content, $tagList = '') {
                $tagsArray = GeneralUtility::trimExplode(',', $tagList, TRUE);
@@ -1203,7 +1186,6 @@ class HtmlParser {
         * @param string $cacheKey Key string used for internal caching of the results. Could be an MD5 hash of the serialized version of the input $str if that is an array.
         * @return string Output string, processed
         * @access private
-        * @todo Define visibility
         */
        public function caseShift($str, $flag, $cacheKey = '') {
                $cacheKey .= $flag ? 1 : 0;
@@ -1235,7 +1217,6 @@ class HtmlParser {
         * @param boolean $xhtmlClean If set, then the attribute names will be set in lower case, value quotes in double-quotes and the value will be htmlspecialchar()'ed
         * @return string Imploded attributes, eg: 'attribute="value" attrib2="value2"'
         * @access private
-        * @todo Define visibility
         */
        public function compileTagAttribs($tagAttrib, $meta = array(), $xhtmlClean = 0) {
                $accu = array();
@@ -1264,7 +1245,6 @@ class HtmlParser {
         * @param boolean $deHSC De-htmlspecialchar flag.
         * @return array
         * @access private
-        * @todo Define visibility
         */
        public function get_tag_attributes_classic($tag, $deHSC = 0) {
                $attr = $this->get_tag_attributes($tag, $deHSC);
@@ -1278,7 +1258,6 @@ class HtmlParser {
         * @param integer $number Number of indents
         * @param string $indentChar Indent character/string
         * @return strin Indented code (typ. HTML)
-        * @todo Define visibility
         */
        public function indentLines($content, $number = 1, $indentChar = TAB) {
                $preTab = str_pad('', $number * strlen($indentChar), $indentChar);
@@ -1297,7 +1276,6 @@ class HtmlParser {
         * @param array $keepTags Array of tags to keep (?)
         * @return array
         * @access private
-        * @todo Define visibility
         */
        public function HTMLparserConfig($TSconfig, $keepTags = array()) {
                // Allow tags (base list, merged with incoming array)
@@ -1433,7 +1411,6 @@ class HtmlParser {
         * @param string $content Content to clean up
         * @return string Cleaned up content returned.
         * @access private
-        * @todo Define visibility
         */
        public function XHTML_clean($content) {
                $content = $this->HTMLcleaner($content, array(), 1, 0, array('xhtml' => 1));
@@ -1450,7 +1427,6 @@ class HtmlParser {
         * @param boolean If set, just return value straight away
         * @return string Processed value.
         * @access private
-        * @todo Define visibility
         */
        public function processTag($value, $conf, $endTag, $protected = 0) {
                // Return immediately if protected or no parameters
@@ -1506,7 +1482,6 @@ class HtmlParser {
         * @param mixed $conf Not used, ignore.
         * @return string The processed value.
         * @access private
-        * @todo Define visibility
         */
        public function processContent($value, $dir, $conf) {
                if ($dir != 0) {
index 030279a..a7af7d2 100644 (file)
@@ -27,7 +27,7 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
 
        // Static:
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $blockElementList = 'PRE,UL,OL,H1,H2,H3,H4,H5,H6,ADDRESS,DL,DD,HEADER,SECTION,FOOTER,NAV,ARTICLE,ASIDE';
 
@@ -35,25 +35,25 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
        // Internal, static:
        // Set this to the pid of the record manipulated by the class.
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $recPid = 0;
 
        // Element reference [table]:[field], eg. "tt_content:bodytext"
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $elRef = '';
 
        // Relative path
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $relPath = '';
 
        // Relative back-path
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $relBackPath = '';
 
@@ -62,38 +62,38 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
 
        // Set to the TSconfig options coming from Page TSconfig
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $procOptions = array();
 
        // Internal, dynamic
        // Run-away brake for recursive calls.
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $TS_transform_db_safecounter = 100;
 
        // Parameters from TCA types configuration related to the RTE
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $rte_p = '';
 
        // Data caching for processing function
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $getKeepTags_cache = array();
 
        // Storage of the allowed CSS class names in the RTE
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $allowedClasses = array();
 
        // Set to tags to preserve from Page TSconfig configuration
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $preserveTags = '';
 
@@ -103,7 +103,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $elRef Element reference, eg "tt_content:bodytext
         * @param integer $recPid PID of the record (page id)
         * @return void
-        * @todo Define visibility
         */
        public function init($elRef = '', $recPid = 0) {
                $this->recPid = $recPid;
@@ -116,7 +115,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @param string $path The relative path from PATH_site to the place where the file being edited is. Eg. "fileadmin/static".
         * @return void There is no output, it is set in internal variables. With the above example of "fileadmin/static" as input this will yield ->relPath to be "fileadmin/static/" and ->relBackPath to be "../../
-        * @todo Define visibility
         */
        public function setRelPath($path) {
                $path = trim($path);
@@ -187,7 +185,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string Direction of the transformation. Two keywords are allowed; "db" or "rte". If "db" it means the transformation will clean up content coming from the Rich Text Editor and goes into the database. The other direction, "rte", is of course when content is coming from database and must be transformed to fit the RTE.
         * @param array Parsed TypoScript content configuring the RTE, probably coming from Page TSconfig.
         * @return string Output value
-        * @todo Define visibility
         */
        public function RTE_transform($value, $specConf, $direction = 'rte', $thisConfig = array()) {
                // Init:
@@ -342,7 +339,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @param string $value The content from RTE going to Database
         * @return string Processed content
-        * @todo Define visibility
         */
        public function TS_images_db($value) {
                // Split content by <img> tags and traverse the resulting array for processing:
@@ -535,7 +531,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $value Content input
         * @param string $direction Direction of conversion; "rte" (from database to RTE) or "db" (from RTE to database)
         * @return string Content output
-        * @todo Define visibility
         */
        public function TS_reglinks($value, $direction) {
                $retVal = '';
@@ -572,7 +567,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $value Content input
         * @return string Content output
         * @see TS_links_rte()
-        * @todo Define visibility
         */
        public function TS_links_db($value) {
                $conf = array();
@@ -675,7 +669,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $value Content input
         * @return string Content output
         * @see TS_links_rte()
-        * @todo Define visibility
         */
        public function TS_links_rte($value) {
                $conf = array();
@@ -808,7 +801,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @param string $value Content input
         * @return string Content output
-        * @todo Define visibility
         */
        public function TS_preserve_db($value) {
                if (!$this->preserveTags) {
@@ -835,7 +827,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @param string $value Content input
         * @return string Content output
-        * @todo Define visibility
         */
        public function TS_preserve_rte($value) {
                if (!$this->preserveTags) {
@@ -859,7 +850,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param boolean $css If TRUE, the transformation was "css_transform", otherwise "ts_transform
         * @return string Content output
         * @see TS_transform_rte()
-        * @todo Define visibility
         */
        public function TS_transform_db($value, $css = FALSE) {
                // Safety... so forever loops are avoided (they should not occur, but an error would potentially do this...)
@@ -995,7 +985,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @param string $value Content input
         * @return string Content output
-        * @todo Define visibility
         */
        public function transformStyledATags($value) {
                $blockSplit = $this->splitIntoBlock('A', $value);
@@ -1024,7 +1013,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param boolean If TRUE, the transformation was "css_transform", otherwise "ts_transform
         * @return string Content output
         * @see TS_transform_db()
-        * @todo Define visibility
         */
        public function TS_transform_rte($value, $css = 0) {
                // Split the content from database by the occurence of the block elements
@@ -1116,7 +1104,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @param string $value Content input
         * @return string Content output
-        * @todo Define visibility
         */
        public function TS_strip_db($value) {
                $value = strip_tags($value, '<' . implode('><', explode(',', 'b,i,u,a,img,br,div,center,pre,font,hr,sub,sup,p,strong,em,li,ul,ol,blockquote')) . '>');
@@ -1134,7 +1121,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $url Filepath/URL to read
         * @return string The content from the resource given as input.
         * @see \TYPO3\CMS\Core\Utility\GeneralUtility::getUrl()
-        * @todo Define visibility
         */
        public function getUrl($url) {
                return GeneralUtility::getUrl($url);
@@ -1149,7 +1135,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $tagList Comma list of tags to specifically allow. Default comes from getKeepTags and is
         * @return string Clean content
         * @see getKeepTags()
-        * @todo Define visibility
         */
        public function HTMLcleaner_db($content, $tagList = '') {
                if (!$tagList) {
@@ -1177,7 +1162,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $tagList Comma list of tags to keep (overriding default which is to keep all + take notice of internal configuration)
         * @return array Configuration array
         * @see HTMLcleaner_db()
-        * @todo Define visibility
         */
        public function getKeepTags($direction = 'rte', $tagList = '') {
                if (!is_array($this->getKeepTags_cache[$direction]) || $tagList) {
@@ -1295,7 +1279,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param boolean $returnArray If TRUE, an array with the lines is returned, otherwise a string of the processed input value.
         * @return string Processed input value.
         * @see setDivTags()
-        * @todo Define visibility
         */
        public function divideIntoLines($value, $count = 5, $returnArray = FALSE) {
                // Internalize font tags (move them from OUTSIDE p/div to inside it that is the case):
@@ -1424,7 +1407,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $dT Tag to wrap with. Either "p" or "div" should it be. Lowercase preferably.
         * @return string Processed value.
         * @see divideIntoLines()
-        * @todo Define visibility
         */
        public function setDivTags($value, $dT = 'p') {
                // First, setting configuration for the HTMLcleaner function. This will process each line between the <div>/<p> section on their way to the RTE
@@ -1473,7 +1455,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string Input content
         * @return string Output content
         * @see divideIntoLines()
-        * @todo Define visibility
         */
        public function internalizeFontTags($value) {
                // Splitting into font tag blocks:
@@ -1513,7 +1494,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @return string Value of GeneralUtility::getIndpEnv('TYPO3_SITE_URL');
         * @see \TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv()
-        * @todo Define visibility
         */
        public function siteUrl() {
                return GeneralUtility::getIndpEnv('TYPO3_SITE_URL');
@@ -1537,7 +1517,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $value Input value
         * @param string $breakChar Break character to use for linebreaks.
         * @return string Output value
-        * @todo Define visibility
         */
        public function removeTables($value, $breakChar = '<br />') {
                // Splitting value into table blocks:
@@ -1567,7 +1546,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $code Input code to process
         * @param string $direction Direction To databsae (db) or from database to RTE (rte)
         * @return string Processed value
-        * @todo Define visibility
         */
        public function defaultTStagMapping($code, $direction = 'rte') {
                if ($direction == 'db') {
@@ -1593,7 +1571,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @param array $attribArray Array of attributes from tag in which to search. More specifically the content of the key "style" is used to extract "width:xxx / height:xxx" information
         * @return array Integer w/h in key 0/1. Zero is returned if not found.
-        * @todo Define visibility
         */
        public function getWHFromAttribs($attribArray) {
                $style = trim($attribArray['style']);
@@ -1621,7 +1598,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         *
         * @param string $url URL to analyse.
         * @return array Information in an array about the URL
-        * @todo Define visibility
         */
        public function urlInfoForLinkTags($url) {
                $info = array();
@@ -1685,7 +1661,6 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
         * @param string $value Content input
         * @param boolean $dontSetRTEKEEP If TRUE, then the "rtekeep" attribute will not be set.
         * @return string Content output
-        * @todo Define visibility
         */
        public function TS_AtagToAbs($value, $dontSetRTEKEEP = FALSE) {
                $blockSplit = $this->splitIntoBlock('A', $value);
index f642f2f..6e50876 100644 (file)
@@ -31,25 +31,25 @@ class GraphicalFunctions {
 
        // If set, there is no frame pointer prepended to the filenames.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $noFramePrepended = 0;
 
        // This should be changed to 'png' if you want this class to read/make PNG-files instead!
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $gifExtension = 'gif';
 
        // File formats supported by gdlib. This variable get's filled in "init" method
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $gdlibExtensions = '';
 
        // Set to TRUE if generated png's should be truecolor by default
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $png_truecolor = FALSE;
 
@@ -96,35 +96,35 @@ class GraphicalFunctions {
 
        // 16777216 Colors is the maximum value for PNG, JPEG truecolor images (24-bit, 8-bit / Channel)
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $truecolorColors = 16777215;
 
        // If set, then all files in typo3temp will be logged in a database table. In addition to being a log of the files with original filenames, it also serves to secure that the same image is not rendered simultaneously by two different processes.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $enable_typo3temp_db_tracking = 0;
 
        // Commalist of file extensions perceived as images by TYPO3. List should be set to 'gif,png,jpeg,jpg' if IM is not available. Lowercase and no spaces between!
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $imageFileExt = 'gif,jpg,jpeg,png,tif,bmp,tga,pcx,ai,pdf';
 
        // Commalist of web image extensions (can be shown by a webbrowser)
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $webImageExt = 'gif,jpg,jpeg,png';
 
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $NO_IM_EFFECTS = '';
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $cmds = array(
                'jpg' => '',
@@ -134,66 +134,66 @@ class GraphicalFunctions {
        );
 
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $NO_IMAGE_MAGICK = '';
 
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $V5_EFFECTS = 0;
 
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $mayScaleUp = 1;
 
        // Variables for testing, alternative usage etc.
        // Filename prefix for images scaled in imageMagickConvert()
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $filenamePrefix = '';
 
        // Forcing the output filename of imageMagickConvert() to this value. However after calling imageMagickConvert() it will be set blank again.
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $imageMagickConvert_forceFileNameBody = '';
 
        // This flag should always be FALSE. If set TRUE, imageMagickConvert will always write a new file to the tempdir! Used for debugging.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $dontCheckForExistingTempFile = 0;
 
        // Prevents imageMagickConvert() from compressing the gif-files with \TYPO3\CMS\Core\Utility\GeneralUtility::gif_compress()
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $dontCompress = 0;
 
        // For debugging ONLY!
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $dontUnlinkTempFiles = 0;
 
        // For debugging only. Filenames will not be based on mtime and only filename (not path) will be used. This key is also included in the hash of the filename...
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $alternativeOutputKey = '';
 
        // Internal:
        // All ImageMagick commands executed is stored in this array for tracking. Used by the Install Tools Image section
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $IM_commands = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $workArea = array();
 
@@ -207,43 +207,43 @@ class GraphicalFunctions {
        // Constants:
        // The temp-directory where to store the files. Normally relative to PATH_site but is allowed to be the absolute path AS LONG AS it is a subdir to PATH_site.
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $tempPath = 'typo3temp/';
 
        // Prefix for relative paths. Used in "show_item.php" script. Is prefixed the output file name IN imageMagickConvert()
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $absPrefix = '';
 
        // ImageMagick scaling command; "-geometry" eller "-sample". Used in makeText() and imageMagickConvert()
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $scalecmd = '-geometry';
 
        // Used by v5_blur() to simulate 10 continuous steps of blurring
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $im5fx_blurSteps = '1x2,2x2,3x2,4x3,5x3,5x4,6x4,7x5,8x5,9x5';
 
        // Used by v5_sharpen() to simulate 10 continuous steps of sharpening.
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $im5fx_sharpenSteps = '1x2,2x2,3x2,2x3,3x3,4x3,3x4,4x4,4x5,5x5';
 
        // This is the limit for the number of pixels in an image before it will be rendered as JPG instead of GIF/PNG
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $pixelLimitGif = 10000;
 
        // Array mapping HTML color names to RGB values.
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $colMap = array(
                'aqua' => array(0, 255, 255),
@@ -268,13 +268,12 @@ class GraphicalFunctions {
         * Charset conversion object:
         *
         * @var \TYPO3\CMS\Core\Charset\CharsetConverter
-        * @todo Define visibility
         */
        public $csConvObj;
 
        // Is set to the native character set of the input strings.
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $nativeCharset = '';
 
@@ -283,7 +282,6 @@ class GraphicalFunctions {
         * This function will read the configuration information from $GLOBALS['TYPO3_CONF_VARS']['GFX'] can set some values in internal variables.
         *
         * @return void
-        * @todo Define visibility
         */
        public function init() {
                $gfxConf = $GLOBALS['TYPO3_CONF_VARS']['GFX'];
@@ -374,7 +372,6 @@ class GraphicalFunctions {
         * @param array $workArea The current working area coordinates.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make()
-        * @todo Define visibility
         */
        public function maskImageOntoImage(&$im, $conf, $workArea) {
                if ($conf['file'] && $conf['mask']) {
@@ -461,7 +458,6 @@ class GraphicalFunctions {
         * @param array $workArea The current working area coordinates.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make(), maskImageOntoImage()
-        * @todo Define visibility
         */
        public function copyImageOntoImage(&$im, $conf, $workArea) {
                if ($conf['file']) {
@@ -484,7 +480,6 @@ class GraphicalFunctions {
         * @param array $workArea Work area
         * @return void Works on the $im image pointer
         * @access private
-        * @todo Define visibility
         */
        public function copyGifOntoGif(&$im, $cpImg, $conf, $workArea) {
                $cpW = imagesx($cpImg);
@@ -565,7 +560,6 @@ class GraphicalFunctions {
         * @return void
         * @access private
         * @see \TYPO3\CMS\Backend\Utility\IconUtility::imagecopyresized()
-        * @todo Define visibility
         */
        public function imagecopyresized(&$dstImg, $srcImg, $dstX, $dstY, $srcX, $srcY, $dstWidth, $dstHeight, $srcWidth, $srcHeight) {
                if (!$this->saveAlphaLayer) {
@@ -595,7 +589,6 @@ class GraphicalFunctions {
         * @param array $workArea The current working area coordinates.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make()
-        * @todo Define visibility
         */
        public function makeText(&$im, $conf, $workArea) {
                // Spacing
@@ -700,7 +693,6 @@ class GraphicalFunctions {
         * @return array [0]=x, [1]=y, [2]=w, [3]=h
         * @access private
         * @see makeText()
-        * @todo Define visibility
         */
        public function txtPosition($conf, $workArea, $BB) {
                $angle = (int)$conf['angle'] / 180 * pi();
@@ -751,7 +743,6 @@ class GraphicalFunctions {
         * @return array Array with three keys [0]/[1] being x/y and [2] being the bounding box array
         * @access private
         * @see txtPosition(), \TYPO3\CMS\Frontend\Imaging\GifBuilder::start()
-        * @todo Define visibility
         */
        public function calcBBox($conf) {
                $sF = $this->getTextScalFactor($conf);
@@ -831,7 +822,6 @@ class GraphicalFunctions {
         * @return void
         * @access private
         * @see makeText(), calcTextCordsForMap()
-        * @todo Define visibility
         */
        public function addToMap($cords, $conf) {
                $this->map .= '<area' . ' shape="poly"' . ' coords="' . implode(',', $cords) . '"' . ' href="' . htmlspecialchars($conf['url']) . '"' . ($conf['target'] ? ' target="' . htmlspecialchars($conf['target']) . '"' : '') . $JS . (strlen($conf['titleText']) ? ' title="' . htmlspecialchars($conf['titleText']) . '"' : '') . ' alt="' . htmlspecialchars($conf['altText']) . '" />';
@@ -846,7 +836,6 @@ class GraphicalFunctions {
         * @return array
         * @access private
         * @see makeText(), calcTextCordsForMap()
-        * @todo Define visibility
         */
        public function calcTextCordsForMap($cords, $offset, $conf) {
                $pars = GeneralUtility::intExplode(',', $conf['explode'] . ',');
@@ -880,7 +869,6 @@ class GraphicalFunctions {
         * @param integer $sF Scale factor
         * @return void
         * @access private
-        * @todo Define visibility
         */
        public function SpacedImageTTFText(&$im, $fontSize, $angle, $x, $y, $Fcolor, $fontFile, $text, $spacing, $wordSpacing, $splitRenderingConf, $sF = 1) {
                $spacing *= $sF;
@@ -913,7 +901,6 @@ class GraphicalFunctions {
         * @return integer The new fontSize
         * @access private
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::start()
-        * @todo Define visibility
         */
        public function fontResize($conf) {
                // You have to use +calc options like [10.h] in 'offset' to get the right position of your text-image, if you use +calc in XY height!!!!
@@ -956,7 +943,6 @@ class GraphicalFunctions {
         * @param array $splitRendering Split-rendering configuration
         * @param integer $sF Scale factor
         * @return array Information array.
-        * @todo Define visibility
         */
        public function ImageTTFBBoxWrapper($fontSize, $angle, $fontFile, $string, $splitRendering, $sF = 1) {
                // Initialize:
@@ -1008,7 +994,6 @@ class GraphicalFunctions {
         * @param array $splitRendering Split-rendering configuration
         * @param integer $sF Scale factor
         * @return void
-        * @todo Define visibility
         */
        public function ImageTTFTextWrapper($im, $fontSize, $angle, $x, $y, $color, $fontFile, $string, $splitRendering, $sF = 1) {
                // Initialize:
@@ -1052,7 +1037,6 @@ class GraphicalFunctions {
         * @param integer $fontSize Current fontsize
         * @param string $fontFile Current font file
         * @return array Array with input string splitted according to configuration
-        * @todo Define visibility
         */
        public function splitString($string, $splitRendering, $fontSize, $fontFile) {
                // Initialize by setting the whole string and default configuration as the first entry.
@@ -1190,7 +1174,6 @@ class GraphicalFunctions {
         * @return array Array with two keys [0]/[1] being array($spacing,$wordSpacing)
         * @access private
         * @see calcBBox()
-        * @todo Define visibility
         */
        public function calcWordSpacing($conf, $scaleFactor = 1) {
                $spacing = (int)$conf['spacing'];
@@ -1207,7 +1190,6 @@ class GraphicalFunctions {
         * @param array $conf TypoScript array for the TEXT GIFBUILDER object
         * @return integer TypoScript value from eg $conf['niceText.']['scaleFactor']
         * @access private
-        * @todo Define visibility
         */
        public function getTextScalFactor($conf) {
                if (!$conf['niceText']) {
@@ -1336,7 +1318,6 @@ class GraphicalFunctions {
         * @param array $txtConf TypoScript array with configuration for the associated TEXT GIFBUILDER object.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make(), makeText()
-        * @todo Define visibility
         */
        public function makeOutline(&$im, $conf, $workArea, $txtConf) {
                $thickness = (int)$conf['thickness'];
@@ -1366,7 +1347,6 @@ class GraphicalFunctions {
         * @param integer $iterations Iterations.
         * @return array
         * @see makeOutline()
-        * @todo Define visibility
         */
        public function circleOffset($distance, $iterations) {
                $res = array();
@@ -1395,7 +1375,6 @@ class GraphicalFunctions {
         * @param array $txtConf TypoScript array with configuration for the associated TEXT GIFBUILDER object.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make(), makeShadow()
-        * @todo Define visibility
         */
        public function makeEmboss(&$im, $conf, $workArea, $txtConf) {
                $conf['color'] = $conf['highColor'];
@@ -1418,7 +1397,6 @@ class GraphicalFunctions {
         * @param array $txtConf TypoScript array with configuration for the associated TEXT GIFBUILDER object.
         * @retur void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make(), makeText(), makeEmboss()
-        * @todo Define visibility
         */
        public function makeShadow(&$im, $conf, $workArea, $txtConf) {
                $workArea = $this->applyOffset($workArea, GeneralUtility::intExplode(',', $conf['offset']));
@@ -1533,7 +1511,6 @@ class GraphicalFunctions {
         * @param array $workArea The current working area coordinates.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make()
-        * @todo Define visibility
         */
        public function makeBox(&$im, $conf, $workArea) {
                $cords = GeneralUtility::intExplode(',', $conf['dimensions'] . ',,,');
@@ -1593,7 +1570,6 @@ class GraphicalFunctions {
         * @param array $conf TypoScript array with configuration for the GIFBUILDER object.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make(), applyImageMagickToPHPGif()
-        * @todo Define visibility
         */
        public function makeEffect(&$im, $conf) {
                $commands = $this->IMparams($conf['value']);
@@ -1609,7 +1585,6 @@ class GraphicalFunctions {
         * @return string ImageMagick prepared parameters.
         * @access private
         * @see makeEffect()
-        * @todo Define visibility
         */
        public function IMparams($setup) {
                if (!trim($setup)) {
@@ -1695,7 +1670,6 @@ class GraphicalFunctions {
         * @param array $conf TypoScript array with configuration for the GIFBUILDER object.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make(), autoLevels(), outputLevels(), inputLevels()
-        * @todo Define visibility
         */
        public function adjust(&$im, $conf) {
                $setup = $conf['value'];
@@ -1731,7 +1705,6 @@ class GraphicalFunctions {
         * @param array $conf TypoScript array with configuration for the GIFBUILDER object.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make()
-        * @todo Define visibility
         */
        public function crop(&$im, $conf) {
                // Clears workArea to total image
@@ -1770,7 +1743,6 @@ class GraphicalFunctions {
         * @param array $conf TypoScript array with configuration for the GIFBUILDER object.
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make()
-        * @todo Define visibility
         */
        public function scale(&$im, $conf) {
                if ($conf['width'] || $conf['height'] || $conf['params']) {
@@ -1804,7 +1776,6 @@ class GraphicalFunctions {
         * @return void
         * @access private
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::make()
-        * @todo Define visibility
         */
        public function setWorkArea($workArea) {
                $this->workArea = GeneralUtility::intExplode(',', $workArea);
@@ -1827,7 +1798,6 @@ class GraphicalFunctions {
         *
         * @param integer $im GDlib Image Pointer
         * @return void
-        * @todo Define visibility
         */
        public function autolevels(&$im) {
                $totalCols = ImageColorsTotal($im);
@@ -1859,7 +1829,6 @@ class GraphicalFunctions {
         * @param integer $high The "high" value (close to 255)
         * @param boolean $swap If swap, then low and high are swapped. (Useful for negated masks...)
         * @return void
-        * @todo Define visibility
         */
        public function outputLevels(&$im, $low, $high, $swap = '') {
                if ($low < $high) {
@@ -1890,7 +1859,6 @@ class GraphicalFunctions {
         * @param integer $high The "high" value (close to 255)
         * @param boolean $swap @deprecated since 6.2, unused and obsolete parameter, was used for older image magick versions
         * @return void
-        * @todo Define visibility
         */
        public function inputLevels(&$im, $low, $high, $swap = '') {
                if ($low < $high) {
@@ -1914,7 +1882,6 @@ class GraphicalFunctions {
         * @param string $file Image file to reduce
         * @param integer $cols Number of colors to reduce the image to.
         * @return string Reduced file
-        * @todo Define visibility
         */
        public function IMreduceColors($file, $cols) {
                $fI = GeneralUtility::split_fileref($file);
@@ -1948,7 +1915,6 @@ class GraphicalFunctions {
         *
         * @param string $fontFile The font file
         * @return string The font file with absolute path.
-        * @todo Define visibility
         */
        public function prependAbsolutePath($fontFile) {
                $absPath = defined('PATH_typo3') ? dirname(PATH_thisScript) . '/' : PATH_site;
@@ -1963,7 +1929,6 @@ class GraphicalFunctions {
         * @param integer $factor The sharpening factor, 0-100 (effectively in 10 steps)
         * @return string The sharpening command, eg. " -sharpen 3x4
         * @see makeText(), IMparams(), v5_blur()
-        * @todo Define visibility
         */
        public function v5_sharpen($factor) {
                $factor = MathUtility::forceIntegerInRange(ceil($factor / 10), 0, 10);
@@ -1982,7 +1947,6 @@ class GraphicalFunctions {
         * @param integer $factor The blurring factor, 0-100 (effectively in 10 steps)
         * @return string The blurring command, eg. " -blur 3x4
         * @see makeText(), IMparams(), v5_sharpen()
-        * @todo Define visibility
         */
        public function v5_blur($factor) {
                $factor = MathUtility::forceIntegerInRange(ceil($factor / 10), 0, 10);
@@ -1999,7 +1963,6 @@ class GraphicalFunctions {
         * Used by functions in this class to create truely temporary files for the on-the-fly processing. These files will most likely be deleted right away.
         *
         * @return string
-        * @todo Define visibility
         */
        public function randomName() {
                $this->createTempSubDir('temp/');
@@ -2013,7 +1976,6 @@ class GraphicalFunctions {
         * @param array $cords Integer coordinates in key 0/1
         * @param array $OFFSET Offset values in key 0/1
         * @return array Modified $cords array
-        * @todo Define visibility
         */
        public function applyOffset($cords, $OFFSET) {
                $cords[0] = (int)$cords[0] + (int)$OFFSET[0];
@@ -2027,7 +1989,6 @@ class GraphicalFunctions {
         *
         * @param string $string "HTML-color" data type string, eg. 'red', '#ffeedd' or '255,0,255'. You can also add a modifying operator afterwards. There are two options: "255,0,255 : 20" - will add 20 to values, result is "255,20,255". Or "255,0,255 : *1.23" which will multiply all RGB values with 1.23
         * @return array RGB values in key 0/1/2 of the array
-        * @todo Define visibility
         */
        public function convertColor($string) {
                $col = array();
@@ -2077,7 +2038,6 @@ class GraphicalFunctions {
         *
         * @param string The text to recode
         * @return string The recoded string. Should be UTF-8 output. MAY contain entities (eg. &#123; or &#quot; which should render as real chars).
-        * @todo Define visibility
         */
        public function recodeString($string) {
                // Recode string to UTF-8 from $this->nativeCharset:
@@ -2095,7 +2055,6 @@ class GraphicalFunctions {
         * @param string $theText The text string to split
         * @param boolean $returnUnicodeNumber Return Unicode numbers instead of chars.
         * @return array Numerical array with a char as each value.
-        * @todo Define visibility
         */
        public function singleChars($theText, $returnUnicodeNumber = FALSE) {
                if ($this->nativeCharset) {
@@ -2120,7 +2079,6 @@ class GraphicalFunctions {
         * @return array [0]=x, [1]=y, [2]=w, [3]=h
         * @access private
         * @see copyGifOntoGif(), makeBox(), crop()
-        * @todo Define visibility
         */
        public function objPosition($conf, $workArea, $BB) {
                // offset, align, valign, workarea
@@ -2176,7 +2134,6 @@ class GraphicalFunctions {
         * @param boolean $mustCreate If set, then another image than the input imagefile MUST be returned. Otherwise you can risk that the input image is good enough regarding messures etc and is of course not rendered to a new, temporary file in typo3temp/. But this option will force it to.
         * @return array [0]/[1] is w/h, [2] is file extension and [3] is the filename.
         * @see getImageScale(), typo3/show_item.php, fileList_ext::renderImage(), \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getImgResource(), SC_tslib_showpic::show(), maskImageOntoImage(), copyImageOntoImage(), scale()
-        * @todo Define visibility
         */
        public function imageMagickConvert($imagefile, $newExt = '', $w = '', $h = '', $params = '', $frame = '', $options = array(), $mustCreate = FALSE) {
                if ($this->NO_IMAGE_MAGICK) {
@@ -2284,7 +2241,6 @@ class GraphicalFunctions {
         * @param string $imageFile The image filepath
         * @return array|NULL Returns an array where [0]/[1] is w/h, [2] is extension and [3] is the filename.
         * @see imageMagickConvert(), \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getImgResource()
-        * @todo Define visibility
         */
        public function getImageDimensions($imageFile) {
                preg_match('/([^\\.]*)$/', $imageFile, $reg);
@@ -2312,7 +2268,6 @@ class GraphicalFunctions {
         *
         * @param array $identifyResult Result of the getImageDimensions function
         * @return boolean TRUE if operation was successful
-        * @todo Define visibility
         */
        public function cacheImageDimensions($identifyResult) {
                // Create md5 hash of filemtime and filesize
@@ -2341,7 +2296,6 @@ class GraphicalFunctions {
         *
         * @param string $imageFile The image filepath
         * @return array Returns an array where [0]/[1] is w/h, [2] is extension and [3] is the filename.
-        * @todo Define visibility
         */
        public function getCachedImageDimensions($imageFile) {
                // Create md5 hash of filemtime and filesize
@@ -2376,7 +2330,6 @@ class GraphicalFunctions {
         * @return array
         * @access private
         * @see imageMagickConvert()
-        * @todo Define visibility
         */
        public function getImageScale($info, $w, $h, $options) {
                if (strstr($w . $h, 'm')) {
@@ -2495,7 +2448,6 @@ class GraphicalFunctions {
         * @param string $orig Original basis file
         * @return boolean Returns TRUE if the file is already being made; thus "TRUE" means "Don't render the image again
         * @access private
-        * @todo Define visibility
         */
        public function file_exists_typo3temp_file($output, $orig = '') {
                if ($this->enable_typo3temp_db_tracking) {
@@ -2550,7 +2502,6 @@ class GraphicalFunctions {
         *
         * @param string $imagefile The relative (to PATH_site) image filepath
         * @return array
-        * @todo Define visibility
         */
        public function imageMagickIdentify($imagefile) {
                if (!$this->NO_IMAGE_MAGICK) {
@@ -2589,7 +2540,6 @@ class GraphicalFunctions {
         * @param string $params ImageMagick parameters
         * @param integer $frame Optional, refers to which frame-number to select in the image. '' or 0
         * @return string The result of a call to PHP function "exec()
-        * @todo Define visibility
         */
        public function imageMagickExec($input, $output, $params, $frame = 0) {
                if (!$this->NO_IMAGE_MAGICK) {
@@ -2619,7 +2569,6 @@ class GraphicalFunctions {
         * @param string $output The relative (to PATH_site) image filepath, output filename (written to)
         * @param boolean $handleNegation
         * @return      void
-        * @todo Define visibility
         */
        public function combineExec($input, $overlay, $mask, $output, $handleNegation = FALSE) {
                if (!$this->NO_IMAGE_MAGICK) {
@@ -2667,7 +2616,6 @@ class GraphicalFunctions {
         *
         * @param string $file Input file to check
         * @return string Returns the filename if the file existed, otherwise empty.
-        * @todo Define visibility
         */
        public function checkFile($file) {
                if (@is_file($file)) {
@@ -2682,7 +2630,6 @@ class GraphicalFunctions {
         *
         * @param string $dirName Name of sub directory
         * @return boolean Result of \TYPO3\CMS\Core\Utility\GeneralUtility::mkdir(), TRUE if it went well.
-        * @todo Define visibility
         */
        public function createTempSubDir($dirName) {
                // Checking if the this->tempPath is already prefixed with PATH_site and if not, prefix it with that constant.
@@ -2703,7 +2650,6 @@ class GraphicalFunctions {
         * @param pointer $im The image pointer (reference)
         * @param string $command The ImageMagick parameters. Like effects, scaling etc.
         * @return void
-        * @todo Define visibility
         */
        public function applyImageMagickToPHPGif(&$im, $command) {
                $tmpStr = $this->randomName();
@@ -2730,7 +2676,6 @@ class GraphicalFunctions {
         * @param integer $w The width of the output image.
         * @param integer $h The height of the output image.
         * @return string The filename, either "jpg" or "gif"/"png" (whatever $this->gifExtension is set to.)
-        * @todo Define visibility
         */
        public function gif_or_jpg($type, $w, $h) {
                if ($type == 'ai' || $w * $h < $this->pixelLimitGif) {
@@ -2748,7 +2693,6 @@ class GraphicalFunctions {
         * @param string $file The filename to write to.
         * @return string Returns input filename
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::gifBuild()
-        * @todo Define visibility
         */
        public function output($file) {
                if ($file) {
@@ -2796,7 +2740,6 @@ class GraphicalFunctions {
         *
         * @return void
         * @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::gifBuild()
-        * @todo Define visibility
         */
        public function destroy() {
                ImageDestroy($this->im);
@@ -2807,7 +2750,6 @@ class GraphicalFunctions {
         *
         * @param array $imgInfo Image information array, key 0/1 is width/height and key 3 is the src value
         * @return string Image tag for the input image information array.
-        * @todo Define visibility
         */
        public function imgTag($imgInfo) {
                return '<img src="' . $imgInfo[3] . '" width="' . $imgInfo[0] . '" height="' . $imgInfo[1] . '" border="0" alt="" />';
@@ -2821,7 +2763,6 @@ class GraphicalFunctions {
         * @param integer $quality The image quality (for JPEGs)
         * @return boolean The output of either imageGif, imagePng or imageJpeg based on the filename to write
         * @see maskImageOntoImage(), scale(), output()
-        * @todo Define visibility
         */
        public function ImageWrite($destImg, $theImage, $quality = 0) {
                imageinterlace($destImg, 0);
@@ -2862,7 +2803,6 @@ class GraphicalFunctions {
         *
         * @param string $sourceImg Image filename
         * @return pointer Image Resource pointer
-        * @todo Define visibility
         */
        public function imageCreateFromFile($sourceImg) {
                $imgInf = pathinfo($sourceImg);
@@ -2903,7 +2843,6 @@ class GraphicalFunctions {
         *
         * @param array RGB color array
         * @return string HEX color value
-        * @todo Define visibility
         */
        public function hexColor($col) {
                $r = dechex($col[0]);
@@ -2928,7 +2867,6 @@ class GraphicalFunctions {
         * @param array $colArr Array containing RGB color arrays
         * @param boolean $closest
         * @return integer The index of the unified color
-        * @todo Define visibility
         */
        public function unifyColors(&$img, $colArr, $closest = FALSE) {
                $retCol = -1;
index 4363002..d80cbac 100644 (file)
@@ -29,81 +29,68 @@ class DatabaseIntegrityCheck {
 
        /**
         * @var boolean If set, genTree() includes deleted pages. This is default.
-        * @todo Define visibility
         */
        public $genTree_includeDeleted = TRUE;
 
        /**
         * @var boolean If set, genTree() includes versionized pages/records. This is default.
-        * @todo Define visibility
         */
        public $genTree_includeVersions = TRUE;
 
        /**
         * @var boolean If set, genTree() includes records from pages.
-        * @todo Define visibility
         */
        public $genTree_includeRecords = FALSE;
 
        /**
         * @var string Extra where-clauses for the tree-selection
-        * @todo Define visibility
         */
        public $perms_clause = '';
 
        /**
         * @var int If set, genTree() generates HTML, that visualizes the tree.
-        * @todo Define visibility
         */
        public $genTree_makeHTML = 0;
 
        // Internal
        /**
         * @var array Will hold id/rec pairs from genTree()
-        * @todo Define visibility
         */
        public $page_idArray = array();
 
        /**
         * @var array
-        * @todo Define visibility
         */
        public $rec_idArray = array();
 
        /**
         * @var string  Will hold the HTML-code visualising the tree. genTree()
-        * @todo Define visibility
         */
        public $genTree_HTML = '';
 
        /**
         * @var string
-        * @todo Define visibility
         */
        public $backPath = '';
 
        // Internal
        /**
         * @var array
-        * @todo Define visibility
         */
        public $checkFileRefs = array();
 
        /**
         * @var array From the select-fields
-        * @todo Define visibility
         */
        public $checkSelectDBRefs = array();
 
        /**
         * @var array From the group-fields
-        * @todo Define visibility
         */
        public $checkGroupDBRefs = array();
 
        /**
         * @var array Statistics
-        * @todo Define visibility
         */
        public $recStats = array(
                'allValid' => array(),
@@ -113,13 +100,11 @@ class DatabaseIntegrityCheck {
 
        /**
         * @var array
-        * @todo Define visibility
         */
        public $lRecords = array();
 
        /**
         * @var string
-        * @todo Define visibility
         */
        public $lostPagesList = '';
 
@@ -131,7 +116,6 @@ class DatabaseIntegrityCheck {
         * @param string $depthData HTML-code (image-tags) used when this function calls itself recursively.
         * @param boolean $versions Internal variable, don't set from outside!
         * @return void
-        * @todo Define visibility
         */
        public function genTree($theID, $depthData, $versions = FALSE) {
                if ($versions) {
@@ -201,7 +185,6 @@ class DatabaseIntegrityCheck {
         * @param string $table Table to get the records from
         * @param boolean $versions Internal variable, don't set from outside!
         * @return      void
-        * @todo Define visibility
         */
        public function genTree_records($theID, $depthData, $table = '', $versions = FALSE) {
                if ($versions) {
@@ -262,7 +245,6 @@ class DatabaseIntegrityCheck {
         *
         * @param string $pid_list list of pid's (page-record uid's). This list is probably made by genTree()
         * @return void
-        * @todo Define visibility
         */
        public function lostRecords($pid_list) {
                $this->lostPagesList = '';
@@ -298,7 +280,6 @@ class DatabaseIntegrityCheck {
         * @param string $table Database tablename
         * @param integer $uid The uid of the record which will have the PID value set to 0 (zero)
         * @return boolean TRUE if done.
-        * @todo Define visibility
         */
        public function fixLostRecord($table, $uid) {
                if ($table && $GLOBALS['TCA'][$table] && $uid && is_array($this->lRecords[$table][$uid]) && $GLOBALS['BE_USER']->user['admin']) {
@@ -320,7 +301,6 @@ class DatabaseIntegrityCheck {
         *
         * @param string $pid_list list of pid's (page-record uid's). This list is probably made by genTree()
         * @return array an array with the number of records from all $GLOBALS['TCA']-tables that are attached to a PID in the pid-list.
-        * @todo Define visibility
         */
        public function countRecords($pid_list) {
                $list = array();
@@ -350,7 +330,6 @@ class DatabaseIntegrityCheck {
         *
         * @param string $mode $mode = file, $mode = db, $mode = '' (all...)
         * @return array An array with all fields listed that somehow are references to other records (foreign-keys) or files
-        * @todo Define visibility
         */
        public function getGroupFields($mode) {
                $result = array();
@@ -378,7 +357,6 @@ class DatabaseIntegrityCheck {
         *
         * @param string $uploadfolder Path to uploadfolder
         * @return array An array with all fields listed that have references to files in the $uploadfolder
-        * @todo Define visibility
         */
        public function getFileFields($uploadfolder) {
                $result = array();
@@ -398,7 +376,6 @@ class DatabaseIntegrityCheck {
         *
         * @param string $theSearchTable Table name
         * @return array
-        * @todo Define visibility
         */
        public function getDBFields($theSearchTable) {
                $result = array();
@@ -423,7 +400,6 @@ class DatabaseIntegrityCheck {
         * @param array $fkey_arrays Array with tables/fields generated by getGroupFields()
         * @return void
         * @see getGroupFields()
-        * @todo Define visibility
         */
        public function selectNonEmptyRecordsWithFkeys($fkey_arrays) {
                if (is_array($fkey_arrays)) {
@@ -501,7 +477,6 @@ class DatabaseIntegrityCheck {
         * Depends on selectNonEmpty.... to be executed first!!
         *
         * @return array Report over files; keys are "moreReferences", "noReferences", "noFile", "error
-        * @todo Define visibility
         */
        public function testFileRefs() {
                $output = array();
@@ -579,7 +554,6 @@ class DatabaseIntegrityCheck {
         *
         * @param array $theArray Table with key/value pairs being table names and arrays with uid numbers
         * @return string HTML Error message
-        * @todo Define visibility
         */
        public function testDBRefs($theArray) {
                $result = '';
@@ -614,7 +588,6 @@ class DatabaseIntegrityCheck {
         * @param string $searchTable Table name
         * @param integer $id Uid of database record
         * @return array Array with other arrays containing information about where references was found
-        * @todo Define visibility
         */
        public function whereIsRecordReferenced($searchTable, $id) {
                // Gets tables / Fields that reference to files
@@ -648,7 +621,6 @@ class DatabaseIntegrityCheck {
         * @param string $uploadfolder Upload folder where file is found
         * @param string $filename Filename to search for
         * @return array Array with other arrays containing information about where references was found
-        * @todo Define visibility
         */
        public function whereIsFileReferenced($uploadfolder, $filename) {
                // Gets tables / Fields that reference to files
index a09a61a..f516ed6 100644 (file)
@@ -23,49 +23,41 @@ abstract class AbstractService {
 
        /**
         * @var array service description array
-        * @todo Define visibility
         */
        public $info = array();
 
        /**
         * @var array error stack
-        * @todo Define visibility
         */
        public $error = array();
 
        /**
         * @var bool Defines if debug messages should be written with \TYPO3\CMS\Core\Utility\GeneralUtility::devLog
-        * @todo Define visibility
         */
        public $writeDevLog = FALSE;
 
        /**
         * @var string The output content. That's what the services produced as result.
-        * @todo Define visibility
         */
        public $out = '';
 
        /**
         * @var string The file that should be processed.
-        * @todo Define visibility
         */
        public $inputFile = '';
 
        /**
         * @var string The content that should be processed.
-        * @todo Define visibility
         */
        public $inputContent = '';
 
        /**
         * @var string The type of the input content (or file). Might be the same as the service subtypes.
-        * @todo Define visibility
         */
        public $inputType = '';
 
        /**
         * @var string The file where the output should be written to.
-        * @todo Define visibility
         */
        public $outputFile = '';
 
@@ -73,7 +65,7 @@ abstract class AbstractService {
         * Temporary files which have to be deleted
         *
         * @private
-        * @todo Define visibility
+        * @var array
         */
        public $tempFiles = array();
 
@@ -96,7 +88,6 @@ abstract class AbstractService {
         * Returns internal information array for service
         *
         * @return array Service description array
-        * @todo Define visibility
         */
        public function getServiceInfo() {
                return $this->info;
@@ -106,7 +97,6 @@ abstract class AbstractService {
         * Returns the service key of the service
         *
         * @return string Service key
-        * @todo Define visibility
         */
        public function getServiceKey() {
                return $this->info['serviceKey'];
@@ -116,7 +106,6 @@ abstract class AbstractService {
         * Returns the title of the service
         *
         * @return string Service title
-        * @todo Define visibility
         */
        public function getServiceTitle() {
                return $this->info['title'];
@@ -129,7 +118,6 @@ abstract class AbstractService {
         * @param mixed $defaultValue Default configuration if no special config is available
         * @param boolean $includeDefaultConfig If set the 'default' config will be returned if no special config for this service is available (default: TRUE)
         * @return mixed Configuration value for the service
-        * @todo Define visibility
         */
        public function getServiceOption($optionName, $defaultValue = '', $includeDefaultConfig = TRUE) {
                $config = NULL;
@@ -157,7 +145,6 @@ abstract class AbstractService {
         * @param integer $severity Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
         * @param array|boolean $dataVar dditional data you want to pass to the logger.
         * @return void
-        * @todo Define visibility
         */
        public function devLog($msg, $severity = 0, $dataVar = FALSE) {
                if ($this->writeDevLog) {
@@ -171,7 +158,6 @@ abstract class AbstractService {
         * @param integer $errNum Error number (see T3_ERR_SV_* constants)
         * @param string $errMsg Error message
         * @return void
-        * @todo Define visibility
         */
        public function errorPush($errNum = T3_ERR_SV_GENERAL, $errMsg = 'Unspecified error occurred') {
                array_push($this->error, array('nr' => $errNum, 'msg' => $errMsg));
@@ -184,7 +170,6 @@ abstract class AbstractService {
         * Removes the last error from the error stack.
         *
         * @return void
-        * @todo Define visibility
         */
        public function errorPull() {
                array_pop($this->error);
@@ -194,7 +179,6 @@ abstract class AbstractService {
         * Returns the last error number from the error stack.
         *
         * @return integer|boolean Error number (or TRUE if no error)
-        * @todo Define visibility
         */
        public function getLastError() {
                // Means all is ok - no error
@@ -210,7 +194,6 @@ abstract class AbstractService {
         * Returns the last message from the error stack.
         *
         * @return string Error message
-        * @todo Define visibility
         */
        public function getLastErrorMsg() {
                $lastErrorMessage = '';
@@ -225,7 +208,6 @@ abstract class AbstractService {
         * Returns all error messages as array.
         *
         * @return array Error messages
-        * @todo Define visibility
         */
        public function getErrorMsgArray() {
                $errArr = array();
@@ -241,7 +223,6 @@ abstract class AbstractService {
         * Returns the last array from the error stack.
         *
         * @return array Error number and message
-        * @todo Define visibility
         */
        public function getLastErrorArray() {
                return end($this->error);
@@ -251,7 +232,6 @@ abstract class AbstractService {
         * Reset the error stack.
         *
         * @return void
-        * @todo Define visibility
         */
        public function resetErrors() {
                $this->error = array();
@@ -267,7 +247,6 @@ abstract class AbstractService {
         *
         * @param string $progList Comma list of programs 'perl,python,pdftotext'
         * @return boolean Return FALSE if one program was not found
-        * @todo Define visibility
         */
        public function checkExec($progList) {
                $ret = TRUE;
@@ -286,7 +265,6 @@ abstract class AbstractService {
         * Deactivate the service. Use this if the service fails at runtime and will not be available.
         *
         * @return void
-        * @todo Define visibility
         */
        public function deactivateService() {
                \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::deactivateService($this->info['serviceType'], $this->info['serviceKey']);
@@ -302,7 +280,6 @@ abstract class AbstractService {
         *
         * @param string $absFile File name with absolute path.
         * @return string|boolean File name or FALSE.
-        * @todo Define visibility
         */
        public function checkInputFile($absFile) {
                $checkResult = FALSE;
@@ -324,7 +301,6 @@ abstract class AbstractService {
         * @param string $absFile File name to read from.
         * @param integer $length Maximum length to read. If empty the whole file will be read.
         * @return string|boolean $content or FALSE
-        * @todo Define visibility
         */
        public function readFile($absFile, $length = 0) {
                $out = FALSE;
@@ -343,7 +319,6 @@ abstract class AbstractService {
         * @param string $content Content to write to the file
         * @param string $absFile File name to write into. If empty a temp file will be created.
         * @return string|boolean File name or FALSE
-        * @todo Define visibility
         */
        public function writeFile($content, $absFile = '') {
                if (!$absFile) {
@@ -366,7 +341,6 @@ abstract class AbstractService {
         *
         * @param string $filePrefix File prefix.
         * @return string|boolean File name or FALSE
-        * @todo Define visibility
         */
        public function tempFile($filePrefix) {
                $absFile = \TYPO3\CMS\Core\Utility\GeneralUtility::tempnam($filePrefix);
@@ -385,7 +359,6 @@ abstract class AbstractService {
         *
         * @param string File name with absolute path.
         * @return void
-        * @todo Define visibility
         */
        public function registerTempFile($absFile) {
                if (!isset($this->shutdownRegistry[__METHOD__])) {
@@ -399,7 +372,6 @@ abstract class AbstractService {
         * Delete registered temporary files.
         *
         * @return      void
-        * @todo Define visibility
         */
        public function unlinkTempFiles() {
                foreach ($this->tempFiles as $absFile) {
@@ -419,7 +391,6 @@ abstract class AbstractService {
         * @param mixed $content Input content (going into ->inputContent)
         * @param string $type The type of the input content (or file). Might be the same as the service subtypes.
         * @return void
-        * @todo Define visibility
         */
        public function setInput($content, $type = '') {
                $this->inputContent = $content;
@@ -433,7 +404,6 @@ abstract class AbstractService {
         * @param string $absFile File name
         * @param string $type The type of the input content (or file). Might be the same as the service subtypes.
         * @return void
-        * @todo Define visibility
         */
        public function setInputFile($absFile, $type = '') {
                $this->inputContent = '';
@@ -446,7 +416,6 @@ abstract class AbstractService {
         * Will be read from input file if needed. (That is if ->inputContent is empty and ->inputFile is not)
         *
         * @return mixed
-        * @todo Define visibility
         */
        public function getInput() {
                if ($this->inputContent == '') {
@@ -461,7 +430,6 @@ abstract class AbstractService {
         *
         * @param string $createFile File name. If empty a temp file will be created.
         * @return string File name or FALSE if no input or file error.
-        * @todo Define visibility
         */
        public function getInputFile($createFile = '') {
                if ($this->inputFile) {
@@ -482,7 +450,6 @@ abstract class AbstractService {
         *
         * @param string $absFile File name
         * @return void
-        * @todo Define visibility
         */
        public function setOutputFile($absFile) {
                $this->outputFile = $absFile;
@@ -492,7 +459,6 @@ abstract class AbstractService {
         * Get the output content.
         *
         * @return mixed
-        * @todo Define visibility
         */
        public function getOutput() {
                if ($this->outputFile) {
@@ -506,7 +472,6 @@ abstract class AbstractService {
         *
         * @param string $absFile Absolute filename to write to
         * @return mixed
-        * @todo Define visibility
         */
        public function getOutputFile($absFile = '') {
                if (!$this->outputFile) {
@@ -527,7 +492,6 @@ abstract class AbstractService {
         * example: check if the perl interpreter is available which is needed to run an extern perl script.
         *
         * @return boolean TRUE if the service is available
-        * @todo Define visibility
         */
        public function init() {
                // look in makeInstanceService()
@@ -546,7 +510,6 @@ abstract class AbstractService {
         * Will be called by init(). Should be used before every use if a service instance is used multiple times.
         *
         * @return void
-        * @todo Define visibility
         */
        public function reset() {
                $this->unlinkTempFiles();
@@ -563,7 +526,6 @@ abstract class AbstractService {
         * Child classes should explicitly call parent::__destruct() in their destructors for this to work
         *
         * @return void
-        * @todo Define visibility
         */
        public function __destruct() {
                $this->unlinkTempFiles();
index 01e84e7..2781092 100644 (file)
@@ -25,18 +25,18 @@ class TimeTracker {
 
        // Is loaded with the millisecond time when this object is created
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $starttime = 0;
 
        // Log Rendering flag. If set, ->push() and ->pull() is called from the cObj->cObjGetSingle(). This determines whether or not the TypoScript parsing activity is logged. But it also slows down the rendering
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $LR = 1;
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $printConf = array(
                'showParentKeys' => 1,
@@ -53,53 +53,53 @@ class TimeTracker {
        );
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $wrapError = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $wrapIcon = array();
 
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $uniqueCounter = 0;
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $tsStack = array(array());
 
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $tsStackLevel = 0;
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $tsStackLevelMax = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $tsStackLog = array();
 
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $tsStackPointer = 0;
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $currentHashPointer = array();
 
        // Log entries that take than this number of milliseconds (own time) will be highlighted during log display. Set 0 to disable highlighting.
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $highlightLongerThan = 0;
 
index d61df29..c87d916 100644 (file)
@@ -22,27 +22,27 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
 
        // Internal
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $categories = array();
 
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $ext_dontCheckIssetValues = 1;
 
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $ext_CEformName = 'tsStyleConfigForm';
 
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $ext_printAll = 1;
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $ext_incomingValues = array();
 
@@ -52,7 +52,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         * @param string $pathAbs PathAbs is the absolute path from root
         * @param string $backPath BackPath is the backReference from current position to typo3/ dir
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_initTSstyleConfig($configTemplate, $pathRel, $pathAbs, $backPath) {
                // Do not log time-performance information
@@ -72,7 +71,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         * @param       [type]          $theConstants: ...
         * @param       [type]          $valueArray: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_setValueArray($theConstants, $valueArray) {
                $temp = $this->flatSetup;
@@ -96,7 +94,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         * [Describe function...]
         *
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_getCategoriesForModMenu() {
                return $this->ext_getCategoryLabelArray();
@@ -107,7 +104,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         *
         * @param       [type]          $cat: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_makeHelpInformationForCategory($cat) {
                return $this->ext_getTSCE_config($cat);
@@ -123,7 +119,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         * @param string $extKey
         * @param boolean Adds opening <form> tag to the ouput, if TRUE
         * @return string The form
-        * @todo Define visibility
         */
        public function ext_getForm($cat, $theConstants, $script = '', $addFields = '', $extKey = '', $addFormTag = TRUE) {
                $this->ext_makeHelpInformationForCategory($cat);
@@ -149,7 +144,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         * [Describe function...]
         *
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_displayExample() {
                if ($this->helpConfig['imagetag'] || $this->helpConfig['description'] || $this->helpConfig['header']) {
@@ -163,7 +157,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         *
         * @param       [type]          $arr: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_mergeIncomingWithExisting($arr) {
                $parseObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\Parser\\TypoScriptParser');
@@ -175,7 +168,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
 
        // Extends:
        /**
-        * @todo Define visibility
         */
        public function ext_getKeyImage($key) {
                return '<img' . \TYPO3\CMS\Backend\Utility\IconUtility::skinImg($this->ext_backPath, ('gfx/rednumbers/' . $key . '.gif'), '') . ' hspace="2" align="top" alt="" />';
@@ -186,7 +178,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         *
         * @param       [type]          $imgConf: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_getTSCE_config_image($imgConf) {
                $iFile = $this->ext_localGfxPrefix . $imgConf;
@@ -200,7 +191,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         *
         * @param       [type]          $params: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_fNandV($params) {
                $fN = 'data[' . $params['name'] . ']';
@@ -220,7 +210,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         * @param       [type]          $key: ...
         * @param       [type]          $var: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_putValueInConf($key, $var) {
                $this->ext_incomingValues[$key] = $key . '=' . $var;
@@ -231,7 +220,6 @@ class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateServi
         *
         * @param       [type]          $key: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function ext_removeValueInConf($key) {
 
index 30f44d2..07f57fa 100644 (file)
@@ -25,134 +25,134 @@ class TypoScriptParser {
 
        // If set, then key names cannot contain characters other than [:alnum:]_\.-
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $strict = 1;
 
        // Internal
        // TypoScript hierarchy being build during parsing.
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $setup = array();
 
        // Raw data, the input string exploded by LF
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $raw;
 
        // Pointer to entry in raw data array
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $rawP;
 
        // Holding the value of the last comment
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $lastComment = '';
 
        // Internally set, used as internal flag to create a multi-line comment (one of those like /*... */)
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $commentSet = 0;
 
        // Internally set, when multiline value is accumulated
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $multiLineEnabled = 0;
 
        // Internally set, when multiline value is accumulated
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $multiLineObject = '';
 
        // Internally set, when multiline value is accumulated
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $multiLineValue = array();
 
        // Internally set, when in brace. Counter.
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $inBrace = 0;
 
        // For each condition this flag is set, if the condition is TRUE, else it's cleared. Then it's used by the [ELSE] condition to determine if the next part should be parsed.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $lastConditionTrue = 1;
 
        // Tracking all conditions found
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $sections = array();
 
        // Tracking all matching conditions found
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $sectionsMatch = array();
 
        // If set, then syntax highlight mode is on; Call the function syntaxHighlight() to use this function
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $syntaxHighLight = 0;
 
        // Syntax highlight data is accumulated in this array. Used by syntaxHighlight_print() to construct the output.
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $highLightData = array();
 
        // Syntax highlight data keeping track of the curly brace level for each line
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $highLightData_bracelevel = array();
 
        // Debugging, analysis:
        // DO NOT register the comments. This is default for the ordinary sitetemplate!
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $regComments = 0;
 
        // DO NOT register the linenumbers. This is default for the ordinary sitetemplate!
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $regLinenumbers = 0;
 
        // Error accumulation array.
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $errors = array();
 
        // Used for the error messages line number reporting. Set externally.
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $lineNumberOffset = 0;
 
        // Line for break point.
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $breakPointLN = 0;
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $highLightStyles = array(
                'prespace' => array('<span class="ts-prespace">', '</span>'),
@@ -186,17 +186,19 @@ class TypoScriptParser {
 
        // Additional attributes for the <span> tags for a blockmode line
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $highLightBlockStyles = '';
 
        // The hex-HTML color for the blockmode
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $highLightBlockStyles_basecolor = '#cccccc';
 
-       //Instance of parentObject, used by \TYPO3\CMS\Core\TypoScript\ExtendedTemplateService
+       /**
+        * @var \TYPO3\CMS\Core\TypoScript\ExtendedTemplateService
+        */
        public $parentObject;
 
        /**
@@ -206,7 +208,6 @@ class TypoScriptParser {
         * @param object|string $matchObj If is object, then this is used to match conditions found in the TypoScript code. If matchObj not specified, then no conditions will work! (Except [GLOBAL])
         *
         * @return void
-        * @todo Define visibility
         */
        public function parse($string, $matchObj = '') {
                $this->raw = explode(LF, $string);
@@ -257,7 +258,6 @@ class TypoScriptParser {
         *
         * @return string The condition value
         * @see parse()
-        * @todo Define visibility
         */
        public function nextDivider() {
                while (isset($this->raw[$this->rawP])) {
@@ -274,7 +274,6 @@ class TypoScriptParser {
         *
         * @param array $setup Reference to the setup array in which to accumulate the values.
         * @return string|NULL Returns the string of the condition found, the exit signal or possible nothing (if it completed parsing with no interruptions)
-        * @todo Define visibility
         */
        public function parseSub(array &$setup) {
                while (isset($this->raw[$this->rawP])) {
@@ -565,7 +564,6 @@ class TypoScriptParser {
         * @param array $setup The local setup array from the function calling this function
         * @return string Returns the exitSignal
         * @see parseSub()
-        * @todo Define visibility
         */
        public function rollParseSub($string, array &$setup) {
                if ((string)$string === '') {
@@ -590,7 +588,6 @@ class TypoScriptParser {
         * @param string $string Object path for which to get the value
         * @param array $setup Global setup code if $string points to a global object path. But if string is prefixed with "." then its the local setup array.
         * @return array An array with keys 0/1 being value/property respectively
-        * @todo Define visibility
         */
        public function getVal($string, $setup) {
                if ((string)$string === '') {
@@ -624,7 +621,6 @@ class TypoScriptParser {
         * @param array|string $value The value/property pair array to set. If only one of them is set, then the other is not touched (unless $wipeOut is set, which it is when copies are made which must include both value and property)
         * @param bool $wipeOut If set, then both value and property is wiped out when a copy is made of another value.
         * @return void
-        * @todo Define visibility
         */
        public function setVal($string, array &$setup, $value, $wipeOut = FALSE) {
                if ((string)$string === '') {
@@ -729,7 +725,6 @@ class TypoScriptParser {
         * @param string $err The error message string
         * @param integer $num The error severity (in the scale of $GLOBALS['TT']->setTSlogMessage: Approx: 2=warning, 1=info, 0=nothing, 3=fatal.)
         * @return void
-        * @todo Define visibility
         */
        public function error($err, $num = 2) {
                if (is_object($GLOBALS['TT'])) {
@@ -1147,7 +1142,6 @@ class TypoScriptParser {
         * @param mixed $lineNum If blank, linenumbers are NOT printed. If array then the first key is the linenumber offset to add to the internal counter.
         * @param boolean $highlightBlockMode If set, then the highlighted output will be formatted in blocks based on the brace levels. prespace will be ignored and empty lines represented with a single no-break-space.
         * @return string HTML code for the syntax highlighted string
-        * @todo Define visibility
         */
        public function doSyntaxHighlight($string, $lineNum = '', $highlightBlockMode = FALSE) {
                $this->syntaxHighLight = 1;
@@ -1168,7 +1162,6 @@ class TypoScriptParser {
         * @return void
         * @access private
         * @see         parse()
-        * @todo Define visibility
         */
        public function regHighLight($code, $pointer, $strlen = -1) {
                if ($strlen === -1) {
@@ -1187,7 +1180,6 @@ class TypoScriptParser {
         * @return string HTML content
         * @access private
         * @see doSyntaxHighlight()
-        * @todo Define visibility
         */
        public function syntaxHighlight_print($lineNumDat, $highlightBlockMode) {
                // Registers all error messages in relation to their linenumber
index f627fde..c9a358c 100644 (file)
@@ -24,25 +24,25 @@ class DiffUtility {
        // External, static
        // If set, the HTML tags are stripped from the input strings first.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $stripTags = 0;
 
        // Diff options. eg "--unified=3"
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $diffOptions = '';
 
        // Internal, dynamic
        // This indicates the number of times the function addClearBuffer has been called - and used to detect the very first call...
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $clearBufferIdx = 0;
 
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $differenceLgd = 0;
 
@@ -53,7 +53,6 @@ class DiffUtility {
         * @param string $str2 String 2
         * @param string $wrapTag Setting the wrapping tag name
         * @return string Formatted output.
-        * @todo Define visibility
         */
        public function makeDiffDisplay($str1, $str2, $wrapTag = 'span') {
                if ($this->stripTags) {
@@ -128,7 +127,6 @@ class DiffUtility {
         * @param string $str2 String 2
         * @return array The result from the exec() function call.
         * @access private
-        * @todo Define visibility
         */
        public function getDiff($str1, $str2) {
                // Create file 1 and write string
@@ -153,7 +151,6 @@ class DiffUtility {
         * @param boolean $last If set, it indicates that the string should just end with ... (thus no "complete" ending)
         * @return string Processed string.
         * @access private
-        * @todo Define visibility
         */
        public function addClearBuffer($clearBuffer, $last = 0) {
                if (strlen($clearBuffer) > 200) {
@@ -170,7 +167,6 @@ class DiffUtility {
         * @param string $str The string input
         * @return array Array with words.
         * @access private
-        * @todo Define visibility
         */
        public function explodeStringIntoWords($str) {
                $strArr = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(LF, $str);
@@ -191,7 +187,6 @@ class DiffUtility {
         * @param boolean $rev If set, the < > searched for will be &lt; and &gt;
         * @return string Processed string
         * @access private
-        * @todo Define visibility
         */
        public function tagSpace($str, $rev = 0) {
                if ($rev) {
index e705dbe..cc5ba5e 100644 (file)
@@ -38,56 +38,56 @@ class BasicFileUtility {
        const UNSAFE_FILENAME_CHARACTER_EXPRESSION = '\\x00-\\x2C\\/\\x3A-\\x3F\\x5B-\\x60\\x7B-\\xBF';
 
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $getUniqueNamePrefix = '';
 
        // Prefix which will be prepended the file when using the getUniqueName-function
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $maxNumber = 99;
 
        // This number decides the highest allowed appended number used on a filename before we use naming with unique strings
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $uniquePrecision = 6;
 
        // This number decides how many characters out of a unique MD5-hash that is appended to a filename if getUniqueName is asked to find an available filename.
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $maxInputNameLen = 60;
 
        // This is the maximum length of names treated by cleanFileName()
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $tempFN = '_temp_';
 
        // Temp-foldername. A folder in the root of one of the mounts with this name is regarded a TEMP-folder (used for upload from clipboard)
        // internal
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $f_ext = array();
 
        // See comment in header
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $mounts = array();
 
        // See comment in header
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $webPath = '';
 
        // Set to DOCUMENT_ROOT.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $isInit = 0;
 
@@ -275,7 +275,6 @@ class BasicFileUtility {
         *
         * @param       string          Filename, eg "somefile.html
         * @return      boolean
-        * @todo Define visibility
         * @deprecated since TYPO3 6.0. Please use corresponding TYPO3\\CMS\\Core\\Resource\\ResourceStorage (fetched via BE_USERS->getFileStorages())
         */
        public function checkFileNameLen($fileName) {
index 050f0dd..fcbbc0e 100644 (file)
@@ -52,13 +52,13 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
        // Notice; some of these are overridden in the start() method with values from $GLOBALS['TYPO3_CONF_VARS']['BE']
        // Path to unzip-program (with trailing '/')
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $unzipPath = '';
 
        // If set, the uploaded files will overwrite existing files.
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $dontCheckForUnique = 0;
 
@@ -66,6 +66,8 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         * This array is self-explaining (look in the class below).
         * It grants access to the functions. This could be set from outside in order to enabled functions to users.
         * See also the function setActionPermissions() which takes input directly from the user-record
+        *
+        * @var array
         */
        public $actionPerms = array(
                // File permissions
@@ -90,28 +92,19 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
 
        // This is regarded to be the recycler folder
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $recyclerFN = '_recycler_';
 
-       /**
-        * Whether to use recycler (0 = no, 1 = if available, 2 = always)
-        *
-        * @var integer
-        * @deprecated since TYPO3 6.0
-        * @todo Define visibility
-        */
-       public $useRecycler = 1;
-
        // Internal, dynamic
        // Will contain map between upload ID and the final filename
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $internalUploadMap = array();
 
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $lastError = '';
 
@@ -140,7 +133,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @param array $fileCmds Array with the commands to execute. See "TYPO3 Core API" document
         * @return void
-        * @todo Define visibility
         */
        public function start($fileCmds) {
                $unzipPath = trim($GLOBALS['TYPO3_CONF_VARS']['BE']['unzip_path']);
@@ -185,7 +177,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @return mixed FALSE, if the file functions were not initialized
         * @throws \UnexpectedValueException
-        * @todo Define visibility
         */
        public function processData() {
                $result = array();
@@ -323,7 +314,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         * @param string $theFile Takes a valid Path ($theFile)
         * @return string Returns the path (without trailing slash) of the closest recycle-folder if found. Else FALSE.
         * @todo To be put in Storage with a better concept
-        * @todo Define visibility
         * @deprecated since TYPO3 6.0, use \TYPO3\CMS\Core\Resource\ResourceStorage method instead
         */
        public function findRecycler($theFile) {
@@ -355,7 +345,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         * @param string $details This is the default, raw error message in english
         * @param array $data Array with special information that may go into $details by "%s" marks / sprintf() when the log is shown
         * @return void
-        * @todo Define visibility
         */
        public function writeLog($action, $error, $details_nr, $details, $data) {
                // Type value for tce_file.php
@@ -379,7 +368,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @param array $cmds $cmds['data'] is the file/folder to delete
         * @return boolean Returns TRUE upon success
-        * @todo Define visibility
         */
        public function func_delete($cmds) {
                $result = FALSE;
@@ -693,7 +681,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @param array $cmds Command details as described above
         * @return \TYPO3\CMS\Core\Resource\File Returns the new file upon success
-        * @todo Define visibility
         */
        public function func_rename($cmds) {
                if (!$this->isInit) {
@@ -746,7 +733,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @param array $cmds Command details as described above
         * @return \TYPO3\CMS\Core\Resource\Folder Returns the new foldername upon success
-        * @todo Define visibility
         */
        public function func_newfolder($cmds) {
                if (!$this->isInit) {
@@ -782,7 +768,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @param array $cmds Command details as described above
         * @return string Returns the new filename upon success
-        * @todo Define visibility
         */
        public function func_newfile($cmds) {
                if (!$this->isInit) {
@@ -819,7 +804,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @param array $cmds $cmds['data'] is the new content. $cmds['target'] is the target (file or dir)
         * @return boolean Returns TRUE on success
-        * @todo Define visibility
         */
        public function func_edit($cmds) {
                if (!$this->isInit) {
@@ -884,7 +868,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @param array $cmds $cmds['data'] is the ID-number (points to the global var that holds the filename-ref  ($_FILES['upload_' . $id]['name']) . $cmds['target'] is the target directory, $cmds['charset'] is the the character set of the file name (utf-8 is needed for JS-interaction)
         * @return File[] | FALSE Returns an array of new file objects upon success. False otherwise
-        * @todo Define visibility
         */
        public function func_upload($cmds) {
                if (!$this->isInit) {
@@ -959,7 +942,6 @@ class ExtendedFileUtility extends \TYPO3\CMS\Core\Utility\File\BasicFileUtility
         *
         * @param array $cmds $cmds['data'] is the zip-file. $cmds['target'] is the target directory. If not set we'll default to the same directory as the file is in.
         * @return boolean Returns TRUE on success
-        * @todo Define visibility
         */
        public function func_unzip($cmds) {
                if (!$this->isInit || $this->dont_use_exec_commands) {
index d613a39..a49cbc4 100644 (file)
@@ -23,7 +23,6 @@ class AbstractMemoryProcessorTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {
 
        /**
         * @test
-        * @todo Define visibility
         */
        public function getRealMemoryUsageGetsRealMemoryUsage() {
                /** @var $processor \TYPO3\CMS\Core\Log\Processor\AbstractMemoryProcessor */
@@ -33,7 +32,6 @@ class AbstractMemoryProcessorTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {
 
        /**
         * @test
-        * @todo Define visibility
         */
        public function setRealMemoryUsageSetsRealMemoryUsage() {
                /** @var $processor \TYPO3\CMS\Core\Log\Processor\AbstractMemoryProcessor */
@@ -44,7 +42,6 @@ class AbstractMemoryProcessorTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {
 
        /**
         * @test
-        * @todo Define visibility
         */
        public function getFormatSizeGetsFormatSize() {
                /** @var $processor \TYPO3\CMS\Core\Log\Processor\AbstractMemoryProcessor */
@@ -54,7 +51,6 @@ class AbstractMemoryProcessorTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {
 
        /**
         * @test
-        * @todo Define visibility
         */
        public function setFormatSizeSetsFormatSize() {
                /** @var $processor \TYPO3\CMS\Core\Log\Processor\AbstractMemoryProcessor */