AOEpeople / crawler

Classes/Controller/CrawlerController.php

Doc Comments +25 added lines, -15 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)
     {
@@ -716,6 +720,9 @@ 
         return $baseUrl;
     }
 
+    /**
+     * @param integer $rootid
+     */
     public function getConfigurationsForBranch($rootid, $depth)
     {
         $configurationsForBranch = [];
@@ -937,7 +944,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 = [])
@@ -1573,6 +1580,7 @@ 
 
     /**
      * @param message
+     * @param string $message
      */
     protected function log($message)
     {
@@ -1590,7 +1598,7 @@ 
      * @param array $url
      * @param string $crawlerId
      *
-     * @return array
+     * @return string[]
      */
     protected function buildRequestHeaderArray(array $url, $crawlerId)
     {
@@ -1850,6 +1858,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)
@@ -2138,7 +2147,7 @@ 
     /**
      * Function executed by crawler_im.php cli script.
      *
-     * @return bool
+     * @return null|boolean
      */
     public function CLI_main_flush()
     {
@@ -2197,7 +2206,7 @@ 
      * @param int $countInARun
      * @param int $sleepTime
      * @param int $sleepAfterFinish
-     * @return string
+     * @return integer
      */
     public function CLI_run($countInARun, $sleepTime, $sleepAfterFinish)
     {
@@ -2475,6 +2484,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.
@@ -2515,7 +2525,7 @@ 
     /**
      * @param bool $get_as_float
      *
-     * @return mixed
+     * @return string
      */
     protected function microtime($get_as_float = false)
     {
@@ -2633,9 +2643,9 @@ 
     }
 
     /**
-     * @param $forceSsl
+     * @param boolean $forceSsl
      * @param $configurationRecord
-     * @param $TSparserObject
+     * @param \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser $TSparserObject
      * @param $key
      * @return array
      */
@@ -2660,11 +2670,11 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @param array $subCfg
-     * @param $tstamp
-     * @param $configurationHash
-     * @param $parameters_serialized
+     * @param integer $tstamp
+     * @param string $configurationHash
+     * @param string $parameters_serialized
      * @return array
      */
     protected function getFieldArray($id, array $subCfg, $tstamp, $configurationHash, $parameters_serialized)
@@ -2684,8 +2694,8 @@ 
     }
 
     /**
-     * @param $queueId
-     * @param $force
+     * @param integer $queueId
+     * @param boolean $force
      * @return mixed
      */
     protected function getEntry($queueId, $force)
@@ -2699,7 +2709,7 @@ 
     }
 
     /**
-     * @param $queueId
+     * @param integer $queueId
      * @param $field_array
      */
     private function updateQueueItem($queueId, $field_array)