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

Classes/Api/CrawlerApi.php

Doc Comments +2 added lines, -2 removed lines

@@ -223,7 +223,7 @@ 
     /**
      * Determines if a page is queued
      *
-     * @param $uid
+     * @param integer $uid
      * @param bool $unprocessed_only
      * @param bool $timed_only
      * @param bool $timestamp
@@ -304,7 +304,7 @@ 
      * scheduled but have note been crawled yet.
      *
      * @param int $uid uid of the page
-     * @param bool $limit
+     * @param integer $limit
      *
      * @return array array with the crawl-history of a page => 0 : scheduled time , 1 : executed_time, 2 : set_id
      */

Classes/Controller/CrawlerController.php

Doc Comments +17 added lines, -7 removed lines

@@ -396,6 +396,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)
      *
      */
@@ -520,7 +524,7 @@ 
      *
      * @param string $piString PI to test
      * @param array $incomingProcInstructions Processing instructions
-     * @return boolean
+     * @return boolean|null
      */
     public function drawURLs_PIfilter($piString, array $incomingProcInstructions)
     {
@@ -732,6 +736,9 @@ 
         return $baseUrl;
     }
 
+    /**
+     * @param integer $rootid
+     */
     public function getConfigurationsForBranch($rootid, $depth)
     {
         $configurationsForBranch = [];
@@ -953,7 +960,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 = [])
@@ -1606,6 +1613,7 @@ 
 
     /**
      * @param message
+     * @param string $message
      */
     protected function log($message)
     {
@@ -1623,7 +1631,7 @@ 
      * @param array $url
      * @param string $crawlerId
      *
-     * @return array
+     * @return string[]
      */
     protected function buildRequestHeaderArray(array $url, $crawlerId)
     {
@@ -1883,6 +1891,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)
@@ -2171,7 +2180,7 @@ 
     /**
      * Function executed by crawler_im.php cli script.
      *
-     * @return bool
+     * @return null|boolean
      */
     public function CLI_main_flush()
     {
@@ -2230,7 +2239,7 @@ 
      * @param int $countInARun
      * @param int $sleepTime
      * @param int $sleepAfterFinish
-     * @return string
+     * @return integer
      */
     public function CLI_run($countInARun, $sleepTime, $sleepAfterFinish)
     {
@@ -2508,6 +2517,7 @@ 
      * Used to determine timeouts and to ensure a proper cleanup if there's a timeout
      *
      * @param  string  identification string for the process
+     * @param string $pid
      * @return boolean determines if the process is still active / has resources
      *
      * FIXME: Please remove Transaction, not needed as only a select query.
@@ -2548,7 +2558,7 @@ 
     /**
      * @param bool $get_as_float
      *
-     * @return mixed
+     * @return string
      */
     protected function microtime($get_as_float = false)
     {
@@ -2669,7 +2679,7 @@ 
      * Check whether the Crawling Protocol should be http or https
      *
      * @param $crawlerConfiguration
-     * @param $pageConfiguration
+     * @param boolean $pageConfiguration
      *
      * @return bool
      */