Content - Code Metrics - Inspection of "EZP-27498: [API] Add shorthand name property on Co..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — api_content_name_shorthand ( e0a75f )

by André

created 2017-06-16 13:26 UTC

Content A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	158
Duplicated Lines	24.05 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	38
loc	158
rs	10
c	0
b	0
f	0
wmc	28
lcom	1
cbo	4

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	9	9	3
A	getVersionInfo()	0	4	1
A	getName()	0	4	1
A	getFieldValue()	12	12	4
A	getFields()	0	4	1
B	getFieldsByLanguage()	17	17	5
B	getField()	0	15	6
A	getProperties()	0	4	1
A	__get()	0	12	3
A	__isset()	0	12	3

How to fix Duplicated Code

<?php

/**
 * File containing the eZ\Publish\Core\Repository\Values\Content\Content 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\Repository\Values\Content;

use eZ\Publish\API\Repository\Values\Content\Content as APIContent;

/**
 * this class represents a content object in a specific version.
 *
 * @property-read \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo convenience getter for $versionInfo->contentInfo
 * @property-read \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType convenience getter for $versionInfo->contentInfo->contentType
 * @property-read mixed $id convenience getter for retrieving the contentId: $versionInfo->content->id
 * @property-read \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo calls getVersionInfo()
 * @property-read \eZ\Publish\API\Repository\Values\Content\Field[] $fields Access fields, calls getFields()
 *
 * @internal Meant for internal use by Repository, type hint against API object instead.
 */
class Content extends APIContent
{
    /**
     * @var mixed[][] An array of array of field values like[$fieldDefIdentifier][$languageCode]
     */
    protected $fields;

    /**
     * @var \eZ\Publish\API\Repository\Values\Content\VersionInfo
     */
    protected $versionInfo;

    /**
     * @var \eZ\Publish\API\Repository\Values\Content\Field[] An array of {@link Field}
     */
    private $internalFields = array();

    /**
     * The first matched field language among user provided prioritized languages.
     *
     * The first matched language among user provided prioritized languages on object retrieval, or null if none
     * provided (all languages) or on main fallback.
     *
     * @internal
     * @var string|null
     */
    protected $prioritizedFieldLanguageCode;

    public function __construct(array $data = array())
    {
        foreach ($data as $propertyName => $propertyValue) {
            $this->$propertyName = $propertyValue;
        }
        foreach ($this->internalFields as $field) {
            $this->fields[$field->fieldDefIdentifier][$field->languageCode] = $field->value;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getVersionInfo()
    {
        return $this->versionInfo;
    }

    /**
     * {@inheritdoc}
     */
    public function getName($languageCode = null)
    {
        return $this->versionInfo->getName($languageCode);
    }

    /**
     * {@inheritdoc}
     */
    public function getFieldValue($fieldDefIdentifier, $languageCode = null)
    {
        if (null === $languageCode) {
            $languageCode = $this->prioritizedFieldLanguageCode ?: $this->versionInfo->contentInfo->mainLanguageCode;
        }

        if (isset($this->fields[$fieldDefIdentifier][$languageCode])) {
            return $this->fields[$fieldDefIdentifier][$languageCode];
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function getFields()
    {
        return $this->internalFields;
    }

    /**
     * {@inheritdoc}
     */
    public function getFieldsByLanguage($languageCode = null)
    {
        $fields = array();

        if (null === $languageCode) {
            $languageCode = $this->prioritizedFieldLanguageCode ?: $this->versionInfo->contentInfo->mainLanguageCode;
        }

        foreach ($this->getFields() as $field) {
            if ($field->languageCode !== $languageCode) {
                continue;
            }
            $fields[$field->fieldDefIdentifier] = $field;
        }

        return $fields;
    }

    /**
     * {@inheritdoc}
     */
    public function getField($fieldDefIdentifier, $languageCode = null)
    {
        if (null === $languageCode) {
            $languageCode = $this->prioritizedFieldLanguageCode ?: $this->versionInfo->contentInfo->mainLanguageCode;
        }

        foreach ($this->getFields() as $field) {
            if ($field->fieldDefIdentifier === $fieldDefIdentifier
                && $field->languageCode === $languageCode) {
                return $field;
            }
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    protected function getProperties($dynamicProperties = array('id', 'contentInfo'))
    {
        return parent::getProperties($dynamicProperties);
    }

    /**
     * {@inheritdoc}
     */
    public function __get($property)
    {
        switch ($property) {
            case 'id':
                return $this->versionInfo->contentInfo->id;

            case 'contentInfo':
                return $this->versionInfo->contentInfo;
        }

        return parent::__get($property);
    }

    /**
     * {@inheritdoc}
     */
    public function __isset($property)
    {
        if ($property === 'id') {
            return true;
        }

        if ($property === 'contentInfo') {
            return true;
        }

        return parent::__isset($property);
    }
}


1		<?php
2
3		/**
4		* File containing the eZ\Publish\Core\Repository\Values\Content\Content 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\Repository\Values\Content;
10
11		use eZ\Publish\API\Repository\Values\Content\Content as APIContent;
12
13		/**
14		* this class represents a content object in a specific version.
15		*
16		* @property-read \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo convenience getter for $versionInfo->contentInfo
17		* @property-read \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType convenience getter for $versionInfo->contentInfo->contentType
18		* @property-read mixed $id convenience getter for retrieving the contentId: $versionInfo->content->id
19		* @property-read \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo calls getVersionInfo()
20		* @property-read \eZ\Publish\API\Repository\Values\Content\Field[] $fields Access fields, calls getFields()
21		*
22		* @internal Meant for internal use by Repository, type hint against API object instead.
23		*/
24		class Content extends APIContent
25		{
26		/**
27		* @var mixed[][] An array of array of field values like[$fieldDefIdentifier][$languageCode]
28		*/
29		protected $fields;
30
31		/**
32		* @var \eZ\Publish\API\Repository\Values\Content\VersionInfo
33		*/
34		protected $versionInfo;
35
36		/**
37		* @var \eZ\Publish\API\Repository\Values\Content\Field[] An array of {@link Field}
38		*/
39		private $internalFields = array();
40
41		/**
42		* The first matched field language among user provided prioritized languages.
43		*
44		* The first matched language among user provided prioritized languages on object retrieval, or null if none
45		* provided (all languages) or on main fallback.
46		*
47		* @internal
48		* @var string\|null
49		*/
50		protected $prioritizedFieldLanguageCode;
51
52	View Code Duplication	public function __construct(array $data = array())
53		{
54		foreach ($data as $propertyName => $propertyValue) {
55		$this->$propertyName = $propertyValue;
56		}
57		foreach ($this->internalFields as $field) {
58		$this->fields[$field->fieldDefIdentifier][$field->languageCode] = $field->value;
		0 ignored issues – show Documentation introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The property `$value` is declared protected in `eZ\Publish\API\Repository\Values\Content\Field`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
59		}
60		}
61
62		/**
63		* {@inheritdoc}
64		*/
65		public function getVersionInfo()
66		{
67		return $this->versionInfo;
68		}
69
70		/**
71		* {@inheritdoc}
72		*/
73		public function getName($languageCode = null)
74		{
75		return $this->versionInfo->getName($languageCode);
76		}
77
78		/**
79		* {@inheritdoc}
80		*/
81	View Code Duplication	public function getFieldValue($fieldDefIdentifier, $languageCode = null)
82		{
83		if (null === $languageCode) {
84		$languageCode = $this->prioritizedFieldLanguageCode ?: $this->versionInfo->contentInfo->mainLanguageCode;
85		}
86
87		if (isset($this->fields[$fieldDefIdentifier][$languageCode])) {
88		return $this->fields[$fieldDefIdentifier][$languageCode];
89		}
90
91		return null;
92		}
93
94		/**
95		* {@inheritdoc}
96		*/
97		public function getFields()
98		{
99		return $this->internalFields;
100		}
101
102		/**
103		* {@inheritdoc}
104		*/
105	View Code Duplication	public function getFieldsByLanguage($languageCode = null)
106		{
107		$fields = array();
108
109		if (null === $languageCode) {
110		$languageCode = $this->prioritizedFieldLanguageCode ?: $this->versionInfo->contentInfo->mainLanguageCode;
111		}
112
113		foreach ($this->getFields() as $field) {
114		if ($field->languageCode !== $languageCode) {
115		continue;
116		}
117		$fields[$field->fieldDefIdentifier] = $field;
118		}
119
120		return $fields;
121		}
122
123		/**
124		* {@inheritdoc}
125		*/
126		public function getField($fieldDefIdentifier, $languageCode = null)
127		{
128		if (null === $languageCode) {
129		$languageCode = $this->prioritizedFieldLanguageCode ?: $this->versionInfo->contentInfo->mainLanguageCode;
130		}
131
132		foreach ($this->getFields() as $field) {
133		if ($field->fieldDefIdentifier === $fieldDefIdentifier
134		&& $field->languageCode === $languageCode) {
135		return $field;
136		}
137		}
138
139		return null;
140		}
141
142		/**
143		* {@inheritdoc}
144		*/
145		protected function getProperties($dynamicProperties = array('id', 'contentInfo'))
146		{
147		return parent::getProperties($dynamicProperties);
148		}
149
150		/**
151		* {@inheritdoc}
152		*/
153		public function __get($property)
154		{
155		switch ($property) {
156		case 'id':
157		return $this->versionInfo->contentInfo->id;
158
159		case 'contentInfo':
160		return $this->versionInfo->contentInfo;
161		}
162
163		return parent::__get($property);
164		}
165
166		/**
167		* {@inheritdoc}
168		*/
169		public function __isset($property)
170		{
171		if ($property === 'id') {
172		return true;
173		}
174
175		if ($property === 'contentInfo') {
176		return true;
177		}
178
179		return parent::__isset($property);
180		}
181		}
182

ezsystems / ezpublish-kernel

Push — api_content_name_shorthand ( e0a75f )

Content A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like