Spatie\Crawler\CrawlQueue\ArrayCrawlQueue

Complexity

Total Complexity

14

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	add()	0	13	2
A	hasPendingUrls()	0	4	1
A	getUrlById()	0	8	2
A	hasAlreadyBeenProcessed()	0	6	2
A	markAsProcessed()	0	6	1
A	has()	0	17	4
A	getFirstPendingUrl()	0	8	2

<?php

namespace Spatie\Crawler\CrawlQueue;

use TypeError;
use Spatie\Crawler\CrawlUrl;
use Psr\Http\Message\UriInterface;
use Spatie\Crawler\Exception\UrlNotFoundByIndex;

/**
 * Crawl queue implemented with arrays.
 */
class ArrayCrawlQueue implements CrawlQueue
{
    /**
     * All known URLs, indexed by URL string.
     *
     * @var CrawlUrl[]
     */
    protected $urls = [];

    /**
     * Pending URLs, indexed by URL string.
     *
     * @var CrawlUrl[]
     */
    protected $pendingUrls = [];

    public function add(CrawlUrl $url) : CrawlQueue
    {
        $urlString = (string) $url->url;

        if (! isset($this->urls[$urlString])) {
            $url->setId($urlString);

            $this->urls[$urlString] = $url;
            $this->pendingUrls[$urlString] = $url;
        }

        return $this;
    }

    public function hasPendingUrls() : bool
    {
        return (bool) $this->pendingUrls;
    }

    public function getUrlById($id) : CrawlUrl
    {
        if (! isset($this->urls[$id])) {
            throw new UrlNotFoundByIndex("Crawl url $id not found in collection.");
        }

        return $this->urls[$id];
    }

    public function hasAlreadyBeenProcessed(CrawlUrl $url) : bool
    {
        $url = (string) $url->url;

        return ! isset($this->pendingUrls[$url]) && isset($this->pendingUrls[$url]);
    }

    public function markAsProcessed(CrawlUrl $crawlUrl)
    {
        $url = (string) $crawlUrl->url;

        unset($this->pendingUrls[$url]);
    }

    /**
     * @param CrawlUrl|UriInterface $crawlUrl
     *
     * @return bool
     */
    public function has($crawlUrl) : bool
    {
        if ($crawlUrl instanceof CrawlUrl) {
            $url = (string) $crawlUrl->url;
        } elseif ($crawlUrl instanceof UriInterface) {
            $url = (string) $crawlUrl;
        } else {
            throw new TypeError(sprintf(

The call to TypeError::__construct() has too many arguments starting with sprintf('Expected %s or %s, got %s.', \Spatie\Crawler\CrawlUrl::class, \Psr\Http\Message\UriInterface::class, is_object($crawlUrl) ? get_class($crawlUrl) : gettype($crawlUrl)).

                'Expected %s or %s, got %s.',
                CrawlUrl::class,
                UriInterface::class,
                is_object($crawlUrl) ? get_class($crawlUrl) : gettype($crawlUrl)
            ));
        }

        return isset($this->urls[$url]);
    }

    public function getFirstPendingUrl() : ?CrawlUrl
    {
        foreach ($this->pendingUrls as $pendingUrl) {
            return $pendingUrl;
        }

        return null;
    }
}