Field::parse() - Code Metrics - Inspection of "Merge branch '6.13'" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5f67eb...e271d9 )

unknown

created 2018-06-29 10:06 UTC

Field::parse() B

↳ Parent: Field

Complexity

Conditions	9
Paths	14

Size

Total Lines

Duplication

Lines	3
Ratio	7.89 %

Importance

Changes

Metric	Value
cc	9
nc	14
nop	2
dl	3
loc	38
rs	7.7564
c	0
b	0
f	0

<?php

/**
 * @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\SortClause;

use eZ\Publish\API\Repository\Values\Content\Query;
use eZ\Publish\Core\REST\Common\Input\BaseParser;
use eZ\Publish\Core\REST\Common\Input\ParsingDispatcher;
use eZ\Publish\Core\REST\Common\Exceptions;
use eZ\Publish\API\Repository\Values\Content\Query\SortClause\Field as FieldSortClause;

class Field extends BaseParser
{
    /**
     * Parse input structure for Field sort clause.
     *
     * @param array $data
     * @param \eZ\Publish\Core\REST\Common\Input\ParsingDispatcher $parsingDispatcher
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Query\SortClause\Field
     */
    public function parse(array $data, ParsingDispatcher $parsingDispatcher)
    {
        if (!isset($data['Field'])) {
            throw new Exceptions\Parser("The <Field> sort clause doesn't exist in the input structure");
        }

        if (!is_array($data['Field'])) {
            throw new Exceptions\Parser('The <Field> sort clause has missing arguments: contentTypeIdentifier, fieldDefinitionIdentifier');
        }

        $data['Field'] = $this->normalizeData($data['Field']);

        $direction = isset($data['Field']['direction']) ? $data['Field']['direction'] : null;

        if (!in_array($direction, [Query::SORT_ASC, Query::SORT_DESC])) {

            throw new Exceptions\Parser('Invalid direction format in <Field> sort clause');
        }

        if (isset($data['Field']['identifier'])) {
            if (false === strpos($data['Field']['identifier'], '/')) {
                throw new Exceptions\Parser('<Field> sort clause parameter "identifier" value has to be in "contentTypeIdentifier/fieldDefinitionIdentifier" format');
            }

            list($contentTypeIdentifier, $fieldDefinitionIdentifier) = explode('/', $data['Field']['identifier'], 2);
        } else {
            if (!isset($data['Field']['contentTypeIdentifier'])) {
                throw new Exceptions\Parser('<Field> sort clause have missing parameter "contentTypeIdentifier"');
            }
            if (!isset($data['Field']['fieldDefinitionIdentifier'])) {
                throw new Exceptions\Parser('<Field> sort clause have missing parameter "fieldDefinitionIdentifier"');
            }

            $contentTypeIdentifier = $data['Field']['contentTypeIdentifier'];
            $fieldDefinitionIdentifier = $data['Field']['fieldDefinitionIdentifier'];
        }

        return new FieldSortClause($contentTypeIdentifier, $fieldDefinitionIdentifier, $direction);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Normalize passed Field Sort Clause data by making both xml and json parameters to have same names (by dropping
     * xml "_" prefix and changing "#text" xml attribute to "direction").
     *
     * @param array $data
     *
     * @return array
     */
    private function normalizeData($data)
    {
        $normalizedData = [];

        foreach ($data as $key => $value) {
            if ('#text' === $key) {
                $key = 'direction';
            }

            $normalizedData[trim($key, '_')] = $value;
        }

        return $normalizedData;
    }
}


1		<?php
2
3		/**
4		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5		* @license For full copyright and license information view LICENSE file distributed with this source code.
6		*/
7		namespace eZ\Publish\Core\REST\Server\Input\Parser\SortClause;
8
9		use eZ\Publish\API\Repository\Values\Content\Query;
10		use eZ\Publish\Core\REST\Common\Input\BaseParser;
11		use eZ\Publish\Core\REST\Common\Input\ParsingDispatcher;
12		use eZ\Publish\Core\REST\Common\Exceptions;
13		use eZ\Publish\API\Repository\Values\Content\Query\SortClause\Field as FieldSortClause;
14
15		class Field extends BaseParser
16		{
17		/**
18		* Parse input structure for Field sort clause.
19		*
20		* @param array $data
21		* @param \eZ\Publish\Core\REST\Common\Input\ParsingDispatcher $parsingDispatcher
22		*
23		* @return \eZ\Publish\API\Repository\Values\Content\Query\SortClause\Field
24		*/
25		public function parse(array $data, ParsingDispatcher $parsingDispatcher)
26		{
27		if (!isset($data['Field'])) {
28		throw new Exceptions\Parser("The <Field> sort clause doesn't exist in the input structure");
29		}
30
31		if (!is_array($data['Field'])) {
32		throw new Exceptions\Parser('The <Field> sort clause has missing arguments: contentTypeIdentifier, fieldDefinitionIdentifier');
33		}
34
35		$data['Field'] = $this->normalizeData($data['Field']);
36
37		$direction = isset($data['Field']['direction']) ? $data['Field']['direction'] : null;
38
39	View Code Duplication	if (!in_array($direction, [Query::SORT_ASC, Query::SORT_DESC])) {
		0 ignored issues – show Duplication introduced 2018-06-29 07:56 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...
40		throw new Exceptions\Parser('Invalid direction format in <Field> sort clause');
41		}
42
43		if (isset($data['Field']['identifier'])) {
44		if (false === strpos($data['Field']['identifier'], '/')) {
45		throw new Exceptions\Parser('<Field> sort clause parameter "identifier" value has to be in "contentTypeIdentifier/fieldDefinitionIdentifier" format');
46		}
47
48		list($contentTypeIdentifier, $fieldDefinitionIdentifier) = explode('/', $data['Field']['identifier'], 2);
49		} else {
50		if (!isset($data['Field']['contentTypeIdentifier'])) {
51		throw new Exceptions\Parser('<Field> sort clause have missing parameter "contentTypeIdentifier"');
52		}
53		if (!isset($data['Field']['fieldDefinitionIdentifier'])) {
54		throw new Exceptions\Parser('<Field> sort clause have missing parameter "fieldDefinitionIdentifier"');
55		}
56
57		$contentTypeIdentifier = $data['Field']['contentTypeIdentifier'];
58		$fieldDefinitionIdentifier = $data['Field']['fieldDefinitionIdentifier'];
59		}
60
61		return new FieldSortClause($contentTypeIdentifier, $fieldDefinitionIdentifier, $direction);
		0 ignored issues – show Bug Best Practice introduced 2018-06-29 07:56 UTC by Report Bug Copy Issue Report The return type of `return new \eZ\Publish\A...dentifier, $direction);` (`eZ\Publish\API\Repositor...\Query\SortClause\Field`) is incompatible with the return type declared by the abstract method `eZ\Publish\Core\REST\Common\Input\Parser::parse` of type `eZ\Publish\API\Repository\Values\ValueObject`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
62		}
63
64		/**
65		* Normalize passed Field Sort Clause data by making both xml and json parameters to have same names (by dropping
66		* xml "_" prefix and changing "#text" xml attribute to "direction").
67		*
68		* @param array $data
69		*
70		* @return array
71		*/
72		private function normalizeData($data)
73		{
74		$normalizedData = [];
75
76		foreach ($data as $key => $value) {
77		if ('#text' === $key) {
78		$key = 'direction';
79		}
80
81		$normalizedData[trim($key, '_')] = $value;
82		}
83
84		return $normalizedData;
85		}
86		}
87

ezsystems / ezpublish-kernel

Push — master ( 5f67eb...e271d9 )

Field::parse() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like