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

modfunc1/class.tx_crawler_modfunc1.php

Braces +6 added lines, -4 removed lines

@@ -1054,8 +1054,9 @@ 
 		$isAvailable = false;
 		$userArray = \TYPO3\CMS\Backend\Utility\BackendUtility::getRecordsByField('be_users', 'username', '_cli_crawler');
 
-		if (is_array($userArray))
-			$isAvailable = true;
+		if (is_array($userArray)) {
+					$isAvailable = true;
+		}
 
 		return $isAvailable;
 	}
@@ -1073,8 +1074,9 @@ 
 		$isAvailable = false;
 		$userArray = \TYPO3\CMS\Backend\Utility\BackendUtility::getRecordsByField('be_users', 'username', '_cli_crawler');
 
-		if (is_array($userArray) && $userArray[0]['admin'] == 0)
-			$isAvailable = true;
+		if (is_array($userArray) && $userArray[0]['admin'] == 0) {
+					$isAvailable = true;
+		}
 
 		return $isAvailable;
 	}

template/pagination.php

Braces +4 added lines, -1 removed lines

@@ -1,4 +1,7 @@
-<?php if (!defined('TYPO3_MODE')) die ('Access denied.'); ?>
+<?php if (!defined('TYPO3_MODE')) {
+    die ('Access denied.');
+}
+?>
 
 Page:
 <?php for($currentPageOffset 	= 0; $currentPageOffset < $this->getTotalPagesCount(); $currentPageOffset++ ){  ?>

template/process/list.php

Braces +9 added lines, -3 removed lines

@@ -1,4 +1,7 @@ 
-<?php if (!defined('TYPO3_MODE')) die ('Access denied.'); ?>
+<?php if (!defined('TYPO3_MODE')) {
+    die ('Access denied.');
+}
+?>
 
 <br />
 <div id="controll-panel">
@@ -69,8 +72,11 @@ 
 					</div>
 				<?php elseif ($process->getState() == 'cancelled'): ?>
 					<?php echo $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.process.cancelled'); ?>
-				<?php else: ?>
-					<?php echo $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.process.success'); ?>
+				<?php else {
+    : ?>
+					<?php echo $this->getLLLabel('LLL:EXT:crawler/modfunc1/locallang.xml:labels.process.success');
+}
+?>
 				<?php endif; ?>
 				</td>
 			</tr>

Classes/Hooks/TsfeHook.php

Braces +3 added lines, -1 removed lines

@@ -76,7 +76,9 @@
         if ($params['pObj']->applicationData['tx_crawler']['running']) {
             $grList = $params['pObj']->applicationData['tx_crawler']['parameters']['feUserGroupList'];
             if ($grList) {
-                if (!is_array($params['pObj']->fe_user->user)) $params['pObj']->fe_user->user = array();
+                if (!is_array($params['pObj']->fe_user->user)) {
+                    $params['pObj']->fe_user->user = array();
+                }
                 $params['pObj']->fe_user->user['usergroup'] = $grList;
                 $params['pObj']->applicationData['tx_crawler']['log'][] = 'User Groups: '.$grList;
             }

class.tx_crawler_lib.php

Doc Comments +21 added lines, -7 removed lines

@@ -424,7 +424,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)) {
@@ -632,6 +632,9 @@ 
         return $baseUrl;
     }
 
+    /**
+     * @param integer $rootid
+     */
     function getConfigurationsForBranch($rootid, $depth) {
 
         $configurationsForBranch = array();
@@ -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.
      */
     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 = array()) {
@@ -1031,6 +1035,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
      */
     function addUrl (
@@ -1106,7 +1112,6 @@ 
      * If the timestamp is in the future it will check, if the queued entry has exactly the same timestamp
      *
      * @param int $tstamp
-     * @param string $parameters
      * @author Fabrizio Branca
      * @author Timo Schmidt
      * @return array;
@@ -1470,6 +1475,7 @@ 
 
     /**
      * @param message
+     * @param string $message
      */
     protected function log($message) {
         if (!empty($this->extensionSettings['logFileName'])) {
@@ -1483,7 +1489,7 @@ 
      * @param array $url
      * @param string $crawlerId
      *
-     * @return array
+     * @return string[]
      */
     protected function buildRequestHeaderArray(array $url, $crawlerId) {
         $reqHeaders = array();
@@ -1586,6 +1592,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(
@@ -1740,6 +1752,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)    {
@@ -2040,7 +2053,7 @@ 
     /**
      * Function executed by crawler_im.php cli script.
      *
-     * @return bool
+     * @return null|boolean
      */
     function CLI_main_flush() {
         $this->setAccessMode('cli_flush');
@@ -2097,7 +2110,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;
@@ -2369,6 +2382,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.
@@ -2406,7 +2420,7 @@ 
     /**
      * @param bool $get_as_float
      *
-     * @return mixed
+     * @return string
      */
     protected function microtime($get_as_float = false )
     {

Braces +48 added lines, -18 removed lines

@@ -642,7 +642,9 @@ 
             $sets = $pageTSconfig['tx_crawler.']['crawlerCfg.']['paramSets.'];
             if(is_array($sets)) {
                 foreach($sets as $key=>$value) {
-                    if(!is_array($value)) continue;
+                    if(!is_array($value)) {
+                        continue;
+                    }
                     $configurationsForBranch[] = substr($key,-1)=='.'?substr($key,0,-1):$key;
                 }
 
@@ -990,7 +992,9 @@ 
      */
     function addQueueEntry_callBack($setId,$params,$callBack,$page_id=0,$schedule=0) {
 
-        if (!is_array($params))    $params = array();
+        if (!is_array($params)) {
+            $params = array();
+        }
         $params['_CALLBACKOBJ'] = $callBack;
 
             // Compile value array:
@@ -1092,7 +1096,7 @@ 
                 $rows[] = $uid;
                 $urlAdded = true;
                 tx_crawler_domain_events_dispatcher::getInstance()->post('urlAddedToQueue',$this->setID,array('uid' => $uid, 'fieldArray' => $fieldArray));
-            }else{
+            } else{
                 tx_crawler_domain_events_dispatcher::getInstance()->post('duplicateUrlInQueue',$this->setID,array('rows' => $rows, 'fieldArray' => $fieldArray));
             }
         }
@@ -1122,7 +1126,7 @@ 
                 $timeBegin     = $currentTime - 100;
                 $timeEnd     = $currentTime + 100;
                 $where         = ' ((scheduled BETWEEN '.$timeBegin.' AND '.$timeEnd.' ) OR scheduled <= '. $currentTime.') ';
-            }else{
+            } else{
                 $where = 'scheduled <= ' . $currentTime;
             }
         } elseif ($tstamp > $currentTime) {
@@ -1314,18 +1318,24 @@ 
      */
     function requestUrl($originalUrl, $crawlerId, $timeout=2, $recursion=10) {
 
-        if (!$recursion) return false;
+        if (!$recursion) {
+            return false;
+        }
 
             // Parse URL, checking for scheme:
         $url = parse_url($originalUrl);
 
         if ($url === FALSE) {
-            if (TYPO3_DLOG) \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf('Could not parse_url() for string "%s"', $url), 'crawler', 4, array('crawlerId' => $crawlerId));
+            if (TYPO3_DLOG) {
+                \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf('Could not parse_url() for string "%s"', $url), 'crawler', 4, array('crawlerId' => $crawlerId));
+            }
             return FALSE;
         }
 
         if (!in_array($url['scheme'], array('','http','https'))) {
-            if (TYPO3_DLOG) \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf('Scheme does not match for url "%s"', $url), 'crawler', 4, array('crawlerId' => $crawlerId));
+            if (TYPO3_DLOG) {
+                \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf('Scheme does not match for url "%s"', $url), 'crawler', 4, array('crawlerId' => $crawlerId));
+            }
             return FALSE;
         }
 
@@ -1359,7 +1369,9 @@ 
         $fp = fsockopen($host, $port, $errno, $errstr, $timeout);
 
         if (!$fp) {
-            if (TYPO3_DLOG) \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf('Error while opening "%s"', $url), 'crawler', 4, array('crawlerId' => $crawlerId));
+            if (TYPO3_DLOG) {
+                \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf('Error while opening "%s"', $url), 'crawler', 4, array('crawlerId' => $crawlerId));
+            }
             return FALSE;
         } else {
                 // Request message:
@@ -1387,7 +1399,9 @@ 
                 if (is_array($newRequestUrl)) {
                     $result = array_merge(array('parentRequest'=>$result), $newRequestUrl);
                 } else {
-                    if (TYPO3_DLOG) \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf('Error while opening "%s"', $url), 'crawler', 4, array('crawlerId' => $crawlerId));
+                    if (TYPO3_DLOG) {
+                        \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf('Error while opening "%s"', $url), 'crawler', 4, array('crawlerId' => $crawlerId));
+                    }
                     return FALSE;
                 }
             }
@@ -1510,20 +1524,32 @@ 
      * @return    string        URL from redirection
      */
     protected function getRequestUrlFrom302Header($headers,$user='',$pass='') {
-        if(!is_array($headers)) return false;
-        if(!(stristr($headers[0],'301 Moved') || stristr($headers[0],'302 Found') || stristr($headers[0],'302 Moved'))) return false;
+        if(!is_array($headers)) {
+            return false;
+        }
+        if(!(stristr($headers[0],'301 Moved') || stristr($headers[0],'302 Found') || stristr($headers[0],'302 Moved'))) {
+            return false;
+        }
 
         foreach($headers as $hl) {
             $tmp = explode(": ",$hl);
             $header[trim($tmp[0])] = trim($tmp[1]);
-            if(trim($tmp[0])=='Location') break;
+            if(trim($tmp[0])=='Location') {
+                break;
+            }
+        }
+        if(!array_key_exists('Location',$header)) {
+            return false;
         }
-        if(!array_key_exists('Location',$header)) return false;
 
         if($user!='') {
-            if(!($tmp = parse_url($header['Location']))) return false;
+            if(!($tmp = parse_url($header['Location']))) {
+                return false;
+            }
             $newUrl = $tmp['scheme'] . '://' . $user . ':' . $pass . '@' . $tmp['host'] . $tmp['path'];
-            if($tmp['query']!='') $newUrl .= '?' . $tmp['query'];
+            if($tmp['query']!='') {
+                $newUrl .= '?' . $tmp['query'];
+            }
         } else {
             $newUrl = $header['Location'];
         }
@@ -1974,7 +2000,7 @@ 
             $configurations = $this->getUrlsForPageId($pageId);
             if(is_array($configurations)){
                 $configurationKeys = array_keys($configurations);
-            }else{
+            } else{
                 $configurationKeys = array();
             }
         }
@@ -2306,7 +2332,9 @@ 
             return false;   //nothing to release
         }
 
-        if(!$withinLock) $this->db->sql_query('BEGIN');
+        if(!$withinLock) {
+            $this->db->sql_query('BEGIN');
+        }
 
             // some kind of 2nd chance algo - this way you need at least 2 processes to have a real cleanup
             // this ensures that a single process can't mess up the entire process table
@@ -2350,7 +2378,9 @@ 
             )
         );
 
-        if(!$withinLock) $this->db->sql_query('COMMIT');
+        if(!$withinLock) {
+            $this->db->sql_query('COMMIT');
+        }
 
         return true;
     }

cli/crawler_flush.php

Braces +3 added lines, -1 removed lines

@@ -1,5 +1,7 @@
 <?php
-if (!defined('TYPO3_REQUESTTYPE')) die('You cannot run this script directly!');
+if (!defined('TYPO3_REQUESTTYPE')) {
+    die('You cannot run this script directly!');
+}
 
 $crawlerObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('tx_crawler_lib');
 $crawlerObj->CLI_main_flush($_SERVER["argv"]);

cli/crawler_im.php

Braces +3 added lines, -1 removed lines

@@ -1,5 +1,7 @@
 <?php
-if (!defined('TYPO3_REQUESTTYPE')) die('You cannot run this script directly!');
+if (!defined('TYPO3_REQUESTTYPE')) {
+    die('You cannot run this script directly!');
+}
 
 $crawlerObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('tx_crawler_lib');
 $crawlerObj->CLI_main_im($_SERVER["argv"]);