eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentFieldValidationException

Complexity

Total Complexity

16

Size/Duplication

Total Lines	101
Duplicated Lines	36.63 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
C	visit()	37	72	12
A	translationToString()	0	15	4

<?php

/**
 * File containing the ContentFieldValidationException ValueObjectVisitor class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 *
 * @version //autogentag//
 */
namespace eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor;

use eZ\Publish\API\Repository\Translatable;
use eZ\Publish\API\Repository\Values\Translation;
use eZ\Publish\Core\REST\Common\Output\Generator;
use eZ\Publish\Core\REST\Common\Output\Visitor;
use eZ\Publish\Core\REST\Server\Exceptions\ContentFieldValidationException as RESTContentFieldValidationException;

/**
 * ContentFieldValidationException value object visitor.
 */
class ContentFieldValidationException extends BadRequestException
{
    /**
     * Visit struct returned by controllers.
     *
     * @param \eZ\Publish\Core\REST\Common\Output\Visitor $visitor
     * @param \eZ\Publish\Core\REST\Common\Output\Generator $generator
     * @param \Exception $data
     */
    public function visit(Visitor $visitor, Generator $generator, $data)
    {
        $generator->startObjectElement('ErrorMessage');

        $statusCode = $this->getStatus();
        $visitor->setStatus($statusCode);
        $visitor->setHeader('Content-Type', $generator->getMediaType('ErrorMessage'));

        $generator->startValueElement('errorCode', $statusCode);
        $generator->endValueElement('errorCode');

        $generator->startValueElement('errorMessage', $this->httpStatusCodes[$statusCode]);
        $generator->endValueElement('errorMessage');

        $errorDetails = ['fields' => []];
        if ($data instanceof RESTContentFieldValidationException && $this->translator) {
            $errorDescription = $data->getMessage();

            foreach ($data->getFieldErrors() as $fieldTypeId => $translations) {
                foreach ($translations as $languageCode => $validationErrors) {

The expression $translations of type object<eZ\Publish\Core\FieldType\ValidationError> is not traversable.

                    if (is_array($validationErrors)) {
                        foreach ($validationErrors as $validationError) {
                            if ($validationError instanceof Translatable) {

This code seems to be duplicated across your project.

                                $errorDetails['fields'][$fieldTypeId][] = [
                                    'type' => $validationError->getTarget(),
                                    'message' => $this->translator->trans(
                                        $this->translationToString($validationError->getTranslatableMessage()),
                                        $validationError->getTranslatableMessage()->values,

The property values does not exist on object<eZ\Publish\API\Repository\Values\Translation>. Since you implemented __get, maybe consider adding a @property annotation.

                                        'repository_exceptions'
                                    ),
                                ];
                            }
                        }
                    } else if ($validationErrors instanceof Translatable) {

This code seems to be duplicated across your project.

                        $errorDetails['fields'][$fieldTypeId][] = [
                            'type' => $validationErrors->getTarget(),
                            'message' => $this->translator->trans(
                                $this->translationToString($validationErrors->getTranslatableMessage()),
                                $validationErrors->getTranslatableMessage()->values,
                                'repository_exceptions'
                            ),
                        ];
                    } else {
                        // TODO: exception, invalid ValidationError
                    }
                }
            }
        } else if ($data instanceof Translatable && $this->translator) {

This code seems to be duplicated across your project.

            $errorDescription = $this->translator->trans($data->getMessageTemplate(), $data->getParameters(), 'repository_exceptions');
        } else {
            $errorDescription = $data->getMessage();
        }

        $generator->startValueElement('errorDescription', $errorDescription);
        $generator->endValueElement('errorDescription');

        $generator->startValueElement('errorDetails', $errorDetails);

$errorDetails is of type array<string,array,{"fields":"array"}>, but the function expects a string.

        $generator->endValueElement('errorDetails');

        if ($this->debug) {

This code seems to be duplicated across your project.

            $generator->startValueElement('trace', $data->getTraceAsString());
            $generator->endValueElement('trace');

            $generator->startValueElement('file', $data->getFile());
            $generator->endValueElement('file');

            $generator->startValueElement('line', $data->getLine());
            $generator->endValueElement('line');
        }

        $generator->endObjectElement('ErrorMessage');
    }

    /**
     * TODO there should be some existing code for this somewhere!
     */
    private function translationToString(Translation $translation)
    {
        $result = '';
        if ($translation instanceof Translation\Message) {
            $result = $translation->message;

The property $message is declared protected in eZ\Publish\API\Repository\Values\Translation\Message. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

        } else if ($translation instanceof Translation\Plural) {
            if ($translation->values[0] == 1) {

The property $values is declared protected in eZ\Publish\API\Repository\Values\Translation\Plural. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

                $result = $translation->singular;

The property $singular is declared protected in eZ\Publish\API\Repository\Values\Translation\Plural. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

            } else {
                $result = $translation->plural;

The property $plural is declared protected in eZ\Publish\API\Repository\Values\Translation\Plural. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

            }
        }

        return $result;
    }
}