CrawlerProperties - Code Metrics - Inspection of "Code refactor" - spatie/crawler - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#150)

by Brent

created 2018-05-15 09:27 UTC

CrawlerProperties A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	1

Importance

Changes

Metric	Value
wmc	28
c	0
b	0
f	0
lcom	4
cbo	1
dl	0
loc	174
rs	10

26 Methods

Rating	Name	Size	Complexity
A	setConcurrency()	6	1
A	setMaximumResponseSize()	6	1
A	setMaximumCrawlCount()	6	1
A	setMaximumDepth()	6	1
A	ignoreRobots()	6	1
A	respectRobots()	6	1
A	setCrawlQueue()	6	1
A	executeJavaScript()	6	1
A	doNotExecuteJavaScript()	6	1
A	setCrawlObserver()	8	2
A	setCrawlObservers()	6	1
A	addCrawlObserver()	6	1
A	setCrawlProfile()	6	1
A	getBaseUrl()	4	1
A	getCrawlQueue()	4	1
A	getCrawlProfile()	4	1
A	getCrawlObservers()	4	1
A	getMaximumResponseSize()	4	1
A	mustRespectRobots()	4	1
A	getRobotsTxt()	4	1
A	getMaximumDepth()	4	1
A	getMaximumCrawlCount()	4	1
A	getCrawlerUrlCount()	4	1
A	getBrowsershot()	8	2
A	setBrowsershot()	6	1
A	mayExecuteJavascript()	4	1

<?php

namespace Spatie\Crawler;

use Spatie\Robots\RobotsTxt;
use Psr\Http\Message\UriInterface;
use Spatie\Browsershot\Browsershot;
use Spatie\Crawler\CrawlQueue\CrawlQueue;

trait CrawlerProperties
{
    public function setConcurrency(int $concurrency): self
    {
        $this->concurrency = $concurrency;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function setMaximumResponseSize(int $maximumResponseSizeInBytes): self
    {
        $this->maximumResponseSize = $maximumResponseSizeInBytes;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function setMaximumCrawlCount(int $maximumCrawlCount): self
    {
        $this->maximumCrawlCount = $maximumCrawlCount;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function setMaximumDepth(int $maximumDepth): self
    {
        $this->maximumDepth = $maximumDepth;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function ignoreRobots(): self
    {
        $this->respectRobots = false;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function respectRobots(): self
    {
        $this->respectRobots = true;

        return $this;
    }

    public function setCrawlQueue(CrawlQueue $crawlQueue): self
    {
        $this->crawlQueue = $crawlQueue;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function executeJavaScript(): self
    {
        $this->executeJavaScript = true;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function doNotExecuteJavaScript(): self
    {
        $this->executeJavaScript = false;

        return $this;
    }

    /**
     * @param \Spatie\Crawler\CrawlObserver|array[\Spatie\Crawler\CrawlObserver] $crawlObservers

     *
     * @return $this
     */
    public function setCrawlObserver($crawlObservers)
    {
        if (! is_array($crawlObservers)) {
            $crawlObservers = [$crawlObservers];
        }

        return $this->setCrawlObservers($crawlObservers);
    }

    public function setCrawlObservers(array $crawlObservers): self
    {
        $this->crawlObservers = $crawlObservers;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function addCrawlObserver(CrawlObserver $crawlObserver): self
    {
        $this->crawlObservers[] = $crawlObserver;

        return $this;
    }

    public function setCrawlProfile(CrawlProfile $crawlProfile): self
    {
        $this->crawlProfile = $crawlProfile;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    public function getBaseUrl(): UriInterface
    {
        return $this->baseUrl;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function getCrawlQueue(): CrawlQueue
    {
        return $this->crawlQueue;
    }

    public function getCrawlProfile(): CrawlProfile
    {
        return $this->crawlProfile;
    }

    /**
     * @return \Spatie\Crawler\CrawlObserver[]
     */
    public function getCrawlObservers(): array
    {
        return $this->crawlObservers;
    }

    public function getMaximumResponseSize(): ?int
    {
        return $this->maximumResponseSize;
    }

    public function mustRespectRobots(): bool
    {
        return $this->respectRobots;
    }

    public function getRobotsTxt(): RobotsTxt
    {
        return $this->robotsTxt;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function getMaximumDepth(): ?int
    {
        return $this->maximumDepth;
    }

    public function getMaximumCrawlCount(): ?int
    {
        return $this->maximumCrawlCount;
    }

    public function getCrawlerUrlCount(): int
    {
        return $this->crawledUrlCount;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function getBrowsershot(): Browsershot
    {
        if (! $this->browsershot) {
            $this->browsershot = new Browsershot();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        return $this->browsershot;
    }

    public function setBrowsershot(Browsershot $browsershot)
    {
        $this->browsershot = $browsershot;

        return $this;
    }

    public function mayExecuteJavascript(): bool
    {
        return $this->executeJavaScript;
    }
}


1			<?php
2
3			namespace Spatie\Crawler;
4
5			use Spatie\Robots\RobotsTxt;
6			use Psr\Http\Message\UriInterface;
7			use Spatie\Browsershot\Browsershot;
8			use Spatie\Crawler\CrawlQueue\CrawlQueue;
9
10			trait CrawlerProperties
11			{
12			public function setConcurrency(int $concurrency): self
13			{
14			$this->concurrency = $concurrency;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `concurrency` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
15
16			return $this;
17			}
18
19			public function setMaximumResponseSize(int $maximumResponseSizeInBytes): self
20			{
21			$this->maximumResponseSize = $maximumResponseSizeInBytes;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `maximumResponseSize` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
22
23			return $this;
24			}
25
26			public function setMaximumCrawlCount(int $maximumCrawlCount): self
27			{
28			$this->maximumCrawlCount = $maximumCrawlCount;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `maximumCrawlCount` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
29
30			return $this;
31			}
32
33			public function setMaximumDepth(int $maximumDepth): self
34			{
35			$this->maximumDepth = $maximumDepth;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `maximumDepth` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
36
37			return $this;
38			}
39
40			public function ignoreRobots(): self
41			{
42			$this->respectRobots = false;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `respectRobots` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
43
44			return $this;
45			}
46
47			public function respectRobots(): self
48			{
49			$this->respectRobots = true;
50
51			return $this;
52			}
53
54			public function setCrawlQueue(CrawlQueue $crawlQueue): self
55			{
56			$this->crawlQueue = $crawlQueue;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `crawlQueue` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
57
58			return $this;
59			}
60
61			public function executeJavaScript(): self
62			{
63			$this->executeJavaScript = true;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `executeJavaScript` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
64
65			return $this;
66			}
67
68			public function doNotExecuteJavaScript(): self
69			{
70			$this->executeJavaScript = false;
71
72			return $this;
73			}
74
75			/**
76			* @param \Spatie\Crawler\CrawlObserver\|array[\Spatie\Crawler\CrawlObserver] $crawlObservers
			0 ignored issues – show Documentation introduced 2018-01-25 20:52 UTC by Report Bug Copy Issue Report The doc-type `\Spatie\Crawler\CrawlObs...\Crawler\CrawlObserver]` could not be parsed: Expected "]" at position 4, but found "\Spatie\Crawler\CrawlObserver". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
77			*
78			* @return $this
79			*/
80			public function setCrawlObserver($crawlObservers)
81			{
82			if (! is_array($crawlObservers)) {
83			$crawlObservers = [$crawlObservers];
84			}
85
86			return $this->setCrawlObservers($crawlObservers);
87			}
88
89			public function setCrawlObservers(array $crawlObservers): self
90			{
91			$this->crawlObservers = $crawlObservers;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `crawlObservers` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
92
93			return $this;
94			}
95
96			public function addCrawlObserver(CrawlObserver $crawlObserver): self
97			{
98			$this->crawlObservers[] = $crawlObserver;
99
100			return $this;
101			}
102
103			public function setCrawlProfile(CrawlProfile $crawlProfile): self
104			{
105			$this->crawlProfile = $crawlProfile;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `crawlProfile` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
106
107			return $this;
108			}
109
110			public function getBaseUrl(): UriInterface
111			{
112			return $this->baseUrl;
			0 ignored issues – show Bug introduced 2018-05-15 08:35 UTC by Report Bug Copy Issue Report The property `baseUrl` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
113			}
114
115			public function getCrawlQueue(): CrawlQueue
116			{
117			return $this->crawlQueue;
118			}
119
120			public function getCrawlProfile(): CrawlProfile
121			{
122			return $this->crawlProfile;
123			}
124
125			/**
126			* @return \Spatie\Crawler\CrawlObserver[]
127			*/
128			public function getCrawlObservers(): array
129			{
130			return $this->crawlObservers;
131			}
132
133			public function getMaximumResponseSize(): ?int
134			{
135			return $this->maximumResponseSize;
136			}
137
138			public function mustRespectRobots(): bool
139			{
140			return $this->respectRobots;
141			}
142
143			public function getRobotsTxt(): RobotsTxt
144			{
145			return $this->robotsTxt;
			0 ignored issues – show Bug introduced 2018-05-15 09:19 UTC by Report Bug Copy Issue Report The property `robotsTxt` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
146			}
147
148			public function getMaximumDepth(): ?int
149			{
150			return $this->maximumDepth;
151			}
152
153			public function getMaximumCrawlCount(): ?int
154			{
155			return $this->maximumCrawlCount;
156			}
157
158			public function getCrawlerUrlCount(): int
159			{
160			return $this->crawledUrlCount;
			0 ignored issues – show Bug introduced 2018-05-15 09:19 UTC by Report Bug Copy Issue Report The property `crawledUrlCount` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
161			}
162
163			public function getBrowsershot(): Browsershot
164			{
165			if (! $this->browsershot) {
166			$this->browsershot = new Browsershot();
			0 ignored issues – show Bug introduced 2018-05-15 09:19 UTC by Report Bug Copy Issue Report The property `browsershot` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
167			}
168
169			return $this->browsershot;
170			}
171
172			public function setBrowsershot(Browsershot $browsershot)
173			{
174			$this->browsershot = $browsershot;
175
176			return $this;
177			}
178
179			public function mayExecuteJavascript(): bool
180			{
181			return $this->executeJavaScript;
182			}
183			}
184

spatie / crawler

Pull Request — master (#150)

CrawlerProperties A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

26 Methods

Duplication Side-by-Side

Filter issues like