InformationCollectionMapper - Code Metrics - Inspection of "Refactoring for v2" - netgen/NetgenInformationCollectionBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b5dfb6...a568a9 )

by Mario

created 2019-02-11 11:09 UTC

InformationCollectionMapper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

Metric	Value
wmc	4
lcom	0
cbo	3
dl	0
loc	44
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	mapToFormData()	0	26	3
A	configureOptions()	0	6	1

<?php

declare(strict_types=1);

namespace Netgen\InformationCollection\Integration\RepositoryForms;

use eZ\Publish\API\Repository\Values\ContentType\ContentType;
use eZ\Publish\API\Repository\Values\ContentType\FieldDefinition;
use eZ\Publish\API\Repository\Values\ValueObject;
use eZ\Publish\SPI\Search\Field;
use EzSystems\RepositoryForms\Data\Content\FieldData;
use EzSystems\RepositoryForms\Data\Mapper\FormDataMapperInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class InformationCollectionMapper implements FormDataMapperInterface
{
    /**
     * Maps a ValueObject from eZ content repository to a data usable as underlying form data (e.g. create/update struct).
     *
     * @param \eZ\Publish\API\Repository\Values\ValueObject|\eZ\Publish\API\Repository\Values\Content\Content $contentDraft
     * @param array $params
     *
     * @return InformationCollectionData
     */
    public function mapToFormData(ValueObject $contentDraft, array $params = [])
    {
        $optionsResolver = new OptionsResolver();
        $this->configureOptions($optionsResolver);

        $params = $optionsResolver->resolve($params);
        $languageCode = $params['languageCode'];

        $data = new InformationCollectionData(['contentDraft' => $contentDraft]);
        $data->initialLanguageCode = $languageCode;

        $fields = $contentDraft->getFieldsByLanguage($languageCode);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        /** @var FieldDefinition $fieldDef */
        foreach ($params['contentType']->fieldDefinitions as $fieldDef) {
            if ($fieldDef->isInfoCollector) {
                $field = $fields[$fieldDef->identifier];
                $data->addFieldData(new FieldData([
                    'fieldDefinition' => $fieldDef,
                    'field' => $field,
                    'value' => $field->value,
                ]));
            }
        }

        return $data;
    }

    private function configureOptions(OptionsResolver $optionsResolver)
    {
        $optionsResolver
            ->setRequired(['languageCode', 'contentType'])
            ->setAllowedTypes('contentType', ContentType::class);
    }
}


GitHub Access Token became invalid

Push — master ( b5dfb6...a568a9 )

InformationCollectionMapper A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Available Fixes

1			<?php
2
3			declare(strict_types=1);
4
5			namespace Netgen\InformationCollection\Integration\RepositoryForms;
6
7			use eZ\Publish\API\Repository\Values\ContentType\ContentType;
8			use eZ\Publish\API\Repository\Values\ContentType\FieldDefinition;
9			use eZ\Publish\API\Repository\Values\ValueObject;
10			use eZ\Publish\SPI\Search\Field;
11			use EzSystems\RepositoryForms\Data\Content\FieldData;
12			use EzSystems\RepositoryForms\Data\Mapper\FormDataMapperInterface;
13			use Symfony\Component\OptionsResolver\OptionsResolver;
14
15			class InformationCollectionMapper implements FormDataMapperInterface
16			{
17			/**
18			* Maps a ValueObject from eZ content repository to a data usable as underlying form data (e.g. create/update struct).
19			*
20			* @param \eZ\Publish\API\Repository\Values\ValueObject\|\eZ\Publish\API\Repository\Values\Content\Content $contentDraft
21			* @param array $params
22			*
23			* @return InformationCollectionData
24			*/
25			public function mapToFormData(ValueObject $contentDraft, array $params = [])
26			{
27			$optionsResolver = new OptionsResolver();
28			$this->configureOptions($optionsResolver);
29
30			$params = $optionsResolver->resolve($params);
31			$languageCode = $params['languageCode'];
32
33			$data = new InformationCollectionData(['contentDraft' => $contentDraft]);
34			$data->initialLanguageCode = $languageCode;
35
36			$fields = $contentDraft->getFieldsByLanguage($languageCode);
			0 ignored issues – show Bug introduced 2018-11-12 14:46 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `eZ\Publish\API\Repository\Values\ValueObject` as the method `getFieldsByLanguage()` does only exist in the following sub-classes of `eZ\Publish\API\Repository\Values\ValueObject`: `eZ\Publish\API\Repository\Values\Content\Content`, `eZ\Publish\API\Repository\Values\User\User`, `eZ\Publish\API\Repository\Values\User\UserGroup`, `eZ\Publish\Core\REST\Client\Values\Content\Content`, `eZ\Publish\Core\REST\Client\Values\User\User`, `eZ\Publish\Core\REST\Client\Values\User\UserGroup`, `eZ\Publish\Core\Repository\Values\Content\Content`, `eZ\Publish\Core\Reposito...es\Content\ContentProxy`, `eZ\Publish\Core\Repository\Values\User\User`, `eZ\Publish\Core\Repository\Values\User\UserGroup`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
37			/** @var FieldDefinition $fieldDef */
38			foreach ($params['contentType']->fieldDefinitions as $fieldDef) {
39			if ($fieldDef->isInfoCollector) {
40			$field = $fields[$fieldDef->identifier];
41			$data->addFieldData(new FieldData([
42			'fieldDefinition' => $fieldDef,
43			'field' => $field,
44			'value' => $field->value,
45			]));
46			}
47			}
48
49			return $data;
50			}
51
52			private function configureOptions(OptionsResolver $optionsResolver)
53			{
54			$optionsResolver
55			->setRequired(['languageCode', 'contentType'])
56			->setAllowedTypes('contentType', ContentType::class);
57			}
58			}
59

netgen / NetgenInformationCollectionBundle

GitHub Access Token became invalid

Push — master ( b5dfb6...a568a9 )

InformationCollectionMapper A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like