Spatie\Sitemap\SitemapGenerator

Complexity

Total Complexity

11

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	__construct()	0	14	1
A	setUrl()	0	6	1
A	shouldCrawl()	0	6	1
A	hasCrawled()	0	6	1
A	getSitemap()	0	9	1
A	writeToFile()	0	6	1
A	getCrawlProfile()	0	12	2
A	getCrawlObserver()	0	12	2

<?php

namespace Spatie\Sitemap;

use Psr\Http\Message\ResponseInterface;
use Spatie\Crawler\Crawler;
use Spatie\Crawler\Url as CrawlerUrl;
use Spatie\Sitemap\Crawler\Observer;
use Spatie\Sitemap\Crawler\Profile;
use Spatie\Sitemap\Tags\Url;

class SitemapGenerator
{
    /** @var string */
    protected $url = '';

    /** @var \Spatie\Crawler\Crawler */
    protected $crawler;

    /** @var callable */
    protected $shouldCrawl;

    /** @var callable */
    protected $hasCrawled;

    /** @var \Spatie\Sitemap\Sitemap */
    protected $sitemap;

    /**
     * @param string $url
     *
     * @return static
     */
    public static function create(string $url)
    {
        return app(static::class)->setUrl($url);
    }

    public function __construct(Crawler $crawler)
    {
        $this->crawler = $crawler;

        $this->sitemap = new Sitemap();

        $this->shouldCrawl = function (CrawlerUrl $url) {

The parameter $url is not used and could be removed.

            return true;
        };

        $this->hasCrawled = function (Url $url, ResponseInterface $response = null) {

The parameter $response is not used and could be removed.

            return $url;
        };
    }

    public function setUrl(string $url)
    {
        $this->url = $url;

        return $this;
    }

    public function shouldCrawl(callable $shouldCrawl)
    {
        $this->shouldCrawl = $shouldCrawl;

        return $this;
    }

    public function hasCrawled(callable $hasCrawled)
    {
        $this->hasCrawled = $hasCrawled;

        return $this;
    }

    /**
     * @return \Spatie\Sitemap\Sitemap
     */
    public function getSitemap()
    {
        $this->crawler
            ->setCrawlProfile($this->getCrawlProfile())
            ->setCrawlObserver($this->getCrawlObserver())
            ->startCrawling($this->url);

        return $this->sitemap;
    }

    public function writeToFile(string $path)
    {
        $this->getSitemap()->writeToFile($path);

        return $this;
    }

    protected function getCrawlProfile(): Profile
    {
        $shouldCrawl = function(CrawlerUrl $url) {
            if ($url->host !== CrawlerUrl::create($this->url)->host) {
                return false;
            }

            return $this->shouldCrawl;
        };

        return new Profile($shouldCrawl);
    }

    protected function getCrawlObserver(): Observer
    {
        $performAfterUrlHasBeenCrawled = function (CrawlerUrl $crawlerUrl, ResponseInterface $response = null) {
            $sitemapUrl = ($this->hasCrawled)(Url::create((string) $crawlerUrl), $response);

            if ($sitemapUrl) {
                $this->sitemap->add($sitemapUrl);
            }
        };

        return new Observer($performAfterUrlHasBeenCrawled);
    }
}