TestFactory::getState() - Code Metrics - Inspection of "Update TestFactory.php" - tvdijen/simplesamlphp-module-monitor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bdf206...96b1f4 )

by Tim

created 2018-01-09 19:14 UTC

TestFactory::getState() A

↳ Parent: TestFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace SimpleSAML\Module\monitor;

abstract class TestFactory
{
    /**
     * @var TestData
     */
    private $testData;

    /**
     * @var TestConfiguration|null
     */
    private $configuration = null;

    /**
     * @var array<TestResult>
     */
    private $testResult;

    /**
     * @var array|null
     */
    private $output = array();

    /**
     * @var State
     */
    private $state = State::NOSTATE;

    /**
     * @var array
     */
    private $messages = array();


    /**
     * @param TestConfiguration|null $configuration
     *
     * @return void
     */
    protected function setConfiguration($configuration = null)
    {
        assert($configuration instanceof TestConfiguration);
        if (!is_null($configuration)) {
            $this->configuration = $configuration;
        }
    }


    /**
     * @return TestConfiguration
     */
    public function getConfiguration()
    {
        assert($this->configuration instanceof TestConfiguration);
        return $this->configuration;
    }


    /**
     * @return TestData|null
     */
    public function getTestData()
    {
        assert($this->testData instanceof TestData || is_null($this->testData));
        return $this->testData;
    }


    /**
     * @param TestData|null $testData
     *
     * @return void
     */
    protected function setTestData($testData = null)
    {
        assert($testData instanceof TestData || is_null($testData));
        if (!is_null($testData)) {
            $this->testData = $testData;
        }
    }


    /**
     * @param TestResult $testResult
     *
     * @return void
     */
    protected function setTestResult($testResult)
    {
        assert($testResult instanceof TestResult);
        $this->testResult = $testResult;

    }


    /**
     * @param TestResult $testResult
     *
     * @return void
     */
    protected function addTestResult($testResult)
    {
        assert($testResult instanceof TestResult);
        $this->testResult[] = $testResult;
    }


    /**
     * @return TestResult

     */
    public function getTestResult()
    {
        assert($this->testResult instanceof TestResult);
        return $this->testResult;
    }


    /**
     * @return array
     */
    public function getMessages()
    {
        assert(is_array($this->messages));
        return $this->messages;
    }


    /**
     * @param string|null $item
     *
     * @return mixed
     */
    public function getOutput($item = null)
    {
        assert(is_string($item) || is_null($item));
        return is_null($item) ? $this->output : (isSet($this->output[$item]) ? $this->output[$item] : null);
    }


    /**
     * @return State
     */
    public function getState()
    {
        assert($this->state instanceof State);
        return $this->state;
    }


    /**
     * @return void
     */
    protected function setMessages($messages)
    {
        assert(is_array($messages));
        $this->messages = $messages;
    }


    /**
     * @param array $messages
     * @param string|null $index
     *
     * @return void
     */
    protected function addMessages($messages, $index = null)
    {
        if ($index === null) {
            $this->messages = array_merge($this->messages, $messages);
        } else {
            foreach ($messages as $message) {
                $this->messages[$index][] = $message;
            }
        }
    }


    /**
     * @param State $state
     * @param string $category
     * @param string $subject
     * @param string $message
     *
     * @return void
     */
    protected function addMessage($state, $category, $subject, $message)
    {
        assert(($state instanceof State) && is_string($category) && is_string($subject) && is_string($message));
        $this->messages[] = array($state, $category, $subject, $message);
    }


    /**
     * @param mixed $value
     * @param string|null $index
     *
     * @return void
     */
    protected function addOutput($value, $index = null)
    {
        if ($index === null) {
            $this->output = array_merge($this->output, $value);
        } else {
            $this->output[$index] = $value;
        }
    }


    /**
     * @return void
     */
    protected function setOutput($output)
    {
        assert(is_array($output));
        $this->output = $output;
    }


    /**
     * @return void
     */
    protected function setState($state)
    {
        assert($state instanceof State);
        $this->state = $state;
    }
}


1			<?php
2
3			namespace SimpleSAML\Module\monitor;
4
5			abstract class TestFactory
6			{
7			/**
8			* @var TestData
9			*/
10			private $testData;
11
12			/**
13			* @var TestConfiguration\|null
14			*/
15			private $configuration = null;
16
17			/**
18			* @var array<TestResult>
19			*/
20			private $testResult;
21
22			/**
23			* @var array\|null
24			*/
25			private $output = array();
26
27			/**
28			* @var State
29			*/
30			private $state = State::NOSTATE;
31
32			/**
33			* @var array
34			*/
35			private $messages = array();
36
37
38			/**
39			* @param TestConfiguration\|null $configuration
40			*
41			* @return void
42			*/
43			protected function setConfiguration($configuration = null)
44			{
45			assert($configuration instanceof TestConfiguration);
46			if (!is_null($configuration)) {
47			$this->configuration = $configuration;
48			}
49			}
50
51
52			/**
53			* @return TestConfiguration
54			*/
55			public function getConfiguration()
56			{
57			assert($this->configuration instanceof TestConfiguration);
58			return $this->configuration;
59			}
60
61
62			/**
63			* @return TestData\|null
64			*/
65			public function getTestData()
66			{
67			assert($this->testData instanceof TestData \|\| is_null($this->testData));
68			return $this->testData;
69			}
70
71
72			/**
73			* @param TestData\|null $testData
74			*
75			* @return void
76			*/
77			protected function setTestData($testData = null)
78			{
79			assert($testData instanceof TestData \|\| is_null($testData));
80			if (!is_null($testData)) {
81			$this->testData = $testData;
82			}
83			}
84
85
86			/**
87			* @param TestResult $testResult
88			*
89			* @return void
90			*/
91			protected function setTestResult($testResult)
92			{
93			assert($testResult instanceof TestResult);
94			$this->testResult = $testResult;
			0 ignored issues – show Documentation Bug introduced 2018-01-09 19:15 UTC by Report Bug Copy Issue Report It seems like `$testResult` of type `object<SimpleSAML\Module\monitor\TestResult>` is incompatible with the declared type `array<integer,object<Sim...le\monitor\TestResult>>` of property `$testResult`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
95			}
96
97
98			/**
99			* @param TestResult $testResult
100			*
101			* @return void
102			*/
103			protected function addTestResult($testResult)
104			{
105			assert($testResult instanceof TestResult);
106			$this->testResult[] = $testResult;
107			}
108
109
110			/**
111			* @return TestResult
			0 ignored issues – show Documentation introduced 2018-01-09 19:15 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `NoType`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
112			*/
113			public function getTestResult()
114			{
115			assert($this->testResult instanceof TestResult);
116			return $this->testResult;
117			}
118
119
120			/**
121			* @return array
122			*/
123			public function getMessages()
124			{
125			assert(is_array($this->messages));
126			return $this->messages;
127			}
128
129
130			/**
131			* @param string\|null $item
132			*
133			* @return mixed
134			*/
135			public function getOutput($item = null)
136			{
137			assert(is_string($item) \|\| is_null($item));
138			return is_null($item) ? $this->output : (isSet($this->output[$item]) ? $this->output[$item] : null);
139			}
140
141
142			/**
143			* @return State
144			*/
145			public function getState()
146			{
147			assert($this->state instanceof State);
148			return $this->state;
149			}
150
151
152			/**
153			* @return void
154			*/
155			protected function setMessages($messages)
156			{
157			assert(is_array($messages));
158			$this->messages = $messages;
159			}
160
161
162			/**
163			* @param array $messages
164			* @param string\|null $index
165			*
166			* @return void
167			*/
168			protected function addMessages($messages, $index = null)
169			{
170			if ($index === null) {
171			$this->messages = array_merge($this->messages, $messages);
172			} else {
173			foreach ($messages as $message) {
174			$this->messages[$index][] = $message;
175			}
176			}
177			}
178
179
180			/**
181			* @param State $state
182			* @param string $category
183			* @param string $subject
184			* @param string $message
185			*
186			* @return void
187			*/
188			protected function addMessage($state, $category, $subject, $message)
189			{
190			assert(($state instanceof State) && is_string($category) && is_string($subject) && is_string($message));
191			$this->messages[] = array($state, $category, $subject, $message);
192			}
193
194
195			/**
196			* @param mixed $value
197			* @param string\|null $index
198			*
199			* @return void
200			*/
201			protected function addOutput($value, $index = null)
202			{
203			if ($index === null) {
204			$this->output = array_merge($this->output, $value);
205			} else {
206			$this->output[$index] = $value;
207			}
208			}
209
210
211			/**
212			* @return void
213			*/
214			protected function setOutput($output)
215			{
216			assert(is_array($output));
217			$this->output = $output;
218			}
219
220
221			/**
222			* @return void
223			*/
224			protected function setState($state)
225			{
226			assert($state instanceof State);
227			$this->state = $state;
228			}
229			}
230

tvdijen / simplesamlphp-module-monitor

Push — master ( bdf206...96b1f4 )

TestFactory::getState() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like