GetShortObjectDescriptionAction::__invoke() - Code Metrics - Inspection of "Manual Merge" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5183)

by Marko

created 2018-08-12 16:04 UTC

GetShortObjectDescriptionAction::__invoke() B

↳ Parent: GetShortObjectDescriptionAction

Complexity

Conditions	8
Paths	17

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	48
rs	7.8901
c	0
b	0
f	0
cc	8
nc	17
nop	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Action;

use Sonata\AdminBundle\Admin\Pool;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Twig\Environment;

final class GetShortObjectDescriptionAction
{
    /**
     * @var Pool
     */
    private $pool;

    /**
     * @var Environment
     */
    private $twig;

    public function __construct(Environment $twig, Pool $pool)
    {
        $this->pool = $pool;
        $this->twig = $twig;
    }

    /**
     * @throws NotFoundHttpException
     *
     * @return Response
     */
    public function __invoke(Request $request)
    {
        $code = $request->get('code');
        $objectId = $request->get('objectId');
        $uniqid = $request->get('uniqid');
        $linkParameters = $request->get('linkParameters', []);

        $admin = $this->pool->getInstance($code);

        if (!$admin) {
            throw new NotFoundHttpException(sprintf(
                'Could not find admin for code "%s"',
                $code
            ));
        }

        $admin->setRequest($request);

        if ($uniqid) {
            $admin->setUniqid($uniqid);
        }

        if (!$objectId) {
            $objectId = null;
        }

        $object = $admin->getObject($objectId);

        if (!$object && 'html' == $request->get('_format')) {
            return new Response();
        }

        if ('json' == $request->get('_format')) {
            return new JsonResponse(['result' => [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
                'id' => $admin->id($object),
                'label' => $admin->toString($object),
            ]]);
        } elseif ('html' == $request->get('_format')) {
            return new Response($this->twig->render($admin->getTemplate('short_object_description'), [

                'admin' => $admin,
                'description' => $admin->toString($object),
                'object' => $object,
                'link_parameters' => $linkParameters,
            ]));
        }

        throw new \RuntimeException('Invalid format');
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\AdminBundle\Action;
15
16			use Sonata\AdminBundle\Admin\Pool;
17			use Symfony\Component\HttpFoundation\Request;
18			use Symfony\Component\HttpFoundation\Response;
19			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
20			use Twig\Environment;
21
22			final class GetShortObjectDescriptionAction
23			{
24			/**
25			* @var Pool
26			*/
27			private $pool;
28
29			/**
30			* @var Environment
31			*/
32			private $twig;
33
34			public function __construct(Environment $twig, Pool $pool)
35			{
36			$this->pool = $pool;
37			$this->twig = $twig;
38			}
39
40			/**
41			* @throws NotFoundHttpException
42			*
43			* @return Response
44			*/
45			public function __invoke(Request $request)
46			{
47			$code = $request->get('code');
48			$objectId = $request->get('objectId');
49			$uniqid = $request->get('uniqid');
50			$linkParameters = $request->get('linkParameters', []);
51
52			$admin = $this->pool->getInstance($code);
53
54			if (!$admin) {
55			throw new NotFoundHttpException(sprintf(
56			'Could not find admin for code "%s"',
57			$code
58			));
59			}
60
61			$admin->setRequest($request);
62
63			if ($uniqid) {
64			$admin->setUniqid($uniqid);
65			}
66
67			if (!$objectId) {
68			$objectId = null;
69			}
70
71			$object = $admin->getObject($objectId);
72
73			if (!$object && 'html' == $request->get('_format')) {
74			return new Response();
75			}
76
77			if ('json' == $request->get('_format')) {
78			return new JsonResponse(['result' => [
			0 ignored issues – show Bug Best Practice introduced 2018-07-16 20:08 UTC by Report Bug Copy Issue Report The return type of `return new \Sonata\Admin...->toString($object))));` (`Sonata\AdminBundle\Action\JsonResponse`) is incompatible with the return type documented by `Sonata\AdminBundle\Actio...riptionAction::__invoke` of type `Symfony\Component\HttpFoundation\Response`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
79			'id' => $admin->id($object),
80			'label' => $admin->toString($object),
81			]]);
82			} elseif ('html' == $request->get('_format')) {
83			return new Response($this->twig->render($admin->getTemplate('short_object_description'), [
			0 ignored issues – show Deprecated Code introduced 2018-04-16 08:35 UTC by Report Bug Copy Issue Report The method `Sonata\AdminBundle\Admin...nterface::getTemplate()` has been deprecated with message: since 3.35. To be removed in 4.0. Use TemplateRegistry services instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
84			'admin' => $admin,
85			'description' => $admin->toString($object),
86			'object' => $object,
87			'link_parameters' => $linkParameters,
88			]));
89			}
90
91			throw new \RuntimeException('Invalid format');
92			}
93			}
94

sonata-project / SonataAdminBundle

Pull Request — master (#5183)

GetShortObjectDescriptionAction::__invoke() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like