MarkupValidatorMessage::getFirstLineNumber() - Code Metrics - Inspection of "Add message line numbers" - Kolyunya/codeception-markup-validator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 44-add-message-line-numbers ( bb4e15 )

by Nikolay

created 2017-04-25 20:34 UTC

MarkupValidatorMessage::getFirstLineNumber() A

↳ Parent: MarkupValidatorMessage

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Kolyunya\Codeception\Lib\MarkupValidator;

use Kolyunya\Codeception\Lib\MarkupValidator\MarkupValidatorMessageInterface;

/**
 * Base markup validator message.
 */
class MarkupValidatorMessage implements MarkupValidatorMessageInterface
{
    /**
     * Message type.
     *
     * @var string
     */
    protected $type;

    /**
     * Message summary.
     *
     * @var string
     */
    protected $summary;

    /**
     * Message details.
     *
     * @var string
     */
    protected $details;

    /**
     * A number of the first related markup line.
     *
     * @var integer
     */
    protected $firstLineNumber;

    /**
     * A number of the last related markup line.
     *
     * @var integer
     */
    protected $lastLineNumber;

    /**
     * Related markup.
     *
     * @var string
     */
    protected $markup;

    /**
     * Constructs a new message. Sets message type.
     *
     * @param string $type Message type.
     */
    public function __construct($type = self::TYPE_UNDEFINED)
    {
        $this->setType($type);
    }

    /**
     * {@inheritDoc}
     */
    public function __toString()
    {
        return vsprintf($this->getStringTemplate(), array(
            $this->getType() ?: 'unavailable',
            $this->getSummary() ?: 'unavailable',
            $this->getDetails() ?: 'unavailable',
            $this->getMarkup() ?: 'unavailable',
        ));
    }

    /**
     * Sets message type.
     *
     * @param string $type Message type.
     *
     * @return self Returns self.
     */
    public function setType($type)
    {
        if ($type === null) {
            $type = self::TYPE_UNDEFINED;
        }

        $this->type = $type;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Sets message summary.
     *
     * @param string $summary Message summary.
     *
     * @return self Returns self.
     */
    public function setSummary($summary)
    {
        $this->summary = $summary;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getSummary()
    {
        return $this->summary;
    }

    /**
     * Sets message details.
     *
     * @param string $details Message details.
     *
     * @return self Returns self.
     */
    public function setDetails($details)
    {
        $this->details = $details;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getDetails()
    {
        return $this->details;
    }

    /**
     * Sets first line number.
     *
     * @param string $firstLineNumber First line number.
     *
     * @return self Returns self.
     */
    public function setFirstLineNumber($firstLineNumber)
    {
        $this->firstLineNumber = $firstLineNumber;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getFirstLineNumber()
    {
        return $this->firstLineNumber;
    }

    /**
     * Sets last line number.
     *
     * @param string $lastLineNumber Last line number.
     *
     * @return self Returns self.
     */
    public function setLastLineNumber($lastLineNumber)
    {
        $this->lastLineNumber = $lastLineNumber;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getLastLineNumber()
    {
        return $this->lastLineNumber;
    }

    /**
     * Sets markup.
     *
     * @param string $markup Markup.
     *
     * @return self Returns self.
     */
    public function setMarkup($markup)
    {
        $this->markup = $markup;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getMarkup()
    {
        return $this->markup;
    }

    /**
     * Returns string representation template.
     *
     * @return string String representation template.
     */
    protected function getStringTemplate()
    {
        return
            <<<TXT
Markup validator message:
Type: %s
Summary: %s
Details: %s
Markup: %s

TXT
        ;
    }
}


1			<?php
2
3			namespace Kolyunya\Codeception\Lib\MarkupValidator;
4
5			use Kolyunya\Codeception\Lib\MarkupValidator\MarkupValidatorMessageInterface;
6
7			/**
8			* Base markup validator message.
9			*/
10			class MarkupValidatorMessage implements MarkupValidatorMessageInterface
11			{
12			/**
13			* Message type.
14			*
15			* @var string
16			*/
17			protected $type;
18
19			/**
20			* Message summary.
21			*
22			* @var string
23			*/
24			protected $summary;
25
26			/**
27			* Message details.
28			*
29			* @var string
30			*/
31			protected $details;
32
33			/**
34			* A number of the first related markup line.
35			*
36			* @var integer
37			*/
38			protected $firstLineNumber;
39
40			/**
41			* A number of the last related markup line.
42			*
43			* @var integer
44			*/
45			protected $lastLineNumber;
46
47			/**
48			* Related markup.
49			*
50			* @var string
51			*/
52			protected $markup;
53
54			/**
55			* Constructs a new message. Sets message type.
56			*
57			* @param string $type Message type.
58			*/
59			public function __construct($type = self::TYPE_UNDEFINED)
60			{
61			$this->setType($type);
62			}
63
64			/**
65			* {@inheritDoc}
66			*/
67			public function __toString()
68			{
69			return vsprintf($this->getStringTemplate(), array(
70			$this->getType() ?: 'unavailable',
71			$this->getSummary() ?: 'unavailable',
72			$this->getDetails() ?: 'unavailable',
73			$this->getMarkup() ?: 'unavailable',
74			));
75			}
76
77			/**
78			* Sets message type.
79			*
80			* @param string $type Message type.
81			*
82			* @return self Returns self.
83			*/
84			public function setType($type)
85			{
86			if ($type === null) {
87			$type = self::TYPE_UNDEFINED;
88			}
89
90			$this->type = $type;
91
92			return $this;
93			}
94
95			/**
96			* {@inheritDoc}
97			*/
98			public function getType()
99			{
100			return $this->type;
101			}
102
103			/**
104			* Sets message summary.
105			*
106			* @param string $summary Message summary.
107			*
108			* @return self Returns self.
109			*/
110			public function setSummary($summary)
111			{
112			$this->summary = $summary;
113
114			return $this;
115			}
116
117			/**
118			* {@inheritDoc}
119			*/
120			public function getSummary()
121			{
122			return $this->summary;
123			}
124
125			/**
126			* Sets message details.
127			*
128			* @param string $details Message details.
129			*
130			* @return self Returns self.
131			*/
132			public function setDetails($details)
133			{
134			$this->details = $details;
135
136			return $this;
137			}
138
139			/**
140			* {@inheritDoc}
141			*/
142			public function getDetails()
143			{
144			return $this->details;
145			}
146
147			/**
148			* Sets first line number.
149			*
150			* @param string $firstLineNumber First line number.
151			*
152			* @return self Returns self.
153			*/
154			public function setFirstLineNumber($firstLineNumber)
155			{
156			$this->firstLineNumber = $firstLineNumber;
			0 ignored issues – show Documentation Bug introduced 2017-04-25 20:35 UTC by Report Bug Copy Issue Report The property `$firstLineNumber` was declared of type `integer`, but `$firstLineNumber` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
157
158			return $this;
159			}
160
161			/**
162			* {@inheritDoc}
163			*/
164			public function getFirstLineNumber()
165			{
166			return $this->firstLineNumber;
167			}
168
169			/**
170			* Sets last line number.
171			*
172			* @param string $lastLineNumber Last line number.
173			*
174			* @return self Returns self.
175			*/
176			public function setLastLineNumber($lastLineNumber)
177			{
178			$this->lastLineNumber = $lastLineNumber;
			0 ignored issues – show Documentation Bug introduced 2017-04-25 20:35 UTC by Report Bug Copy Issue Report The property `$lastLineNumber` was declared of type `integer`, but `$lastLineNumber` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
179
180			return $this;
181			}
182
183			/**
184			* {@inheritDoc}
185			*/
186			public function getLastLineNumber()
187			{
188			return $this->lastLineNumber;
189			}
190
191			/**
192			* Sets markup.
193			*
194			* @param string $markup Markup.
195			*
196			* @return self Returns self.
197			*/
198			public function setMarkup($markup)
199			{
200			$this->markup = $markup;
201
202			return $this;
203			}
204
205			/**
206			* {@inheritDoc}
207			*/
208			public function getMarkup()
209			{
210			return $this->markup;
211			}
212
213			/**
214			* Returns string representation template.
215			*
216			* @return string String representation template.
217			*/
218			protected function getStringTemplate()
219			{
220			return
221			<<<TXT
222			Markup validator message:
223			Type: %s
224			Summary: %s
225			Details: %s
226			Markup: %s
227
228			TXT
229			;
230			}
231			}
232

Kolyunya / codeception-markup-validator

GitHub Access Token became invalid

Push — 44-add-message-line-numbers ( bb4e15 )

MarkupValidatorMessage::getFirstLineNumber() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like