SimpleSAML\Module\monitor\TestFactory

Complexity

Total Complexity

29

Size/Duplication

Total Lines	225
Duplicated Lines	0 %

Coupling/Cohesion

Components	6
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	setConfiguration()	0	7	2
A	getConfiguration()	0	5	1
A	getTestData()	0	5	2
A	setTestData()	0	7	3
A	setTestResult()	0	5	1
A	addTestResult()	0	5	1
A	getTestResult()	0	5	1
A	getMessages()	0	5	1
A	getOutput()	0	5	4
A	getState()	0	5	1
A	setMessages()	0	5	1
A	addMessages()	0	10	3
A	addMessage()	0	5	4
A	addOutput()	0	8	2
A	setOutput()	0	5	1
A	setState()	0	5	1

<?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;

It seems like $testResult of type object<SimpleSAML\Module\monitor\TestResult> is incompatible with the declared type array<integer,object<SimpleSAML\Module\monitor\TestResult>> of property $testResult.

    }


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


    /**
     * @return TestResult

Consider making the return type a bit more specific; maybe use NoType.

     */
    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;
    }
}