Spatie\LinkChecker\Reporters\BaseReporter

Complexity

Total Complexity

7

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	willCrawl()	0	3	1
A	crawledBadUrls()	0	6	1
A	hasBeenCrawled()	0	10	3
A	isSuccessOrRedirect()	0	4	1
A	isExcludedStatusCode()	0	6	1

<?php

namespace Spatie\LinkChecker\Reporters;

use Spatie\Crawler\CrawlObserver;
use Spatie\Crawler\Url;

abstract class BaseReporter implements CrawlObserver
{
    const UNRESPONSIVE_HOST = 'Host did not respond';

    /**
     * @var array
     */
    protected $urlsGroupedByStatusCode = [];

    /**
     * Called when the crawler will crawl the url.
     *
     * @param \Spatie\Crawler\Url $url
     */
    public function willCrawl(Url $url)
    {
    }

    /**
     * Called when the crawler has crawled the given url.
     *
     * @param \Spatie\Crawler\Url                      $url
     * @param \Psr\Http\Message\ResponseInterface|null $response
     * @param \Spatie\Crawler\Url $foundOnUrl
     *
     * @return string
     */
    public function hasBeenCrawled(Url $url, $response, Url $foundOnUrl = null)
    {
        $statusCode = $response ? $response->getStatusCode() : static::UNRESPONSIVE_HOST;

        if (!$this->isExcludedStatusCode($statusCode)) {
            $this->urlsGroupedByStatusCode[$statusCode][] = $url;
        }

        return $statusCode;
    }

    /**
     * Determine if the statuscode concerns a successful or
     * redirect response.
     *
     * @param int|string $statusCode
     * @return bool
     */
    protected function isSuccessOrRedirect($statusCode): bool
    {
        return starts_with($statusCode, ['2', '3']);
    }

    /**
     * Determine if the crawler saw some bad urls.
     */
    protected function crawledBadUrls(): bool
    {
        return collect($this->urlsGroupedByStatusCode)->keys()->filter(function ($statusCode) {
            return !$this->isSuccessOrRedirect($statusCode);
        })->count() > 0;
    }

    /**
     * Determine if the statuscode should be excluded'
     * from the reporter.
     *
     * @param int|string $statusCode
     *
     * @return bool
     */
    protected function isExcludedStatusCode($statusCode): bool
    {
        $exludedStatusCodes = config('laravel-link-checker.reporters.exclude_status_codes', []);

        return in_array($statusCode, $exludedStatusCodes);
    }
}