AOEpeople / crawler

Classes/Hooks/StaticFileCacheCreateUriHook.php

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
      * @param string $uri
      * @param TypoScriptFrontendController $frontend
      *
-     * @return array
+     * @return string[]
      *
      * @throws \Exception
      *

Classes/Backend/View/ProcessListView.php

Doc Comments +3 added lines, -3 removed lines

@@ -357,7 +357,7 @@ 
     /**
      * Returns a tag for the refresh icon
      *
-     * @return string
+     * @return ButtonUtility
      */
     protected function getRefreshLink()
     {
@@ -371,7 +371,7 @@ 
     /**
      * Returns a link for the panel to enable or disable the crawler
      *
-     * @return string
+     * @return ButtonUtility
      */
     protected function getEnableDisableLink()
     {
@@ -397,7 +397,7 @@ 
      *
      * @param void
      *
-     * @return string a-tag
+     * @return ButtonUtility|null a-tag
      */
     protected function getModeLink()
     {

Classes/Task/CrawlerQueueTaskAdditionalFieldProvider.php

Doc Comments +1 added lines, -1 removed lines

@@ -117,7 +117,7 @@
     /**
      * Mark current value as selected by returning the "selected" attribute
      *
-     * @param array $configurationArray
+     * @param string $configurationArray
      * @param string $currentValue
      *
      * @return string

Unused Use Statements -2 removed lines

@@ -25,9 +25,7 @@
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-use AOE\Crawler\Domain\Model\Configuration;
 use AOE\Crawler\Domain\Repository\ConfigurationRepository;
-use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Messaging\FlashMessage;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Utility\MathUtility;

Classes/Domain/Repository/QueueRepository.php

Doc Comments +2 added lines, -2 removed lines

@@ -60,7 +60,7 @@ 
     }
 
     /**
-     * @param $processId
+     * @param string $processId
      */
     public function unsetQueueProcessId($processId)
     {
@@ -438,7 +438,7 @@ 
     /**
      * Determines if a page is queued
      *
-     * @param $uid
+     * @param integer $uid
      * @param bool $unprocessed_only
      * @param bool $timed_only
      * @param bool $timestamp

Classes/Command/CrawlerCommandController.php

Doc Comments +1 added lines, -1 removed lines

@@ -250,7 +250,7 @@
     /**
      * Obtains configuration keys from the CLI arguments
      *
-     * @param $conf string
+     * @param string $conf string
      * @return array
      */
     private function getConfigurationKeys($conf)

Unused Use Statements -1 removed lines

@@ -33,7 +33,6 @@
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Utility\MathUtility;
-use TYPO3\CMS\Extbase\Object\ObjectManager;
 
 /**
  * Class CrawlerCommandController

Classes/Api/CrawlerApi.php

Unused Use Statements -1 removed lines

@@ -26,7 +26,6 @@
  ***************************************************************/
 
 use AOE\Crawler\Controller\CrawlerController;
-use AOE\Crawler\Domain\Model\Queue;
 use AOE\Crawler\Domain\Repository\ProcessRepository;
 use AOE\Crawler\Domain\Repository\QueueRepository;
 use TYPO3\CMS\Core\Database\ConnectionPool;

Classes/Controller/CrawlerController.php

Doc Comments +16 added lines, -7 removed lines

@@ -429,6 +429,10 @@ 
      * @param    array        Array which is passed by reference and contains the an id per url to secure we will not crawl duplicates
      * @param    array        Array which will be filled with URLS for download if flag is set.
      * @param    array        Array of processing instructions
+     * @param integer $scheduledTime
+     * @param integer $reqMinute
+     * @param boolean $submitCrawlUrls
+     * @param boolean $downloadCrawlUrls
      * @return    string        List of URLs (meant for display in backend module)
      *
      */
@@ -551,7 +555,7 @@ 
      *
      * @param string $piString PI to test
      * @param array $incomingProcInstructions Processing instructions
-     * @return boolean
+     * @return boolean|null
      */
     public function drawURLs_PIfilter($piString, array $incomingProcInstructions)
     {
@@ -763,6 +767,9 @@ 
         return $baseUrl;
     }
 
+    /**
+     * @param integer $rootid
+     */
     public function getConfigurationsForBranch($rootid, $depth)
     {
         $configurationsForBranch = [];
@@ -984,7 +991,7 @@ 
      * The number of URLs will be the multiplication of the number of parameter values for each key
      *
      * @param array $paramArray Output of expandParameters(): Array with keys (GET var names) and for each an array of values
-     * @param array $urls URLs accumulated in this array (for recursion)
+     * @param string[] $urls URLs accumulated in this array (for recursion)
      * @return array
      */
     public function compileUrls($paramArray, $urls = [])
@@ -1720,6 +1727,7 @@ 
 
     /**
      * @param message
+     * @param string $message
      */
     protected function log($message)
     {
@@ -1737,7 +1745,7 @@ 
      * @param array $url
      * @param string $crawlerId
      *
-     * @return array
+     * @return string[]
      */
     protected function buildRequestHeaderArray(array $url, $crawlerId)
     {
@@ -1997,6 +2005,7 @@ 
      *
      * @param    array        Page row
      * @param    string        Page icon and title for row
+     * @param string $pageTitleAndIcon
      * @return    string        HTML <tr> content (one or more)
      */
     public function drawURLs_addRowsForPage(array $pageRow, $pageTitleAndIcon)
@@ -2281,7 +2290,7 @@ 
     /**
      * Function executed by crawler_im.php cli script.
      *
-     * @return bool
+     * @return null|boolean
      */
     public function CLI_main_flush()
     {
@@ -2342,7 +2351,7 @@ 
      * @param int $countInARun
      * @param int $sleepTime
      * @param int $sleepAfterFinish
-     * @return string
+     * @return integer
      */
     public function CLI_run($countInARun, $sleepTime, $sleepAfterFinish)
     {
@@ -2656,7 +2665,7 @@ 
     /**
      * @param bool $get_as_float
      *
-     * @return mixed
+     * @return string
      */
     protected function microtime($get_as_float = false)
     {
@@ -2787,7 +2796,7 @@ 
      * Check whether the Crawling Protocol should be http or https
      *
      * @param $crawlerConfiguration
-     * @param $pageConfiguration
+     * @param boolean $pageConfiguration
      *
      * @return bool
      */

Unused Use Statements -1 removed lines

@@ -43,7 +43,6 @@
 use TYPO3\CMS\Backend\Tree\View\PageTreeView;
 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
 use TYPO3\CMS\Core\Database\ConnectionPool;
-use TYPO3\CMS\Core\Database\DatabaseConnection;
 use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
 use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
 use TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;

Classes/Hooks/ProcessCleanUpHook.php

Doc Comments -1 removed lines

@@ -60,7 +60,6 @@
     /**
      * Main function of process CleanUp Hook.
      *
-     * @param CrawlerController $crawlerController Crawler Lib class
      *
      * @return void
      */