AbstractVersion::getFullDescription() - Code Metrics - Inspection of "add AbstractVersion class" - comodojo/foundation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2c39fe...466032 )

by Marco

created 2018-03-20 22:58 UTC

AbstractVersion::getFullDescription() A

↳ Parent: AbstractVersion

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	0
cts	6
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	0
crap	2

<?php namespace Comodojo\Foundation\Base;

use \Comodojo\Foundation\Base\Configuration;
use \Comodojo\Foundation\Base\ConfigurationTrait;

/**
 * @package     Comodojo Foundation
 * @author      Marco Giovinazzi <[email protected]>
 * @license     MIT
 *
 * LICENSE:
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

abstract class AbstractVersion {

    use ConfigurationTrait;

    /**
     * Component name
     *
     * @var string
     */
    protected $name;

    /**
     * Component brief description
     *
     * @var string
     */
    protected $description;

    /**
     * Current version
     *
     * @var     string
     */
    protected $version;

    /**
     * Ascii fancy logo
     *
     * @var     string
     */
    protected $ascii;

    /**
     * Prefix for configuration item names
     *
     * @var     string
     */
    protected $prefix;

    /**
     * Template for full-description;
     *
     * @var     string
     */
    protected $template = "\n{ascii}\n{description} ({version})\n";

    /**
     * Create a version identifier class
     *
     * @param Configuration|null $configuration
     * @param string $prefix
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct(Configuration $configuration = null) {

        if ($configuration !== null) $this->setConfiguration($configuration);

    }

    /**
     * Get the version name
     *
     * @return string
     */
    public function getName() {

        $name_override = $this->getConfigurationOverride("name");

        return $name_override !== null ? $name_override : $this->name;

    }

    /**
     * Get the version description
     *
     * @return string
     */
    public function getDescription() {

        $desc_override = $this->getConfigurationOverride("description");

        return $desc_override !== null ? $desc_override : $this->description;

    }

    /**
     * Get the current version
     *
     * @return string
     */
    public function getVersion() {

        $release_override = $this->getConfigurationOverride("release");

        return $release_override !== null ? $release_override : $this->version;

    }

    /**
     * Get the version ascii
     *
     * @return string
     */
    public function getAscii() {

        $ascii_override = $this->getConfigurationOverride("ascii");

        return $ascii_override !== null ? $ascii_override : $this->ascii;

    }

    /**
     * Return a composed-version of nominal values
     *
     * @return  string
     */
    public function getFullDescription() {

        return strtr($this->template, [
            "{name}" => $this->getName(),
            "{description}" => $this->getDescription(),
            "{version}" => $this->getVersion(),
            "{ascii}" => $this->getAscii()
        ]);

    }

    private function getConfigurationOverride($item) {

        return $this->configuration !== null ?
            $this->configuration->get($this->prefix."version-$item") :
            null;

    }

}


1		<?php namespace Comodojo\Foundation\Base;
2
3		use \Comodojo\Foundation\Base\Configuration;
4		use \Comodojo\Foundation\Base\ConfigurationTrait;
5
6		/**
7		* @package Comodojo Foundation
8		* @author Marco Giovinazzi <[email protected]>
9		* @license MIT
10		*
11		* LICENSE:
12		*
13		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19		* THE SOFTWARE.
20		*/
21
22		abstract class AbstractVersion {
23
24		use ConfigurationTrait;
25
26		/**
27		* Component name
28		*
29		* @var string
30		*/
31		protected $name;
32
33		/**
34		* Component brief description
35		*
36		* @var string
37		*/
38		protected $description;
39
40		/**
41		* Current version
42		*
43		* @var string
44		*/
45		protected $version;
46
47		/**
48		* Ascii fancy logo
49		*
50		* @var string
51		*/
52		protected $ascii;
53
54		/**
55		* Prefix for configuration item names
56		*
57		* @var string
58		*/
59		protected $prefix;
60
61		/**
62		* Template for full-description;
63		*
64		* @var string
65		*/
66		protected $template = "\n{ascii}\n{description} ({version})\n";
67
68		/**
69		* Create a version identifier class
70		*
71		* @param Configuration\|null $configuration
72		* @param string $prefix
		0 ignored issues – show Bug introduced 2018-03-20 23:00 UTC by Report Bug Copy Issue Report There is no parameter named `$prefix`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
73		*/
74	2	public function __construct(Configuration $configuration = null) {
75
76	2	if ($configuration !== null) $this->setConfiguration($configuration);
77
78	2	}
79
80		/**
81		* Get the version name
82		*
83		* @return string
84		*/
85	2	public function getName() {
86
87	2	$name_override = $this->getConfigurationOverride("name");
88
89	2	return $name_override !== null ? $name_override : $this->name;
90
91		}
92
93		/**
94		* Get the version description
95		*
96		* @return string
97		*/
98	2	public function getDescription() {
99
100	2	$desc_override = $this->getConfigurationOverride("description");
101
102	2	return $desc_override !== null ? $desc_override : $this->description;
103
104		}
105
106		/**
107		* Get the current version
108		*
109		* @return string
110		*/
111	1	public function getVersion() {
112
113	1	$release_override = $this->getConfigurationOverride("release");
114
115	1	return $release_override !== null ? $release_override : $this->version;
116
117		}
118
119		/**
120		* Get the version ascii
121		*
122		* @return string
123		*/
124	1	public function getAscii() {
125
126	1	$ascii_override = $this->getConfigurationOverride("ascii");
127
128	1	return $ascii_override !== null ? $ascii_override : $this->ascii;
129
130		}
131
132		/**
133		* Return a composed-version of nominal values
134		*
135		* @return string
136		*/
137		public function getFullDescription() {
138
139		return strtr($this->template, [
140		"{name}" => $this->getName(),
141		"{description}" => $this->getDescription(),
142		"{version}" => $this->getVersion(),
143		"{ascii}" => $this->getAscii()
144		]);
145
146		}
147
148	2	private function getConfigurationOverride($item) {
149
150	2	return $this->configuration !== null ?
151	1	$this->configuration->get($this->prefix."version-$item") :
152	2	null;
153
154		}
155
156		}
157

comodojo / foundation

Push — master ( 2c39fe...466032 )

AbstractVersion::getFullDescription() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like