FirstMatchingFieldStrategy::getThumbnail() - Code Metrics - Inspection of "Added ContentInfo::{getContentType,getSection,getM..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp_30981_content_info_proxy ( 628b2c...9b541b )

unknown

created 2019-12-23 09:19 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

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
declare(strict_types=1);

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

use eZ\Publish\API\Repository\FieldTypeService;
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;

final 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			/**
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			declare(strict_types=1);
8
9			namespace eZ\Publish\Core\Repository\Strategy\ContentThumbnail;
10
11			use eZ\Publish\API\Repository\FieldTypeService;
12			use eZ\Publish\API\Repository\Values\Content\Field;
13			use eZ\Publish\API\Repository\Values\Content\Thumbnail;
14			use eZ\Publish\API\Repository\Values\ContentType\ContentType;
15			use eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\Field\ThumbnailStrategy as ContentFieldThumbnailStrategy;
16			use eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\ThumbnailStrategy;
17
18			final class FirstMatchingFieldStrategy implements ThumbnailStrategy
19			{
20			/** @var \eZ\Publish\API\Repository\FieldTypeService */
21			private $fieldTypeService;
22
23			/** @var \eZ\Publish\SPI\Repository\Strategy\ContentThumbnail\Field\ThumbnailStrategy */
24			private $contentFieldStrategy;
25
26			public function __construct(
27			ContentFieldThumbnailStrategy $contentFieldStrategy,
28			FieldTypeService $fieldTypeService
29			) {
30			$this->contentFieldStrategy = $contentFieldStrategy;
31			$this->fieldTypeService = $fieldTypeService;
32			}
33
34			public function getThumbnail(ContentType $contentType, array $fields): ?Thumbnail
35			{
36			$fieldDefinitions = $contentType->getFieldDefinitions();
37
38			foreach ($fieldDefinitions as $fieldDefinition) {
39			$field = $this->getFieldByIdentifier($fieldDefinition->identifier, $fields);
40
41			if ($field === null) {
42			continue;
43			}
44
45			$fieldType = $this->fieldTypeService->getFieldType($fieldDefinition->fieldTypeIdentifier);
46
47			if (
48			$fieldDefinition->isThumbnail
49			&& $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...
50			&& !$fieldType->isEmptyValue($field->value)
51			) {
52			return $this->contentFieldStrategy->getThumbnail($field);
53			}
54			}
55
56			return null;
57			}
58
59			private function getFieldByIdentifier(string $identifier, array $fields): ?Field
60			{
61			/** @var \eZ\Publish\API\Repository\Values\Content\Field $field */
62			foreach ($fields as $field) {
63			if ($field->fieldDefIdentifier === $identifier) {
64			return $field;
65			}
66			}
67
68			return null;
69			}
70			}
71

ezsystems / ezpublish-kernel

Push — ezp_30981_content_info_proxy ( 628b2c...9b541b )

FirstMatchingFieldStrategy::getThumbnail() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like