FieldDefinitionUpdate::__construct() - Code Metrics - Inspection of "EZP-30696: Changed Repository::sudo typehint form..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp-30696 ( 9bb3ad...3bd812 )

unknown

created 2019-06-26 13:59 UTC

FieldDefinitionUpdate::__construct() A

↳ Parent: FieldDefinitionUpdate

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	3
dl	0
loc	6
rs	10
c	0
b	0
f	0

<?php

/**
 * File containing the FieldDefinitionUpdate parser 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.
 */
namespace eZ\Publish\Core\REST\Server\Input\Parser;

use eZ\Publish\Core\REST\Common\Input\BaseParser;
use eZ\Publish\Core\REST\Common\Input\ParsingDispatcher;
use eZ\Publish\Core\REST\Common\Input\FieldTypeParser;
use eZ\Publish\Core\REST\Common\Input\ParserTools;
use eZ\Publish\API\Repository\ContentTypeService;
use eZ\Publish\Core\REST\Common\Exceptions;

/**
 * Parser for FieldDefinitionUpdate.
 */
class FieldDefinitionUpdate extends BaseParser
{
    /**
     * ContentType service.
     *
     * @var \eZ\Publish\API\Repository\ContentTypeService
     */
    protected $contentTypeService;

    /**
     * FieldType parser.
     *
     * @var \eZ\Publish\Core\REST\Common\Input\FieldTypeParser
     */
    protected $fieldTypeParser;

    /**
     * Parser tools.
     *
     * @var \eZ\Publish\Core\REST\Common\Input\ParserTools
     */
    protected $parserTools;

    /**
     * Construct.
     *
     * @param \eZ\Publish\API\Repository\ContentTypeService $contentTypeService
     * @param \eZ\Publish\Core\REST\Common\Input\ParserTools $parserTools
     */
    public function __construct(ContentTypeService $contentTypeService, FieldTypeParser $fieldTypeParser, ParserTools $parserTools)
    {
        $this->contentTypeService = $contentTypeService;
        $this->fieldTypeParser = $fieldTypeParser;
        $this->parserTools = $parserTools;
    }

    /**
     * Parse input structure.
     *
     * @param array $data
     * @param \eZ\Publish\Core\REST\Common\Input\ParsingDispatcher $parsingDispatcher
     *
     * @return \eZ\Publish\API\Repository\Values\ContentType\FieldDefinitionUpdateStruct
     */
    public function parse(array $data, ParsingDispatcher $parsingDispatcher)
    {
        $fieldDefinitionUpdate = $this->contentTypeService->newFieldDefinitionUpdateStruct();

        if (array_key_exists('identifier', $data)) {
            $fieldDefinitionUpdate->identifier = $data['identifier'];
        }

        // @todo XSD says that descriptions is mandatory, but field definition can be updated without it
        if (array_key_exists('names', $data)) {
            if (!is_array($data['names']) || !array_key_exists('value', $data['names']) || !is_array($data['names']['value'])) {
                throw new Exceptions\Parser("Invalid 'names' element for FieldDefinitionUpdate.");
            }

            $fieldDefinitionUpdate->names = $this->parserTools->parseTranslatableList($data['names']);
        }

        // @todo XSD says that descriptions is mandatory, but field definition can be updated without it
        if (array_key_exists('descriptions', $data)) {
            if (!is_array($data['descriptions']) || !array_key_exists('value', $data['descriptions']) || !is_array($data['descriptions']['value'])) {
                throw new Exceptions\Parser("Invalid 'descriptions' element for FieldDefinitionUpdate.");
            }

            $fieldDefinitionUpdate->descriptions = $this->parserTools->parseTranslatableList($data['descriptions']);
        }

        // @todo XSD says that fieldGroup is mandatory, but field definition can be updated without it
        if (array_key_exists('fieldGroup', $data)) {
            $fieldDefinitionUpdate->fieldGroup = $data['fieldGroup'];
        }

        // @todo XSD says that position is mandatory, but field definition can be updated without it
        if (array_key_exists('position', $data)) {
            $fieldDefinitionUpdate->position = (int)$data['position'];
        }

        // @todo XSD says that isTranslatable is mandatory, but field definition can be updated without it
        if (array_key_exists('isTranslatable', $data)) {
            $fieldDefinitionUpdate->isTranslatable = $this->parserTools->parseBooleanValue($data['isTranslatable']);
        }

        // @todo XSD says that isRequired is mandatory, but field definition can be updated without it
        if (array_key_exists('isRequired', $data)) {
            $fieldDefinitionUpdate->isRequired = $this->parserTools->parseBooleanValue($data['isRequired']);
        }

        // @todo XSD says that isInfoCollector is mandatory, but field definition can be updated without it
        if (array_key_exists('isInfoCollector', $data)) {
            $fieldDefinitionUpdate->isInfoCollector = $this->parserTools->parseBooleanValue($data['isInfoCollector']);
        }

        // @todo XSD says that isSearchable is mandatory, but field definition can be updated without it
        if (array_key_exists('isSearchable', $data)) {
            $fieldDefinitionUpdate->isSearchable = $this->parserTools->parseBooleanValue($data['isSearchable']);
        }

        $fieldDefinition = $this->getFieldDefinition($data);

        // @todo XSD says that defaultValue is mandatory, but content type can be created without it
        if (array_key_exists('defaultValue', $data)) {
            $fieldDefinitionUpdate->defaultValue = $this->fieldTypeParser->parseValue(
                $fieldDefinition->fieldTypeIdentifier,
                $data['defaultValue']
            );
        }

        if (array_key_exists('validatorConfiguration', $data)) {

            $fieldDefinitionUpdate->validatorConfiguration = $this->fieldTypeParser->parseValidatorConfiguration(
                $fieldDefinition->fieldTypeIdentifier,
                $data['validatorConfiguration']
            );
        }

        if (array_key_exists('fieldSettings', $data)) {

            $fieldDefinitionUpdate->fieldSettings = $this->fieldTypeParser->parseFieldSettings(
                $fieldDefinition->fieldTypeIdentifier,
                $data['fieldSettings']
            );
        }

        return $fieldDefinitionUpdate;
    }

    /**
     * Returns field definition by 'typeFieldDefinitionDraft' pattern URL.
     *
     * Assumes given $data array has '__url' element set.
     *
     * @todo depends on temporary solution to give parser access to the URL
     *
     * @see \eZ\Publish\Core\REST\Server\Controller\ContentType::updateFieldDefinition
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
     *
     * @param array $data
     *
     * @return \eZ\Publish\API\Repository\Values\ContentType\FieldDefinition
     */
    protected function getFieldDefinition(array $data)
    {
        $contentTypeId = $this->requestParser->parseHref($data['__url'], 'contentTypeId');
        $fieldDefinitionId = $this->requestParser->parseHref($data['__url'], 'fieldDefinitionId');

        $contentTypeDraft = $this->contentTypeService->loadContentTypeDraft($contentTypeId);
        foreach ($contentTypeDraft->getFieldDefinitions() as $fieldDefinition) {
            if ($fieldDefinition->id == $fieldDefinitionId) {
                return $fieldDefinition;
            }
        }
        throw new Exceptions\NotFoundException("Field definition not found: '{$data['__url']}'.");
    }
}


1		<?php
2
3		/**
4		* File containing the FieldDefinitionUpdate parser class.
5		*
6		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7		* @license For full copyright and license information view LICENSE file distributed with this source code.
8		*/
9		namespace eZ\Publish\Core\REST\Server\Input\Parser;
10
11		use eZ\Publish\Core\REST\Common\Input\BaseParser;
12		use eZ\Publish\Core\REST\Common\Input\ParsingDispatcher;
13		use eZ\Publish\Core\REST\Common\Input\FieldTypeParser;
14		use eZ\Publish\Core\REST\Common\Input\ParserTools;
15		use eZ\Publish\API\Repository\ContentTypeService;
16		use eZ\Publish\Core\REST\Common\Exceptions;
17
18		/**
19		* Parser for FieldDefinitionUpdate.
20		*/
21		class FieldDefinitionUpdate extends BaseParser
22		{
23		/**
24		* ContentType service.
25		*
26		* @var \eZ\Publish\API\Repository\ContentTypeService
27		*/
28		protected $contentTypeService;
29
30		/**
31		* FieldType parser.
32		*
33		* @var \eZ\Publish\Core\REST\Common\Input\FieldTypeParser
34		*/
35		protected $fieldTypeParser;
36
37		/**
38		* Parser tools.
39		*
40		* @var \eZ\Publish\Core\REST\Common\Input\ParserTools
41		*/
42		protected $parserTools;
43
44		/**
45		* Construct.
46		*
47		* @param \eZ\Publish\API\Repository\ContentTypeService $contentTypeService
48		* @param \eZ\Publish\Core\REST\Common\Input\ParserTools $parserTools
49		*/
50		public function __construct(ContentTypeService $contentTypeService, FieldTypeParser $fieldTypeParser, ParserTools $parserTools)
51		{
52		$this->contentTypeService = $contentTypeService;
53		$this->fieldTypeParser = $fieldTypeParser;
54		$this->parserTools = $parserTools;
55		}
56
57		/**
58		* Parse input structure.
59		*
60		* @param array $data
61		* @param \eZ\Publish\Core\REST\Common\Input\ParsingDispatcher $parsingDispatcher
62		*
63		* @return \eZ\Publish\API\Repository\Values\ContentType\FieldDefinitionUpdateStruct
64		*/
65		public function parse(array $data, ParsingDispatcher $parsingDispatcher)
66		{
67		$fieldDefinitionUpdate = $this->contentTypeService->newFieldDefinitionUpdateStruct();
68
69		if (array_key_exists('identifier', $data)) {
70		$fieldDefinitionUpdate->identifier = $data['identifier'];
71		}
72
73		// @todo XSD says that descriptions is mandatory, but field definition can be updated without it
74		if (array_key_exists('names', $data)) {
75		if (!is_array($data['names']) \|\| !array_key_exists('value', $data['names']) \|\| !is_array($data['names']['value'])) {
76		throw new Exceptions\Parser("Invalid 'names' element for FieldDefinitionUpdate.");
77		}
78
79		$fieldDefinitionUpdate->names = $this->parserTools->parseTranslatableList($data['names']);
80		}
81
82		// @todo XSD says that descriptions is mandatory, but field definition can be updated without it
83		if (array_key_exists('descriptions', $data)) {
84		if (!is_array($data['descriptions']) \|\| !array_key_exists('value', $data['descriptions']) \|\| !is_array($data['descriptions']['value'])) {
85		throw new Exceptions\Parser("Invalid 'descriptions' element for FieldDefinitionUpdate.");
86		}
87
88		$fieldDefinitionUpdate->descriptions = $this->parserTools->parseTranslatableList($data['descriptions']);
89		}
90
91		// @todo XSD says that fieldGroup is mandatory, but field definition can be updated without it
92		if (array_key_exists('fieldGroup', $data)) {
93		$fieldDefinitionUpdate->fieldGroup = $data['fieldGroup'];
94		}
95
96		// @todo XSD says that position is mandatory, but field definition can be updated without it
97		if (array_key_exists('position', $data)) {
98		$fieldDefinitionUpdate->position = (int)$data['position'];
99		}
100
101		// @todo XSD says that isTranslatable is mandatory, but field definition can be updated without it
102		if (array_key_exists('isTranslatable', $data)) {
103		$fieldDefinitionUpdate->isTranslatable = $this->parserTools->parseBooleanValue($data['isTranslatable']);
104		}
105
106		// @todo XSD says that isRequired is mandatory, but field definition can be updated without it
107		if (array_key_exists('isRequired', $data)) {
108		$fieldDefinitionUpdate->isRequired = $this->parserTools->parseBooleanValue($data['isRequired']);
109		}
110
111		// @todo XSD says that isInfoCollector is mandatory, but field definition can be updated without it
112		if (array_key_exists('isInfoCollector', $data)) {
113		$fieldDefinitionUpdate->isInfoCollector = $this->parserTools->parseBooleanValue($data['isInfoCollector']);
114		}
115
116		// @todo XSD says that isSearchable is mandatory, but field definition can be updated without it
117		if (array_key_exists('isSearchable', $data)) {
118		$fieldDefinitionUpdate->isSearchable = $this->parserTools->parseBooleanValue($data['isSearchable']);
119		}
120
121		$fieldDefinition = $this->getFieldDefinition($data);
122
123		// @todo XSD says that defaultValue is mandatory, but content type can be created without it
124		if (array_key_exists('defaultValue', $data)) {
125		$fieldDefinitionUpdate->defaultValue = $this->fieldTypeParser->parseValue(
126		$fieldDefinition->fieldTypeIdentifier,
127		$data['defaultValue']
128		);
129		}
130
131	View Code Duplication	if (array_key_exists('validatorConfiguration', $data)) {
		0 ignored issues – show Duplication introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
132		$fieldDefinitionUpdate->validatorConfiguration = $this->fieldTypeParser->parseValidatorConfiguration(
133		$fieldDefinition->fieldTypeIdentifier,
134		$data['validatorConfiguration']
135		);
136		}
137
138	View Code Duplication	if (array_key_exists('fieldSettings', $data)) {
		0 ignored issues – show Duplication introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
139		$fieldDefinitionUpdate->fieldSettings = $this->fieldTypeParser->parseFieldSettings(
140		$fieldDefinition->fieldTypeIdentifier,
141		$data['fieldSettings']
142		);
143		}
144
145		return $fieldDefinitionUpdate;
146		}
147
148		/**
149		* Returns field definition by 'typeFieldDefinitionDraft' pattern URL.
150		*
151		* Assumes given $data array has '__url' element set.
152		*
153		* @todo depends on temporary solution to give parser access to the URL
154		*
155		* @see \eZ\Publish\Core\REST\Server\Controller\ContentType::updateFieldDefinition
156		*
157		* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
158		*
159		* @param array $data
160		*
161		* @return \eZ\Publish\API\Repository\Values\ContentType\FieldDefinition
162		*/
163		protected function getFieldDefinition(array $data)
164		{
165		$contentTypeId = $this->requestParser->parseHref($data['__url'], 'contentTypeId');
166		$fieldDefinitionId = $this->requestParser->parseHref($data['__url'], 'fieldDefinitionId');
167
168		$contentTypeDraft = $this->contentTypeService->loadContentTypeDraft($contentTypeId);
169		foreach ($contentTypeDraft->getFieldDefinitions() as $fieldDefinition) {
170		if ($fieldDefinition->id == $fieldDefinitionId) {
171		return $fieldDefinition;
172		}
173		}
174		throw new Exceptions\NotFoundException("Field definition not found: '{$data['__url']}'.");
175		}
176		}
177

ezsystems / ezpublish-kernel

Push — ezp-30696 ( 9bb3ad...3bd812 )

FieldDefinitionUpdate::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like