AOEpeople / crawler

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
      */