AOEpeople / crawler

class.tx_crawler_lib.php

Doc Comments +12 added lines, -6 removed lines

@@ -475,7 +475,7 @@ 
      *
      * @param string $piString PI to test
      * @param array $incomingProcInstructions Processing instructions
-     * @return boolean
+     * @return boolean|null
      */
     public function drawURLs_PIfilter($piString, array $incomingProcInstructions)
     {
@@ -685,6 +685,9 @@ 
         return $baseUrl;
     }
 
+    /**
+     * @param integer $rootid
+     */
     public function getConfigurationsForBranch($rootid, $depth)
     {
         $configurationsForBranch = [];
@@ -906,7 +909,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 = [])
@@ -1556,6 +1559,7 @@ 
 
     /**
      * @param message
+     * @param string $message
      */
     protected function log($message)
     {
@@ -1570,7 +1574,7 @@ 
      * @param array $url
      * @param string $crawlerId
      *
-     * @return array
+     * @return string[]
      */
     protected function buildRequestHeaderArray(array $url, $crawlerId)
     {
@@ -1826,6 +1830,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)
@@ -2114,7 +2119,7 @@ 
     /**
      * Function executed by crawler_im.php cli script.
      *
-     * @return bool
+     * @return null|boolean
      */
     public function CLI_main_flush()
     {
@@ -2173,7 +2178,7 @@ 
      * @param int $countInARun
      * @param int $sleepTime
      * @param int $sleepAfterFinish
-     * @return string
+     * @return integer
      */
     public function CLI_run($countInARun, $sleepTime, $sleepAfterFinish)
     {
@@ -2448,6 +2453,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.
@@ -2488,7 +2494,7 @@ 
     /**
      * @param bool $get_as_float
      *
-     * @return mixed
+     * @return string
      */
     protected function microtime($get_as_float = false)
     {