AOEpeople / crawler

class.tx_crawler_lib.php

Doc Comments +19 added lines, -7 removed lines

@@ -420,7 +420,7 @@ 
      * @param string $piString                     PI to test
      * @param array $incomingProcInstructions     Processing instructions
      *
-     * @return boolean                              TRUE if found
+     * @return boolean|null                              TRUE if found
      */
     public function drawURLs_PIfilter($piString, array $incomingProcInstructions) {
         if (empty($incomingProcInstructions)) {
@@ -626,7 +626,7 @@ 
     }
 
     /**
-     * @param $rootId
+     * @param integer $rootId
      * @param $depth
      *
      * @return array
@@ -732,6 +732,7 @@ 
      *
      * @param    array        Array with key (GET var name) and values (value of GET var which is configuration for expansion)
      * @param    integer        Current page ID
+     * @param integer $pid
      * @return    array        Array with key (GET var name) with the value being an array of all possible values for that key.
      */
     protected function expandParameters($paramArray, $pid)    {
@@ -850,7 +851,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                URLs accumulated, if number of urls exceed 'maxCompileUrls' it will return false as an error!
      */
     public function compileUrls($paramArray, $urls = array()) {
@@ -1018,6 +1019,8 @@ 
      * @param    integer        Scheduled-time
      * @param     string        (optional) configuration hash
      * @param     bool        (optional) skip inner duplication check
+     * @param string $url
+     * @param double $tstamp
      * @return    bool        true if the url was added, false if it already existed
      */
     protected function addUrl (
@@ -1457,6 +1460,7 @@ 
 
     /**
      * @param message
+     * @param string $message
      */
     protected function log($message) {
         if (!empty($this->extensionSettings['logFileName'])) {
@@ -1470,7 +1474,7 @@ 
      * @param array $url
      * @param string $crawlerId
      *
-     * @return array
+     * @return string[]
      */
     protected function buildRequestHeaderArray(array $url, $crawlerId) {
         $reqHeaders = array();
@@ -1564,6 +1568,12 @@ 
      * @param    boolean        If set (and submitcrawlUrls is false) will fill $downloadUrls with entries)
      * @param    array        Array of processing instructions
      * @param    array        Array of configuration keys
+     * @param integer $id
+     * @param integer $depth
+     * @param integer $scheduledTime
+     * @param integer $reqMinute
+     * @param boolean $submitCrawlUrls
+     * @param boolean $downloadCrawlUrls
      * @return    string        HTML code
      */
     function getPageTreeAndUrls(
@@ -1712,6 +1722,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)    {
@@ -2012,7 +2023,7 @@ 
     /**
      * Function executed by crawler_im.php cli script.
      *
-     * @return bool
+     * @return null|boolean
      */
     function CLI_main_flush() {
         $this->setAccessMode('cli_flush');
@@ -2069,7 +2080,7 @@ 
      * @param  int $countInARun
      * @param  int $sleepTime
      * @param  int $sleepAfterFinish
-     * @return string                   Status message
+     * @return integer                   Status message
      */
     public function CLI_run($countInARun, $sleepTime, $sleepAfterFinish) {
         $result = 0;
@@ -2341,6 +2352,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.
@@ -2378,7 +2390,7 @@ 
     /**
      * @param bool $get_as_float
      *
-     * @return mixed
+     * @return string
      */
     protected function microtime($get_as_float = false )
     {