Issue::getDescription() - Code Metrics - Inspection of "Version 4" - mayflower/PHP_CodeBrowser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#82)

by Michael

created 2023-01-30 11:26 UTC

Issue::getDescription() A

↳ Parent: Issue

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Plugin Abstract
 *
 * PHP Version 5.3.0
 *
 * Copyright (c) 2007-2010, Mayflower GmbH
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Mayflower GmbH nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category PHP_CodeBrowser
 *
 * @author Elger Thiele <[email protected]>
 * @author Michel Hartmann <[email protected]>
 *
 * @copyright 2007-2010 Mayflower GmbH
 *
 * @license http://www.opensource.org/licenses/bsd-license.php  BSD License
 *
 * @version SVN: $Id$
 *
 * @link http://www.phpunit.de/
 *
 * @since File available since  0.1.2
 */

namespace PHPCodeBrowser;

/**
 * Issue
 *
 * Object Model for issues.
 * This object is used for working with common issues types.
 *
 * @category PHP_CodeBrowser
 *
 * @author Elger Thiele <[email protected]>
 * @author Michel Hartmann <[email protected]>
 *
 * @copyright 2007-2010 Mayflower GmbH
 *
 * @license http://www.opensource.org/licenses/bsd-license.php  BSD License
 *
 * @version Release: @package_version@
 *
 * @link http://github.com/mayflowergmbh
 *
 * @since Class available since  0.1.2
 */
class Issue
{
    /**
     * Source file name.
     *
     * @var string
     */
    private $fileName;

    /**
     * Starting Line of the Issue.
     *
     * @var int
     */
    private $lineStart;

    /**
     * Ending Line of the Issue.
     *
     * @var int
     */
    private $lineEnd;

    /**
     * Name of the Plugin that found the Issue.
     * It is also used for CSS class definitions.
     *
     * @var string
     */
    private $foundBy;

    /**
     * Issue Description text.
     *
     * @var string
     */
    private $description;

    /**
     * Severity of the issue.
     *
     * @var string
     */
    private $severity;

    /**
     * Default constructor
     *
     * @param string $fileName    The source file name the issue was found in.
     * @param int    $lineStart   The starting line of the issue.
     * @param int    $lineEnd     The ending line of registered issue.
     * @param string $foundBy     The plugin name definition.
     * @param string $description The description of the issue.
     * @param string $severity
     */
    public function __construct(string $fileName, int $lineStart, int $lineEnd, string $foundBy, string $description, string $severity)
    {
        $this->fileName    = $fileName;
        $this->lineStart   = $lineStart;
        $this->lineEnd     = $lineEnd;
        $this->foundBy     = $foundBy;
        $this->description = $description;
        $this->severity    = $severity;
    }

    /**
     * @return string
     */
    public function getFileName(): string
    {
        return $this->fileName;
    }

    /**
     * @return int
     */
    public function getLineStart(): int
    {
        return $this->lineStart;
    }

    /**
     * @return int
     */
    public function getLineEnd(): int
    {
        return $this->lineEnd;
    }

    /**
     * @return string
     */
    public function getFoundBy(): string
    {
        return $this->foundBy;
    }

    /**
     * @return string
     */
    public function getDescription(): string
    {
        return $this->description;
    }

    /**
     * @return string
     */
    public function getSeverity(): string
    {
        return $this->severity;
    }
}


1			<?php
2
3			/**
4			* Plugin Abstract
5			*
6			* PHP Version 5.3.0
7			*
8			* Copyright (c) 2007-2010, Mayflower GmbH
9			* All rights reserved.
10			*
11			* Redistribution and use in source and binary forms, with or without
12			* modification, are permitted provided that the following conditions
13			* are met:
14			*
15			* * Redistributions of source code must retain the above copyright
16			* notice, this list of conditions and the following disclaimer.
17			*
18			* * Redistributions in binary form must reproduce the above copyright
19			* notice, this list of conditions and the following disclaimer in
20			* the documentation and/or other materials provided with the
21			* distribution.
22			*
23			* * Neither the name of Mayflower GmbH nor the names of his
24			* contributors may be used to endorse or promote products derived
25			* from this software without specific prior written permission.
26			*
27			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
30			* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
31			* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
32			* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
33			* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
34			* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35			* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37			* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38			* POSSIBILITY OF SUCH DAMAGE.
39			*
40			* @category PHP_CodeBrowser
41			*
42			* @author Elger Thiele <[email protected]>
43			* @author Michel Hartmann <[email protected]>
44			*
45			* @copyright 2007-2010 Mayflower GmbH
46			*
47			* @license http://www.opensource.org/licenses/bsd-license.php BSD License
48			*
49			* @version SVN: $Id$
50			*
51			* @link http://www.phpunit.de/
52			*
53			* @since File available since 0.1.2
54			*/
55
56			namespace PHPCodeBrowser;
57
58			/**
59			* Issue
60			*
61			* Object Model for issues.
62			* This object is used for working with common issues types.
63			*
64			* @category PHP_CodeBrowser
65			*
66			* @author Elger Thiele <[email protected]>
67			* @author Michel Hartmann <[email protected]>
68			*
69			* @copyright 2007-2010 Mayflower GmbH
70			*
71			* @license http://www.opensource.org/licenses/bsd-license.php BSD License
72			*
73			* @version Release: @package_version@
74			*
75			* @link http://github.com/mayflowergmbh
76			*
77			* @since Class available since 0.1.2
78			*/
79			class Issue
80			{
81			/**
82			* Source file name.
83			*
84			* @var string
85			*/
86			private $fileName;
87
88			/**
89			* Starting Line of the Issue.
90			*
91			* @var int
92			*/
93			private $lineStart;
94
95			/**
96			* Ending Line of the Issue.
97			*
98			* @var int
99			*/
100			private $lineEnd;
101
102			/**
103			* Name of the Plugin that found the Issue.
104			* It is also used for CSS class definitions.
105			*
106			* @var string
107			*/
108			private $foundBy;
109
110			/**
111			* Issue Description text.
112			*
113			* @var string
114			*/
115			private $description;
116
117			/**
118			* Severity of the issue.
119			*
120			* @var string
121			*/
122			private $severity;
123
124			/**
125			* Default constructor
126			*
127			* @param string $fileName The source file name the issue was found in.
128			* @param int $lineStart The starting line of the issue.
129			* @param int $lineEnd The ending line of registered issue.
130			* @param string $foundBy The plugin name definition.
131			* @param string $description The description of the issue.
132			* @param string $severity
133			*/
134			public function __construct(string $fileName, int $lineStart, int $lineEnd, string $foundBy, string $description, string $severity)
135			{
136			$this->fileName = $fileName;
137			$this->lineStart = $lineStart;
138			$this->lineEnd = $lineEnd;
139			$this->foundBy = $foundBy;
140			$this->description = $description;
141			$this->severity = $severity;
142			}
143
144			/**
145			* @return string
146			*/
147			public function getFileName(): string
148			{
149			return $this->fileName;
150			}
151
152			/**
153			* @return int
154			*/
155			public function getLineStart(): int
156			{
157			return $this->lineStart;
158			}
159
160			/**
161			* @return int
162			*/
163			public function getLineEnd(): int
164			{
165			return $this->lineEnd;
166			}
167
168			/**
169			* @return string
170			*/
171			public function getFoundBy(): string
172			{
173			return $this->foundBy;
174			}
175
176			/**
177			* @return string
178			*/
179			public function getDescription(): string
180			{
181			return $this->description;
182			}
183
184			/**
185			* @return string
186			*/
187			public function getSeverity(): string
188			{
189			return $this->severity;
190			}
191			}
192

mayflower / PHP_CodeBrowser

Pull Request — master (#82)

Issue::getDescription() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like