Freshcells\StateInspector\Inspection\AbstractInspection

Complexity

Total Complexity

4

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

50%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	inspect()	0	1	?
	supports()	0	1	?
A	success()	0	4	1
A	failure()	0	10	1
A	addIssue()	0	4	1
A	getIssues()	0	4	1

<?php

namespace Freshcells\StateInspector\Inspection;

use Freshcells\StateInspector\Exception\StateInspectorException;
use Freshcells\StateInspector\Issue\Issue;
use Freshcells\StateInspector\Issue\IssueInterface;

/**
 * Class AbstractInspection
 * @package Freshcells\StateInspector\Inspection
 */
abstract class AbstractInspection implements InspectionInterface
{
    /**
     * @var array
     */
    private $issues = [];

    /**
     * @param $object
     * @return bool
     */
    abstract public function inspect($object):bool;

    /**
     * @param mixed $object
     * @return bool
     */
    abstract public function supports($object):bool;

    /**
     *
     */
    public function success()
    {
        // hooray i could celebrate now
    }

    /**
     * you probably want to override this
     * @throws StateInspectorException
     */
    public function failure()
    {
        $issue = new Issue(
            'Something is not right in the State of Denmark',
            'You probably want to override this method',
            'This would be the solution'
        );
        $this->addIssue($issue);
        throw new StateInspectorException($issue);
    }

    /**
     * @param IssueInterface $issue
     */
    public function addIssue(IssueInterface $issue)
    {
        $this->issues[] = $issue;
    }

    /**
     * @return IssueInterface[]
     */
    public function getIssues():array
    {
        return $this->issues;
    }
}