AOEpeople / crawler

Classes/Controller/CrawlerController.php

Doc Comments +12 added lines, -6 removed lines

@@ -430,6 +430,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)
      *
      */
@@ -512,7 +516,7 @@ 
      *
      * @param string $piString PI to test
      * @param array $incomingProcInstructions Processing instructions
-     * @return boolean
+     * @return boolean|null
      */
     public function drawURLs_PIfilter($piString, array $incomingProcInstructions)
     {
@@ -734,7 +738,7 @@ 
     }
 
     /**
-     * @param $rootid
+     * @param integer $rootid
      * @param $depth
      * @return array
      *
@@ -997,7 +1001,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 = [])
@@ -1756,7 +1760,7 @@ 
      * @param array $url
      * @param string $crawlerId
      *
-     * @return array
+     * @return string[]
      */
     protected function buildRequestHeaderArray(array $url, $crawlerId)
     {
@@ -2034,6 +2038,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)
@@ -2224,7 +2229,7 @@ 
      * @param int $countInARun
      * @param int $sleepTime
      * @param int $sleepAfterFinish
-     * @return string
+     * @return integer
      */
     public function CLI_run($countInARun, $sleepTime, $sleepAfterFinish)
     {
@@ -2526,6 +2531,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
      *
      * TODO: Please consider moving this to Domain Model for Process or in ProcessRepository
@@ -2687,7 +2693,7 @@ 
      * Check whether the Crawling Protocol should be http or https
      *
      * @param $crawlerConfiguration
-     * @param $pageConfiguration
+     * @param boolean $pageConfiguration
      *
      * @return bool
      */