Add types info

Author: mvdbos

example/lib/Example/LogHandler.php

@@ -20,7 +20,7 @@ public function __construct($debug = false)
         $this->debug = $debug;
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return array(
             SpiderEvents::SPIDER_CRAWL_FILTER_POSTFETCH => 'logFiltered',

example/lib/Example/StatsHandler.php

@@ -14,15 +14,15 @@
 class StatsHandler implements EventSubscriberInterface
 {
     /** @var string */
-    protected $spiderId;
+    protected string $spiderId;
 
-    protected $persisted = array();
+    protected array $persisted = array();
 
-    protected $queued = array();
+    protected array $queued = array();
 
-    protected $filtered = array();
+    protected array $filtered = array();
 
-    protected $failed = array();
+    protected array $failed = array();
 
     public static function getSubscribedEvents(): array
     {

src/Discoverer/CrawlerDiscoverer.php

@@ -17,11 +17,10 @@
  */
 abstract class CrawlerDiscoverer extends Discoverer implements DiscovererInterface
 {
-    /** @var string */
-    protected $selector;
+    protected string $selector;
 
     /**
-     * @param $selector
+     * @param string $selector
      */
     public function __construct(string $selector)
     {

src/Downloader/Downloader.php

@@ -19,16 +19,16 @@ class Downloader implements DownloaderInterface
     use DispatcherTrait;
 
     /** @var PersistenceHandlerInterface */
-    private $persistenceHandler;
+    private PersistenceHandlerInterface $persistenceHandler;
 
     /** @var RequestHandlerInterface */
-    private $requestHandler;
+    private RequestHandlerInterface $requestHandler;
 
     /** @var int the maximum number of downloaded resources. 0 means no limit */
-    private $downloadLimit = 0;
+    private int $downloadLimit = 0;
 
     /** @var PostFetchFilterInterface[] */
-    private $postFetchFilters = array();
+    private array $postFetchFilters = array();
 
     /**
      * Downloader constructor.
@@ -72,7 +72,7 @@ public function getDownloadLimit(): int
     /**
      * @param PostFetchFilterInterface $filter
      */
-    public function addPostFetchFilter(PostFetchFilterInterface $filter)
+    public function addPostFetchFilter(PostFetchFilterInterface $filter): void
     {
         $this->postFetchFilters[] = $filter;
     }
@@ -81,7 +81,7 @@ public function addPostFetchFilter(PostFetchFilterInterface $filter)
      * @param DiscoveredUri $uri
      * @return false|Resource
      */
-    public function download(DiscoveredUri $uri)
+    public function download(DiscoveredUri $uri): Resource|false
     {
         $resource = $this->fetchResource($uri);
 
@@ -109,7 +109,7 @@ public function isDownLoadLimitExceeded(): bool
      * @param GenericEvent $event
      * @param string $eventName
      */
-    private function dispatch(GenericEvent $event, string $eventName)
+    private function dispatch(GenericEvent $event, string $eventName): void
     {
         $this->getDispatcher()->dispatch($event, $eventName);
     }
@@ -118,7 +118,7 @@ private function dispatch(GenericEvent $event, string $eventName)
      * @param DiscoveredUri $uri
      * @return Resource|false
      */
-    protected function fetchResource(DiscoveredUri $uri)
+    protected function fetchResource(DiscoveredUri $uri): Resource|false
     {
         $resource = false;
 
@@ -162,7 +162,7 @@ private function matchesPostfetchFilter(Resource $resource): bool
     /**
      * @param PersistenceHandlerInterface $persistenceHandler
      */
-    public function setPersistenceHandler(PersistenceHandlerInterface $persistenceHandler)
+    public function setPersistenceHandler(PersistenceHandlerInterface $persistenceHandler): void
     {
         $this->persistenceHandler = $persistenceHandler;
     }
@@ -178,7 +178,7 @@ public function getPersistenceHandler(): PersistenceHandlerInterface
     /**
      * @param RequestHandlerInterface $requestHandler
      */
-    public function setRequestHandler(RequestHandlerInterface $requestHandler)
+    public function setRequestHandler(RequestHandlerInterface $requestHandler): void
     {
         $this->requestHandler = $requestHandler;
     }

src/Event/DispatcherTrait.php

@@ -8,15 +8,14 @@
 
 trait DispatcherTrait
 {
-    /** @var EventDispatcherInterface */
-    private $dispatcher;
+    private ?EventDispatcherInterface $dispatcher = null;
 
     /**
      * @return EventDispatcherInterface
      */
     public function getDispatcher(): EventDispatcherInterface
     {
-        if (!$this->dispatcher) {
+        if ($this->dispatcher == null) {
             $this->dispatcher = new EventDispatcher();
         }
 

src/EventListener/PolitenessPolicyListener.php

@@ -10,13 +10,12 @@
  */
 class PolitenessPolicyListener
 {
-    /** @var string */
-    private $previousHostname;
+    private ?string $previousHostname = null;
 
     /** @var int the delay in microseconds between requests to the same domain */
-    private $requestDelay;
+    private int $requestDelay;
 
-    public $totalDelay = 0;
+    public int $totalDelay = 0;
 
     /**
      * @param int $requestDelay the delay in milliseconds between requests to the same domain
@@ -29,7 +28,7 @@ public function __construct(int $requestDelay)
     /**
      * @param GenericEvent $event
      */
-    public function onCrawlPreRequest(GenericEvent $event)
+    public function onCrawlPreRequest(GenericEvent $event): void
     {
         $currentHostname = $event->getArgument('uri')->getHost();
 

src/Filter/Postfetch/MimeTypeFilter.php

@@ -10,7 +10,7 @@
  */
 class MimeTypeFilter implements PostFetchFilterInterface
 {
-    protected $allowedMimeType = '';
+    protected string $allowedMimeType = '';
 
     public function __construct($allowedMimeType)
     {

src/Filter/PreFetchFilterInterface.php

@@ -10,6 +10,7 @@
 interface PreFetchFilterInterface
 {
     /**
+     * Returns true of the URI should be filtered out, i.e. NOT be crawled.
      * @param UriInterface $uri
      * @return boolean
      */

src/Filter/Prefetch/AllowedHostsFilter.php

@@ -11,9 +11,9 @@
 class AllowedHostsFilter implements PreFetchFilterInterface
 {
     /** @var array The hostnames to filter links with */
-    private $allowedHosts;
+    private array $allowedHosts;
 
-    private $allowSubDomains;
+    private bool $allowSubDomains;
 
     /**
      * @param string[] $seeds

src/Filter/Prefetch/AllowedPortsFilter.php

@@ -13,7 +13,7 @@ class AllowedPortsFilter implements PreFetchFilterInterface
     /**
      * @var array
      */
-    private $allowedPorts;
+    private array $allowedPorts;
 
     /**
      * The whitelist of allowed ports