FirstMatchingFieldStrategy::getThumbnail() - Code Metrics - Inspection of "EZP-30882: As a developer I want to use custom Fie..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp-30882-thumbnail ( d9f236...3bd997 )

unknown

created 2019-12-11 14:18 UTC

FirstMatchingFieldStrategy::getThumbnail() B

↳ Parent: FirstMatchingFieldStrategy

Complexity

Conditions	6
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
nc	4
nop	2
dl	0
loc	24
rs	8.9137
c	0
b	0
f	0

<?php

namespace eZ\Publish\Core\Repository\Strategy\ContentThumbnail;

use eZ\Publish\API\Repository\FieldTypeService;
use eZ\Publish\API\Repository\Values\Content\Content;
use eZ\Publish\API\Repository\Values\Content\Field;
use eZ\Publish\API\Repository\Values\Content\Thumbnail;
use eZ\Publish\API\Repository\Values\ContentType\ContentType;
use eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\Field\ThumbnailStrategy as ContentFieldThumbnailStrategy;
use eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\ThumbnailStrategy;
use eZ\Publish\SPI\Variation\Values\ImageVariation;

class FirstMatchingFieldStrategy implements ThumbnailStrategy
{
    /** @var \eZ\Publish\API\Repository\FieldTypeService */
    private $fieldTypeService;

    /** @var \eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\Field\ThumbnailStrategy */
    private $contentFieldStrategy;

    public function __construct(
        ContentFieldThumbnailStrategy $contentFieldStrategy,
        FieldTypeService $fieldTypeService
    ) {
        $this->contentFieldStrategy = $contentFieldStrategy;
        $this->fieldTypeService = $fieldTypeService;
    }

    public function getThumbnail(ContentType $contentType, array $fields): ?Thumbnail
    {
        $fieldDefinitions = $contentType->getFieldDefinitions();

        foreach ($fieldDefinitions as $fieldDefinition) {
            $field = $this->getFieldByIdentifier($fieldDefinition->identifier, $fields);

            if ($field === null) {
                continue;
            }

            $fieldType = $this->fieldTypeService->getFieldType($fieldDefinition->fieldTypeIdentifier);

            if (
                $fieldDefinition->isThumbnail
                && $this->contentFieldStrategy->hasStrategy($field->fieldTypeIdentifier)
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
                && !$fieldType->isEmptyValue($field->value)
            ) {
                return $this->contentFieldStrategy->getThumbnail($field);
            }
        }

        return null;
    }

    private function getFieldByIdentifier(string $identifier, array $fields): ?Field
    {
        /** @var \eZ\Publish\API\Repository\Values\Content\Field $field */
        foreach ($fields as $field) {
            if ($field->fieldDefIdentifier === $identifier) {
                return $field;
            }
        }

        return null;
    }
}

1			<?php
2
3			namespace eZ\Publish\Core\Repository\Strategy\ContentThumbnail;
4
5			use eZ\Publish\API\Repository\FieldTypeService;
6			use eZ\Publish\API\Repository\Values\Content\Content;
7			use eZ\Publish\API\Repository\Values\Content\Field;
8			use eZ\Publish\API\Repository\Values\Content\Thumbnail;
9			use eZ\Publish\API\Repository\Values\ContentType\ContentType;
10			use eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\Field\ThumbnailStrategy as ContentFieldThumbnailStrategy;
11			use eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\ThumbnailStrategy;
12			use eZ\Publish\SPI\Variation\Values\ImageVariation;
13
14			class FirstMatchingFieldStrategy implements ThumbnailStrategy
15			{
16			/** @var \eZ\Publish\API\Repository\FieldTypeService */
17			private $fieldTypeService;
18
19			/** @var \eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\Field\ThumbnailStrategy */
20			private $contentFieldStrategy;
21
22			public function __construct(
23			ContentFieldThumbnailStrategy $contentFieldStrategy,
24			FieldTypeService $fieldTypeService
25			) {
26			$this->contentFieldStrategy = $contentFieldStrategy;
27			$this->fieldTypeService = $fieldTypeService;
28			}
29
30			public function getThumbnail(ContentType $contentType, array $fields): ?Thumbnail
31			{
32			$fieldDefinitions = $contentType->getFieldDefinitions();
33
34			foreach ($fieldDefinitions as $fieldDefinition) {
35			$field = $this->getFieldByIdentifier($fieldDefinition->identifier, $fields);
36
37			if ($field === null) {
38			continue;
39			}
40
41			$fieldType = $this->fieldTypeService->getFieldType($fieldDefinition->fieldTypeIdentifier);
42
43			if (
44			$fieldDefinition->isThumbnail
45			&& $this->contentFieldStrategy->hasStrategy($field->fieldTypeIdentifier)
			0 ignored issues – show Bug introduced 2019-08-23 08:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `eZ\Publish\SPI\Repositor...Field\ThumbnailStrategy` as the method `hasStrategy()` does only exist in the following implementations of said interface: `eZ\Publish\Core\Reposito...ld\ContentFieldStrategy`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
46			&& !$fieldType->isEmptyValue($field->value)
47			) {
48			return $this->contentFieldStrategy->getThumbnail($field);
49			}
50			}
51
52			return null;
53			}
54
55			private function getFieldByIdentifier(string $identifier, array $fields): ?Field
56			{
57			/** @var \eZ\Publish\API\Repository\Values\Content\Field $field */
58			foreach ($fields as $field) {
59			if ($field->fieldDefIdentifier === $identifier) {
60			return $field;
61			}
62			}
63
64			return null;
65			}
66			}

ezsystems / ezpublish-kernel

Push — ezp-30882-thumbnail ( d9f236...3bd997 )

FirstMatchingFieldStrategy::getThumbnail() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like