[TASK] Remove the "@todo define visibility" in ext:indexed_search 72/33272/2
authorWouter Wolters <typo3@wouterwolters.nl>
Sun, 12 Oct 2014 13:47:38 +0000 (15:47 +0200)
committerGeorg Ringer <georg.ringer@gmail.com>
Mon, 13 Oct 2014 05:53:45 +0000 (07:53 +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: #62176
Related: #61957
Releases: master
Change-Id: I3aa54c1fa0f8fbe662b1c5609a7fe6a5747c9d6a
Reviewed-on: http://review.typo3.org/33272
Reviewed-by: Markus Klein <klein.t3@reelworx.at>
Tested-by: Markus Klein <klein.t3@reelworx.at>
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
typo3/sysext/indexed_search/Classes/Controller/IndexingStatisticsController.php
typo3/sysext/indexed_search/Classes/Controller/ModuleController.php
typo3/sysext/indexed_search/Classes/Example/CrawlerHook.php
typo3/sysext/indexed_search/Classes/Example/PluginHook.php
typo3/sysext/indexed_search/Classes/Hook/CrawlerFilesHook.php
typo3/sysext/indexed_search/Classes/Hook/CrawlerHook.php
typo3/sysext/indexed_search/Classes/Lexer.php
typo3/sysext/indexed_search/Classes/Utility/DoubleMetaPhoneUtility.php

index 8239857..cd583e8 100644 (file)
@@ -33,7 +33,6 @@ class IndexingStatisticsController extends \TYPO3\CMS\Backend\Module\AbstractFun
         * Calls showStats to generate output.
         *
         * @return      string          html table with results from showStats()
-        * @todo Define visibility
         */
        public function main() {
                // Initializes the module. Done in this function because we may need to re-initialize if data is submitted!
@@ -51,7 +50,6 @@ class IndexingStatisticsController extends \TYPO3\CMS\Backend\Module\AbstractFun
         * Calls listSeveralStats 3 times, for all statistics, statistics of the last 30 days and statistics of the last 24 hours.
         *
         * @return      string          html table with results
-        * @todo Define visibility
         */
        public function showStats() {
                $conf['words'] = 50;
@@ -87,7 +85,6 @@ class IndexingStatisticsController extends \TYPO3\CMS\Backend\Module\AbstractFun
         * @param       string          add where for sql query
         * @param       array           configuration: words = max words for results, bid = pageid
         * @return      string          html table with results
-        * @todo Define visibility
         */
        public function listSeveralStats($title, $addwhere, $conf) {
                global $LANG;
@@ -142,7 +139,6 @@ class IndexingStatisticsController extends \TYPO3\CMS\Backend\Module\AbstractFun
         * @param       integer         $begin is an optional integer that determines at which level in the tree to start collecting uid's. Zero means 'start right away', 1 = 'next level and out'
         * @param       string          Perms clause
         * @return      string          Returns the list with a comma in the end (if any pages selected!)
-        * @todo Define visibility
         */
        public function extGetTreeList($id, $depth, $begin = 0, $perms_clause) {
                return GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\FrontendBackendUserAuthentication')->extGetTreeList($id, $depth, $begin, $perms_clause);
@@ -154,7 +150,6 @@ class IndexingStatisticsController extends \TYPO3\CMS\Backend\Module\AbstractFun
         * @param       string          Name of the function you want to call / hook key
         * @return      object          Hook object, if any. Otherwise NULL.
         * @author Kasper Skårhøj
-        * @todo Define visibility
         */
        public function hookRequest($functionName) {
                // Hook: menuConfig_preProcessModMenu
index 0821b61..c7c4959 100644 (file)
@@ -24,17 +24,17 @@ use TYPO3\CMS\Backend\Utility\BackendUtility;
 class ModuleController {
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $MCONF = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $MOD_MENU = array();
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $MOD_SETTINGS = array();
 
@@ -42,17 +42,16 @@ class ModuleController {
         * document template object
         *
         * @var \TYPO3\CMS\Backend\Template\DocumentTemplate
-        * @todo Define visibility
         */
        public $doc;
 
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $include_once = array();
 
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $content;
 
@@ -68,7 +67,6 @@ class ModuleController {
         * Initialization
         *
         * @return      void
-        * @todo Define visibility
         */
        public function init() {
                $this->MCONF = $GLOBALS['MCONF'];
@@ -94,7 +92,6 @@ class ModuleController {
         * Values NOT in this array will not be saved in the settings-array for the module.
         *
         * @return      void
-        * @todo Define visibility
         */
        public function menuConfig() {
                $this->MOD_MENU = array(
@@ -112,7 +109,6 @@ class ModuleController {
         * Main function to generate the content
         *
         * @return      void
-        * @todo Define visibility
         */
        public function main() {
                $this->content = $this->doc->header('Indexing Engine Statistics');
@@ -149,7 +145,6 @@ class ModuleController {
         * Print content
         *
         * @return void
-        * @todo Define visibility
         */
        public function printContent() {
                echo $this->content;
@@ -179,7 +174,6 @@ class ModuleController {
         ***************************/
        /**
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getRecordsNumbers() {
                $tables = explode(',', 'index_phash,index_words,index_rel,index_grlist,index_section,index_fulltext');
@@ -198,7 +192,6 @@ class ModuleController {
         *
         * @param       [type]          $str: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function tableHead($str) {
                return '<strong>' . $str . ':&nbsp;&nbsp;&nbsp;</strong>';
@@ -208,7 +201,6 @@ class ModuleController {
         * [Describe function...]
         *
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getPhashStat() {
                $recList = array();
@@ -241,7 +233,6 @@ class ModuleController {
         * [Describe function...]
         *
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getPhashT3pages() {
                $recList[] = array(
@@ -308,7 +299,6 @@ class ModuleController {
         * [Describe function...]
         *
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getPhashExternalDocs() {
                $recList[] = array(
@@ -374,7 +364,6 @@ class ModuleController {
         *
         * @param       [type]          $fegroup_recs: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function formatFeGroup($fegroup_recs) {
                $str = array();
@@ -390,7 +379,6 @@ class ModuleController {
         *
         * @param       [type]          $arr: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function formatCHash($arr) {
                $list = array();
@@ -405,7 +393,6 @@ class ModuleController {
         *
         * @param       [type]          $phash: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getNumberOfSections($phash) {
                return $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('phash', 'index_section', 'phash=' . (int)$phash);
@@ -416,7 +403,6 @@ class ModuleController {
         *
         * @param       [type]          $phash: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getNumberOfWords($phash) {
                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('count(*)', 'index_rel', 'phash=' . (int)$phash);
@@ -429,7 +415,6 @@ class ModuleController {
         *
         * @param       [type]          $phash: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getGrlistRecord($phash) {
                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('index_grlist.*', 'index_grlist', 'phash=' . (int)$phash);
@@ -446,7 +431,6 @@ class ModuleController {
         *
         * @param       [type]          $phash: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getNumberOfFulltext($phash) {
                return $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('phash', 'index_fulltext', 'phash=' . (int)$phash);
@@ -456,7 +440,6 @@ class ModuleController {
         * [Describe function...]
         *
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function getPhashTypes() {
                $recList = array();
@@ -483,7 +466,6 @@ class ModuleController {
         *
         * @param       [type]          $item_type: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function countUniqueTypes($item_type) {
                // TYPO3 pages, unique
index 64c006d..9ff3ae1 100644 (file)
@@ -13,11 +13,7 @@ namespace TYPO3\CMS\IndexedSearch\Example;
  *
  * The TYPO3 project - inspiring people to share!
  */
-/**
- * Index search crawler hook example
- *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- */
+
 /**
  * Index search crawler hook example
  *
@@ -29,7 +25,6 @@ class CrawlerHook {
         * Function is called when an indexing session starts according to the time intervals set for the indexing configuration.
         *
         * @return      string          Return a text string for the first, initiating queue entry for the crawler.
-        * @todo Define visibility
         */
        public function initMessage() {
                return 'Start of Custom Example Indexing session!';
@@ -46,7 +41,6 @@ class CrawlerHook {
         * @param       object          Grant Parent Object (from "crawler" extension)
         * @param       object          Parent Object (from "indexed_search" extension)
         * @return      void
-        * @todo Define visibility
         */
        public function indexOperation($cfgRec, &$session_data, $params, &$pObj) {
                // Init session data array if not already:
index b5c5b05..6c45399 100644 (file)
@@ -28,7 +28,7 @@ namespace TYPO3\CMS\IndexedSearch\Example;
 class PluginHook {
 
        /**
-        * @todo Define visibility
+        * @var \TYPO3\CMS\IndexedSearch\Controller\SearchFormController
         */
        public $pObj;
 
@@ -41,7 +41,6 @@ class PluginHook {
         * 'initialize_postProc' => 'EXT:indexed_search/example/class.pihook.php:&tx_indexedsearch_pihook',
         *
         * @return      void
-        * @todo Define visibility
         */
        public function initialize_postProc() {
                $this->pObj->optValues['order'] = array_reverse($this->pObj->optValues['order']);
@@ -52,7 +51,6 @@ class PluginHook {
         *
         * @param       array           Array of search words
         * @return      array           Array of first row, result rows, count
-        * @todo Define visibility
         */
        public function getResultRows($sWArr) {
 
@@ -66,7 +64,6 @@ class PluginHook {
         * @param       array           Result row
         * @param       boolean         If set, the result row is a sub-row.
         * @return      array           Template Content returned.
-        * @todo Define visibility
         */
        public function prepareResultRowTemplateData_postProc($tmplContent, $row, $headerOnly) {
                $tmplContent['description'] = '<em>' . $tmplContent['description'] . '</em>';
index d88dbb8..49a8a33 100644 (file)
@@ -29,7 +29,6 @@ class CrawlerFilesHook {
         * @param array $params Params from log element.
         * @param object $pObj Parent object (tx_crawler lib)
         * @return null|array Result array
-        * @todo Define visibility
         */
        public function crawler_execute($params, &$pObj) {
                if (!is_array($params['conf'])) {
index e3eb95e..cd1ad7a 100644 (file)
@@ -26,21 +26,21 @@ class CrawlerHook {
 
        // Static:
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $secondsPerExternalUrl = 3;
 
        // Number of seconds to use as interval between queued indexing operations of URLs / files (types 2 & 3)
        // Internal, dynamic:
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $instanceCounter = 0;
 
        // Counts up for each added URL (type 3)
        // Internal, static:
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $callBack = '&TYPO3\\CMS\\IndexedSearch\\Hook\\CrawlerHook';
 
@@ -52,7 +52,6 @@ class CrawlerHook {
         *
         * @param       object          Parent object (tx_crawler lib)
         * @return      void
-        * @todo Define visibility
         */
        public function crawler_init(&$pObj) {
                // Select all indexing configuration which are waiting to be activated:
@@ -160,7 +159,6 @@ class CrawlerHook {
         * @param       array           Params from log element. Must contain $params['indexConfigUid']
         * @param       object          Parent object (tx_crawler lib)
         * @return      array           Result array
-        * @todo Define visibility
         */
        public function crawler_execute($params, &$pObj) {
                // Indexer configuration ID must exist:
@@ -220,7 +218,6 @@ class CrawlerHook {
         * @param       array           Parameters from the log queue.
         * @param       object          Parent object (from "crawler" extension!)
         * @return      void
-        * @todo Define visibility
         */
        public function crawler_execute_type1($cfgRec, &$session_data, $params, &$pObj) {
                if ($cfgRec['table2index'] && isset($GLOBALS['TCA'][$cfgRec['table2index']])) {
@@ -265,7 +262,6 @@ class CrawlerHook {
         * @param       array           Parameters from the log queue.
         * @param       object          Parent object (from "crawler" extension!)
         * @return      void
-        * @todo Define visibility
         */
        public function crawler_execute_type2($cfgRec, &$session_data, $params, &$pObj) {
                // Prepare path, making it absolute and checking:
@@ -327,7 +323,6 @@ class CrawlerHook {
         * @param       array           Parameters from the log queue.
         * @param       object          Parent object (from "crawler" extension!)
         * @return      void
-        * @todo Define visibility
         */
        public function crawler_execute_type3($cfgRec, &$session_data, $params, &$pObj) {
                // Init session data array if not already:
@@ -368,7 +363,6 @@ class CrawlerHook {
         * @param       array           Parameters from the log queue.
         * @param       object          Parent object (from "crawler" extension!)
         * @return      void
-        * @todo Define visibility
         */
        public function crawler_execute_type4($cfgRec, &$session_data, $params, &$pObj) {
                // Base page uid:
@@ -413,7 +407,6 @@ class CrawlerHook {
         * Look up all old index configurations which are finished and needs to be reset and done
         *
         * @return      void
-        * @todo Define visibility
         */
        public function cleanUpOldRunningConfigurations() {
                // Lookup running index configurations:
@@ -454,7 +447,6 @@ class CrawlerHook {
         * @param       array           Array of already indexed URLs (input url is looked up here and must not exist already)
         * @param       string          Base URL of the indexing process (input URL must be "inside" the base URL!)
         * @return      string          Returls the URL if OK, otherwise FALSE
-        * @todo Define visibility
         */
        public function checkUrl($url, $urlLog, $baseUrl) {
                $url = preg_replace('/\\/\\/$/', '/', $url);
@@ -477,7 +469,6 @@ class CrawlerHook {
         * @param       integer         Configuration UID
         * @param       integer         Set ID value
         * @return      array           URLs found on this page
-        * @todo Define visibility
         */
        public function indexExtUrl($url, $pageId, $rl, $cfgUid, $setId) {
                // Index external URL:
@@ -524,7 +515,6 @@ class CrawlerHook {
         * @param       array           Configuration Record
         * @param       array           Rootline array to relate indexing to
         * @return      void
-        * @todo Define visibility
         */
        public function indexSingleRecord($r, $cfgRec, $rl = NULL) {
                // Init:
@@ -554,7 +544,6 @@ class CrawlerHook {
         * Include indexer class.
         *
         * @return      void
-        * @todo Define visibility
         * @deprecated since 6.2 will be removed two version later. Rely on autoloading of the indexer class.
         */
        public function loadIndexerClass() {
@@ -567,7 +556,6 @@ class CrawlerHook {
         *
         * @param       integer         The page id to traverse rootline back from
         * @return      array           Array where the root lines uid values are found.
-        * @todo Define visibility
         */
        public function getUidRootLineForClosestTemplate($id) {
                global $TYPO3_CONF_VARS;
@@ -593,7 +581,6 @@ class CrawlerHook {
         *
         * @param       array           Index configuration record
         * @return      integer         The next time stamp
-        * @todo Define visibility
         */
        public function generateNextIndexingTime($cfgRec) {
                $currentTime = $GLOBALS['EXEC_TIME'];
@@ -620,7 +607,6 @@ class CrawlerHook {
         * @param       string          URL to test
         * @param       string          String where URLs are separated by line-breaks; If any of these strings is the first part of $url, the function returns TRUE (to indicate denial of decend)
         * @return      boolean         TRUE if there is a matching URL (hence, do not index!)
-        * @todo Define visibility
         */
        public function checkDeniedSuburls($url, $url_deny) {
                if (trim($url_deny)) {
@@ -641,7 +627,6 @@ class CrawlerHook {
         * @param       array           Configuration record
         * @param       string          Title/URL
         * @return      void
-        * @todo Define visibility
         */
        public function addQueueEntryForHook($cfgRec, $title) {
                $nparams = array(
@@ -658,7 +643,6 @@ class CrawlerHook {
         *
         * @param       integer         Uid of the page to delete all pHash
         * @return      void
-        * @todo Define visibility
         */
        public function deleteFromIndex($id) {
                // Lookup old phash rows:
@@ -690,7 +674,6 @@ class CrawlerHook {
         * @param       mixed           Target value (ignored)
         * @param       object          Reference to tcemain calling object
         * @return      void
-        * @todo Define visibility
         */
        public function processCmdmap_preProcess($command, $table, $id, $value, $pObj) {
                // Clean up the index
@@ -708,7 +691,6 @@ class CrawlerHook {
         * @param       array           Field array of updated fields in the operation
         * @param       object          Reference to tcemain calling object
         * @return      void
-        * @todo Define visibility
         */
        public function processDatamap_afterDatabaseOperations($status, $table, $id, $fieldArray, $pObj) {
                // Check if any fields are actually updated:
index 871840a..839d591 100644 (file)
@@ -28,13 +28,13 @@ class Lexer {
 
        // Debugging options:
        /**
-        * @todo Define visibility
+        * @var bool
         */
        public $debug = FALSE;
 
        // If set, the debugString is filled with HTML output highlighting search / non-search words (for backend display)
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $debugString = '';
 
@@ -42,13 +42,12 @@ class Lexer {
         * Charset class object
         *
         * @var \TYPO3\CMS\Core\Charset\CharsetConverter
-        * @todo Define visibility
         */
        public $csObj;
 
        // Configuration of the lexer:
        /**
-        * @todo Define visibility
+        * @var array
         */
        public $lexerConf = array(
                'printjoins' => array(46, 45, 95, 58, 47, 39),
@@ -61,7 +60,6 @@ class Lexer {
         * Constructor: Initializes the charset class
         *
         * @return      void
-        * @todo Define visibility
         */
        public function __construct() {
                $this->csObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Charset\\CharsetConverter');
@@ -73,7 +71,6 @@ class Lexer {
         *
         * @param       string          String with UTF-8 content to process.
         * @return      array           Array of words in utf-8
-        * @todo Define visibility
         */
        public function split2Words($wordString) {
                // Reset debug string:
@@ -117,7 +114,6 @@ class Lexer {
         * @param       integer         Start position of word in input string
         * @param       integer         The Length of the word string from start position
         * @return      void
-        * @todo Define visibility
         */
        public function addWords(&$words, &$wordString, $start, $len) {
                // Get word out of string:
@@ -164,7 +160,6 @@ class Lexer {
         * @param       string          Input string (reference)
         * @param       integer         Starting position in input string
         * @return      array           0: start, 1: len or FALSE if no word has been found
-        * @todo Define visibility
         */
        public function get_word(&$str, $pos = 0) {
                $len = 0;
@@ -189,7 +184,6 @@ class Lexer {
         * @param       integer         Byte-length of character sequence (reference, return value)
         * @param       integer         Starting position in input string
         * @return      boolean         letter (or word) found
-        * @todo Define visibility
         */
        public function utf8_is_letter(&$str, &$len, $pos = 0) {
                global $cs;
@@ -259,7 +253,6 @@ class Lexer {
         *
         * @param       integer         Unicode number to evaluate
         * @return      array           Type of char; index-0: the main type: num, alpha or CJK (Chinese / Japanese / Korean)
-        * @todo Define visibility
         */
        public function charType($cp) {
                // Numeric?
@@ -286,7 +279,6 @@ class Lexer {
         * @param       integer         Starting position in input string
         * @param       boolean         If set, then a hex. number is returned
         * @return      integer         UNICODE codepoint
-        * @todo Define visibility
         */
        public function utf8_ord(&$str, &$len, $pos = 0, $hex = FALSE) {
                $ord = ord($str[$pos]);
index ce215c9..c72a1bd 100644 (file)
@@ -23,50 +23,56 @@ class DoubleMetaPhoneUtility {
 
        //  properties
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $original = '';
 
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $primary = '';
 
        /**
-        * @todo Define visibility
+        * @var string
         */
        public $secondary = '';
 
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $length = 0;
 
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $last = 0;
 
        /**
-        * @todo Define visibility
+        * @var int
         */
        public $current = 0;
 
        //  methods
        // TYPO3 specific API to this class. BEGIN
        /**
-        * @todo Define visibility
+        * Metaphone
+        *
+        * @param string $string
+        * @param int $sys_language_uid
+        * @return string
         */
        public function metaphone($string, $sys_language_uid = 0) {
                $res = $this->DoubleMetaPhone($string);
-               // debug(array($string,$res['primary']));
                return $res['primary'];
        }
 
        // TYPO3 specific API to this class. END
        // Public method
        /**
-        * @todo Define visibility
+        * Double metaphone
+        *
+        * @param string $string
+        * @return array
         */
        public function DoubleMetaPhone($string) {
                $this->primary = '';
@@ -772,7 +778,13 @@ class DoubleMetaPhoneUtility {
        // end of function MetaPhone
        // Private methods
        /**
-        * @todo Define visibility
+        * String at
+        *
+        * @param string $string
+        * @param int $start
+        * @param int $length
+        * @param array $list
+        * @return bool
         */
        public function StringAt($string, $start, $length, $list) {
                if ($start < 0 || $start >= strlen($string)) {
@@ -793,7 +805,6 @@ class DoubleMetaPhoneUtility {
         * @param       [type]          $string: ...
         * @param       [type]          $pos: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function IsVowel($string, $pos) {
                return preg_match('/[AEIOUY]/', substr($string, $pos, 1));
@@ -804,7 +815,6 @@ class DoubleMetaPhoneUtility {
         *
         * @param       [type]          $string: ...
         * @return      [type]          ...
-        * @todo Define visibility
         */
        public function SlavoGermanic($string) {
                return preg_match('/W|K|CZ|WITZ/', $string);