AOEpeople / crawler

Classes/Hooks/StaticFileCacheCreateUriHook.php

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
      * @param string $uri
      * @param TypoScriptFrontendController $frontend
      *
-     * @return array
+     * @return string[]
      *
      * @throws \Exception
      *

Classes/Api/CrawlerApi.php

Doc Comments +1 added lines, -1 removed lines

@@ -209,7 +209,7 @@
     /**
      * Determines if a page is queued
      *
-     * @param $uid
+     * @param integer $uid
      * @param bool $unprocessed_only
      * @param bool $timed_only
      * @param bool $timestamp

cli/class.tx_crawler_cli_im.php

Indentation +5 added lines, -5 removed lines

@@ -49,11 +49,11 @@
 
         // Adding options to help archive:
         /**
-        * We removed the "proc" option as it seemd not to be working any more. But as the complete handling of the crawler has changed regarding the configuration
-        * this is completely ok. Since configuration records were introduced to configure "what should be done" additionally to page ts the way to setup jobs
-        * has drifted from selecting filtering processing instructions to selecting/filtering configuration keys (you can configure the processing instructions there).
-        * This is also reflected in the backend modules and allows you a much clearer and powerful way to work with the crawler extension.
-        */
+         * We removed the "proc" option as it seemd not to be working any more. But as the complete handling of the crawler has changed regarding the configuration
+         * this is completely ok. Since configuration records were introduced to configure "what should be done" additionally to page ts the way to setup jobs
+         * has drifted from selecting filtering processing instructions to selecting/filtering configuration keys (you can configure the processing instructions there).
+         * This is also reflected in the backend modules and allows you a much clearer and powerful way to work with the crawler extension.
+         */
         // $this->cli_options[] = array('-proc listOfProcInstr', 'Comma list of processing instructions. These are the "actions" carried out when crawling and you must specify at least one. Depends on third-party extensions. Examples are "tx_cachemgm_recache" from "cachemgm" extension (will recache pages), "tx_staticpub_publish" from "staticpub" (publishing pages to static files) or "tx_indexedsearch_reindex" from "indexed_search" (indexes pages).');
         // TODO: cleanup here!
         $this->cli_options[] = ['-d depth', 'Tree depth, 0-99', "How many levels under the 'page_id' to include."];

view/process/class.tx_crawler_view_process_list.php

Doc Comments +3 added lines, -3 removed lines

@@ -311,7 +311,7 @@ 
     /**
      * Returns a tag for the refresh icon
      *
-     * @return string
+     * @return AOE\Crawler\Utility\ButtonUtility
      */
     protected function getRefreshLink()
     {
@@ -325,7 +325,7 @@ 
     /**
      * Returns a link for the panel to enable or disable the crawler
      *
-     * @return string
+     * @return AOE\Crawler\Utility\ButtonUtility
      */
     protected function getEnableDisableLink()
     {
@@ -351,7 +351,7 @@ 
      *
      * @param void
      *
-     * @return string a-tag
+     * @return AOE\Crawler\Utility\ButtonUtility|null a-tag
      */
     protected function getModeLink()
     {

class.tx_crawler_lib.php

Doc Comments +21 added lines, -6 removed lines

@@ -422,7 +422,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)
     {
@@ -632,6 +632,9 @@ 
         return $baseUrl;
     }
 
+    /**
+     * @param integer $rootid
+     */
     public function getConfigurationsForBranch($rootid, $depth)
     {
         $configurationsForBranch = [];
@@ -735,6 +738,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.
      */
     public function expandParameters($paramArray, $pid)
@@ -853,7 +857,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 = [])
@@ -1033,6 +1037,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
      */
     public function addUrl(
@@ -1503,6 +1509,7 @@ 
 
     /**
      * @param message
+     * @param string $message
      */
     protected function log($message)
     {
@@ -1517,7 +1524,7 @@ 
      * @param array $url
      * @param string $crawlerId
      *
-     * @return array
+     * @return string[]
      */
     protected function buildRequestHeaderArray(array $url, $crawlerId)
     {
@@ -1626,6 +1633,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
      */
     public function getPageTreeAndUrls(
@@ -1773,6 +1786,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)
@@ -2064,7 +2078,7 @@ 
     /**
      * Function executed by crawler_im.php cli script.
      *
-     * @return bool
+     * @return null|boolean
      */
     public function CLI_main_flush()
     {
@@ -2123,7 +2137,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)
     {
@@ -2398,6 +2412,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.
@@ -2438,7 +2453,7 @@ 
     /**
      * @param bool $get_as_float
      *
-     * @return mixed
+     * @return string
      */
     protected function microtime($get_as_float = false)
     {

domain/queue/class.tx_crawler_domain_queue_repository.php

Indentation +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
     {
         $db = $this->getDB();
         $where = 'process_id_completed=' . $db->fullQuoteStr($process->getProcess_id(), $this->tableName) .
-                   ' AND exec_time > 0 ';
+                    ' AND exec_time > 0 ';
         $limit = 1;
         $groupby = '';