Majora\Framework\Validation\ValidationException

Complexity

Total Complexity

15

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	31	6
A	getEntity()	0	4	1
A	getGroups()	0	4	1
A	getReport()	0	7	2
B	formatReport()	0	26	5

<?php

namespace Majora\Framework\Validation;

use Majora\Framework\Model\CollectionableInterface;
use Majora\Framework\Model\EntityCollection;
use Symfony\Component\Form\FormErrorIterator;
use Symfony\Component\Validator\ConstraintViolationListInterface;

/**
 * Custom exception class for validation exceptions.
 */
class ValidationException extends \InvalidArgumentException
{
    /**
     * @var object
     */
    protected $entity;

    /**
     * @var FormErrorIterator|ConstraintViolationListInterface
     */
    protected $report;

    /**
     * @var array
     */
    protected $groups;

    /**
     * construct.
     *
     * @param object                                             $entity
     * @param FormErrorIterator|ConstraintViolationListInterface $report
     * @param array                                              $groups
     * @param int                                                $code
     * @param \Exception                                         $previous
     */
    public function __construct(
        $entity = null,
        $report = null,
        array $groups = null,
        $code     = null,
        $previous = null
    ) {
        if (!empty($entity) && !is_object($entity)) {
            throw new \InvalidArgumentException('Cannot create a ValidationException from a plain value.');
        }

        $this->entity = $entity;
        $this->groups = $groups;

It seems like $groups can be null. However, the property $groups is declared as array. Maybe change the type of the property to array|null or add a type check?

        $this->report = $report;

        parent::__construct(
            trim(sprintf(
                'Validation failed on %s%s',
                $this->entity ? get_class($this->entity) : '',
                $this->entity instanceof CollectionableInterface ?
                    sprintf('#%s', $this->entity->getId()) :
                    ''
                ,
                empty($this->groups) ? '' : sprintf(' for ["%s"] groups',
                    implode('", "', $this->groups)
                )
            )),
            $code,
            $previous
        );
    }

    /**
     * return failed entity
     *
     * @return object
     */
    public function getEntity()
    {
        return $this->entity;
    }

    /**
     * return validation groups which are failing
     *
     * @return array
     */
    public function getGroups()
    {
        return $this->groups;
    }

    /**
     * return violation list report
     *
     * @return EntityCollection|FormErrorIterator|ConstraintViolationListInterface
     */
    public function getReport()
    {
        return $this->report ?
            $this->report :
            new EntityCollection()
        ;
    }

    /**
     * format and return report (translatable) messages
     *
     * @return array
     */
    public function formatReport()
    {
        $messages = array();
        $report = $this->getReport();

        switch(true){

            case $report instanceof ConstraintViolationListInterface:
                foreach ($report as $constraintViolation){
                    $messages[] = $constraintViolation->getMessage();
                }
                break;

            case $report instanceof FormErrorIterator:
                foreach ($report as $formError) {
                    $messages[] = $formError->getMessage();

The method getMessage() does not seem to exist on object<Symfony\Component\Form\FormErrorIterator>.

                }
                break;

            default:
                $messages[] = $this->getMessage();

        }

        return $messages;
    }
}