Export::__invoke() - Code Metrics - Inspection of "Refactoring" - netgen/NetgenInformationCollectionBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e5413e...3eb92c )

by Mario

created 2020-08-12 21:16 UTC

Export::__invoke() A

↳ Parent: Export

Complexity

Conditions	5
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	34
rs	9.0648
c	0
b	0
f	0
cc	5
nc	3
nop	2

<?php

namespace Netgen\Bundle\InformationCollectionBundle\Controller\Admin\Export;

use eZ\Publish\Core\MVC\Symfony\Security\Authorization\Attribute;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Netgen\InformationCollection\API\Value\Export\ExportCriteria;
use Netgen\InformationCollection\API\Service\Exporter;
use Netgen\InformationCollection\Core\Export\ExportResponseFormatterRegistry;
use Symfony\Component\HttpFoundation\Request;
use Netgen\InformationCollection\Form\Type\ExportType;
use eZ\Publish\API\Repository\ContentService;

final class Export extends AbstractController
{
    /**
     * @var \eZ\Publish\API\Repository\ContentService
     */
    protected $contentService;

    /**
     * @var \Netgen\InformationCollection\API\Service\Exporter
     */
    protected $exporter;

    /**
     * @var \Netgen\InformationCollection\Core\Export\ExportResponseFormatterRegistry
     */
    protected $formatterRegistry;

    public function __construct(
        ContentService $contentService,
        Exporter $exporter,
        ExportResponseFormatterRegistry $formatterRegistry
    )
    {
        $this->contentService = $contentService;
        $this->exporter = $exporter;
        $this->formatterRegistry = $formatterRegistry;
    }

    public function __invoke($contentId, Request $request)
    {
        $attribute = new Attribute('infocollector', 'export');
        $this->denyAccessUnlessGranted($attribute);

        $content = $this->contentService->loadContent($contentId);

        $form = $this->createForm(ExportType::class, null, [
            'contentId' => $content->id,
        ]);
        $form->handleRequest($request);

        if ($form->get('cancel')->isClicked()) {
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.
    }
}
            return $this->redirect($this->generateUrl('netgen_information_collection.route.admin.collection_list', ['contentId' => $contentId]));
        }

        if ($form->get('export')->isClicked() && $form->isSubmitted() && $form->isValid()) {
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.
    }
}

            /** @var ExportCriteria $data */
            $data = $form->getData();
            $export = $this->exporter->export($data);

            $formatter = $this->formatterRegistry->getExportResponseFormatter($data->getExportIdentifier());

            return $formatter->format($export, $content);
        }

        return $this->render("@NetgenInformationCollection/admin/export_menu.html.twig",
            [
                'content' => $content,
                'form' => $form->createView(),
            ]
        );
    }
}


GitHub Access Token became invalid

Push — master ( e5413e...3eb92c )

Export::__invoke() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace Netgen\Bundle\InformationCollectionBundle\Controller\Admin\Export;
4
5			use eZ\Publish\Core\MVC\Symfony\Security\Authorization\Attribute;
6			use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
7			use Netgen\InformationCollection\API\Value\Export\ExportCriteria;
8			use Netgen\InformationCollection\API\Service\Exporter;
9			use Netgen\InformationCollection\Core\Export\ExportResponseFormatterRegistry;
10			use Symfony\Component\HttpFoundation\Request;
11			use Netgen\InformationCollection\Form\Type\ExportType;
12			use eZ\Publish\API\Repository\ContentService;
13
14			final class Export extends AbstractController
15			{
16			/**
17			* @var \eZ\Publish\API\Repository\ContentService
18			*/
19			protected $contentService;
20
21			/**
22			* @var \Netgen\InformationCollection\API\Service\Exporter
23			*/
24			protected $exporter;
25
26			/**
27			* @var \Netgen\InformationCollection\Core\Export\ExportResponseFormatterRegistry
28			*/
29			protected $formatterRegistry;
30
31			public function __construct(
32			ContentService $contentService,
33			Exporter $exporter,
34			ExportResponseFormatterRegistry $formatterRegistry
35			)
36			{
37			$this->contentService = $contentService;
38			$this->exporter = $exporter;
39			$this->formatterRegistry = $formatterRegistry;
40			}
41
42			public function __invoke($contentId, Request $request)
43			{
44			$attribute = new Attribute('infocollector', 'export');
45			$this->denyAccessUnlessGranted($attribute);
46
47			$content = $this->contentService->loadContent($contentId);
48
49			$form = $this->createForm(ExportType::class, null, [
50			'contentId' => $content->id,
51			]);
52			$form->handleRequest($request);
53
54			if ($form->get('cancel')->isClicked()) {
			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 concrete implementation and not the interface `Symfony\Component\Form\FormInterface` as the method `isClicked()` does only exist in the following implementations of said interface: `Symfony\Component\Form\SubmitButton`. 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...
55			return $this->redirect($this->generateUrl('netgen_information_collection.route.admin.collection_list', ['contentId' => $contentId]));
56			}
57
58			if ($form->get('export')->isClicked() && $form->isSubmitted() && $form->isValid()) {
			0 ignored issues – show Bug introduced 2020-08-10 22:41 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Form\FormInterface` as the method `isClicked()` does only exist in the following implementations of said interface: `Symfony\Component\Form\SubmitButton`. 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...
59
60			/** @var ExportCriteria $data */
61			$data = $form->getData();
62			$export = $this->exporter->export($data);
63
64			$formatter = $this->formatterRegistry->getExportResponseFormatter($data->getExportIdentifier());
65
66			return $formatter->format($export, $content);
67			}
68
69			return $this->render("@NetgenInformationCollection/admin/export_menu.html.twig",
70			[
71			'content' => $content,
72			'form' => $form->createView(),
73			]
74			);
75			}
76			}
77

netgen / NetgenInformationCollectionBundle

GitHub Access Token became invalid

Push — master ( e5413e...3eb92c )

Export::__invoke() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like