Issues in AviaryController.php - Fixed Issues - Inspection of "Merge pull request #2662 from acrobat/replace-doct..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d6774...64f3ed )

by Jeroen

created 2020-06-25 11:41 UTC

MediaBundle/Controller/AviaryController.php (2 issues)

Labels

Bug 2

Severity

Minor 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Kunstmaan\MediaBundle\Controller;

use Kunstmaan\MediaBundle\Entity\Folder;
use Kunstmaan\MediaBundle\Entity\Media;
use Kunstmaan\MediaBundle\Helper\MediaManager;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;

/**
 * Controller class which Aviary can use to upload the edited image and add it to the database
 */
class AviaryController extends Controller
{
    /**
     * @param Request $request
     * @param int     $folderId The id of the Folder
     * @param int     $mediaId  The id of the image
     *
     * @Route("/aviary/{folderId}/{mediaId}", requirements={"folderId" = "\d+", "mediaId" = "\d+"}, name="KunstmaanMediaBundle_aviary")
     *
     * @return RedirectResponse
     */
    public function indexAction(Request $request, $folderId, $mediaId)
    {
        $em = $this->getDoctrine()->getManager();

        /* @var Folder $folder */
        $folder = $em->getRepository('KunstmaanMediaBundle:Folder')->getFolder($folderId);
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 Media $media */
        $media = $em->getRepository('KunstmaanMediaBundle:Media')->getMedia($mediaId);
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 MediaManager $mediaManager */
        $mediaManager = $this->get('kunstmaan_media.media_manager');

        $media = clone $media;
        $handler = $mediaManager->getHandler($media);
        $fileHelper = $handler->getFormHelper($media);
        $fileHelper->getMediaFromUrl($request->get('url'));
        $media = $fileHelper->getMedia();

        $media->setUuid(null);
        $handler->prepareMedia($media);

        $em->persist($media);
        $em->flush();

        $media->setCreatedAt($media->getUpdatedAt());
        $em->persist($media);
        $em->flush();

        return new RedirectResponse(
            $this->generateUrl(
                'KunstmaanMediaBundle_folder_show',
                array('folderId' => $folder->getId())
            )
        );
    }
}


Push — master ( 6d6774...64f3ed )

MediaBundle/Controller/AviaryController.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

1			<?php
2
3			namespace Kunstmaan\MediaBundle\Controller;
4
5			use Kunstmaan\MediaBundle\Entity\Folder;
6			use Kunstmaan\MediaBundle\Entity\Media;
7			use Kunstmaan\MediaBundle\Helper\MediaManager;
8			use Symfony\Component\Routing\Annotation\Route;
9			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
10			use Symfony\Component\HttpFoundation\RedirectResponse;
11			use Symfony\Component\HttpFoundation\Request;
12
13			/**
14			* Controller class which Aviary can use to upload the edited image and add it to the database
15			*/
16			class AviaryController extends Controller
17			{
18			/**
19			* @param Request $request
20			* @param int $folderId The id of the Folder
21			* @param int $mediaId The id of the image
22			*
23			* @Route("/aviary/{folderId}/{mediaId}", requirements={"folderId" = "\d+", "mediaId" = "\d+"}, name="KunstmaanMediaBundle_aviary")
24			*
25			* @return RedirectResponse
26			*/
27			public function indexAction(Request $request, $folderId, $mediaId)
28			{
29			$em = $this->getDoctrine()->getManager();
30
31			/* @var Folder $folder */
32			$folder = $em->getRepository('KunstmaanMediaBundle:Folder')->getFolder($folderId);
			0 ignored issues – show Bug introduced 2020-01-09 14:19 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Doctrine\Persistence\ObjectRepository` as the method `getFolder()` does only exist in the following implementations of said interface: `Kunstmaan\MediaBundle\Repository\FolderRepository`. 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...
33			/* @var Media $media */
34			$media = $em->getRepository('KunstmaanMediaBundle:Media')->getMedia($mediaId);
			0 ignored issues – show Bug introduced 2020-01-09 14:19 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Doctrine\Persistence\ObjectRepository` as the method `getMedia()` does only exist in the following implementations of said interface: `Kunstmaan\MediaBundle\Repository\MediaRepository`. 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...
35			/* @var MediaManager $mediaManager */
36			$mediaManager = $this->get('kunstmaan_media.media_manager');
37
38			$media = clone $media;
39			$handler = $mediaManager->getHandler($media);
40			$fileHelper = $handler->getFormHelper($media);
41			$fileHelper->getMediaFromUrl($request->get('url'));
42			$media = $fileHelper->getMedia();
43
44			$media->setUuid(null);
45			$handler->prepareMedia($media);
46
47			$em->persist($media);
48			$em->flush();
49
50			$media->setCreatedAt($media->getUpdatedAt());
51			$em->persist($media);
52			$em->flush();
53
54			return new RedirectResponse(
55			$this->generateUrl(
56			'KunstmaanMediaBundle_folder_show',
57			array('folderId' => $folder->getId())
58			)
59			);
60			}
61			}
62

Kunstmaan / KunstmaanBundlesCMS

Push — master ( 6d6774...64f3ed )

MediaBundle/Controller/AviaryController.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like