MediaBuilder::postBuild() - Code Metrics - Inspection of "[MediaBundle] Refactor deprecated mimetypeguesser..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2668)

by Jeroen

created 2020-09-11 20:06 UTC

MediaBuilder::postBuild() A

↳ Parent: MediaBuilder

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	28
ccs	0
cts	21
cp	0
rs	9.472
c	0
b	0
f	0
cc	3
nc	4
nop	1
crap	12

<?php

namespace Kunstmaan\FixturesBundle\Builder;

use Doctrine\ORM\EntityManager;
use Doctrine\ORM\EntityManagerInterface;
use Kunstmaan\FixturesBundle\Loader\Fixture;
use Kunstmaan\MediaBundle\Entity\Folder;
use Kunstmaan\MediaBundle\Entity\Media;
use Kunstmaan\MediaBundle\Helper\File\FileHandler;
use Kunstmaan\MediaBundle\Helper\MimeTypeGuesserFactoryInterface;
use Symfony\Component\HttpFoundation\File\File;
use Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesserInterface;
use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface;
use Symfony\Component\Mime\MimeTypes;

class MediaBuilder implements BuilderInterface
{
    /** @var EntityManagerInterface */
    private $em;
    /** @var FileHandler */
    private $fileHandler;
    /** @var MimeTypes|ExtensionGuesserInterface */
    private $mimeTypeGuesser;

    private $folder;

    public function __construct(EntityManager $em, FileHandler $fileHandler, /* MimeTypes */$mimeTypeGuesser)
function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}
    {
        $this->em = $em;
        $this->fileHandler = $fileHandler;
        $this->mimeTypeGuesser = $mimeTypeGuesser;
        if ($mimeTypeGuesser instanceof MimeTypeGuesserFactoryInterface) {
            @trigger_error(sprintf('Passing an instance of "%s" for the "$mimeTypeGuesser" parameter is deprecated since KunstmaanMediaBundle 5.7 and will be replaced by the "@mime_types" service in KunstmaanMediaBundle 6.0. Inject the correct service instead.', MimeTypeGuesserFactoryInterface::class), E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

            $this->mimeTypeGuesser = $mimeTypeGuesser->get();

        }
    }

    public function canBuild(Fixture $fixture)
    {
        if ($fixture->getEntity() instanceof Media) {
            return true;
        }

        return false;
    }

    public function preBuild(Fixture $fixture)
    {
        $properties = $fixture->getProperties();
        if (!isset($properties['folder'])) {
            throw new \Exception('There is no folder specified for media fixture '.$fixture->getName());
        }

        $this->folder = $this->em->getRepository(Folder::class)->findOneBy(['rel' => $properties['folder']]);

        if (!$this->folder instanceof Folder) {
            $this->folder = $this->em->getRepository(Folder::class)->findOneBy(['internalName' => $properties['folder']]);
        }

        if (!$this->folder instanceof Folder) {
            throw new \Exception('Could not find the specified folder for media fixture '.$fixture->getName());
        }
    }

    public function postBuild(Fixture $fixture)
    {
        /** @var Media $media */
        $media = $fixture->getEntity();

        $filePath = $media->getOriginalFilename();
        $data = new File($filePath, true);
        $contentType = $this->guessMimeType($data->getPathname());

        if (method_exists($data, 'getClientOriginalName')) {
            $media->setOriginalFilename($data->getClientOriginalName());
        } else {
            $media->setOriginalFilename($data->getFilename());
        }

        if ($media->getName() === null) {
            $media->setName($media->getOriginalFilename());
        }

        $media->setContent($data);

        $media->setContentType($contentType);
        $media->setFolder($this->folder);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->fileHandler->prepareMedia($media);
        $this->fileHandler->updateMedia($media);
        $this->fileHandler->saveMedia($media);
    }

    private function guessMimeType($pathName): ?string

    {
        if ($this->mimeTypeGuesser instanceof MimeTypeGuesserInterface) {
            return $this->mimeTypeGuesser->guess($pathName);
        }

        return $this->mimeTypeGuesser->guessMimeType($pathName);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    public function postFlushBuild(Fixture $fixture)
    {
        return;
    }
}


1			<?php
2
3			namespace Kunstmaan\FixturesBundle\Builder;
4
5			use Doctrine\ORM\EntityManager;
6			use Doctrine\ORM\EntityManagerInterface;
7			use Kunstmaan\FixturesBundle\Loader\Fixture;
8			use Kunstmaan\MediaBundle\Entity\Folder;
9			use Kunstmaan\MediaBundle\Entity\Media;
10			use Kunstmaan\MediaBundle\Helper\File\FileHandler;
11			use Kunstmaan\MediaBundle\Helper\MimeTypeGuesserFactoryInterface;
12			use Symfony\Component\HttpFoundation\File\File;
13			use Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesserInterface;
14			use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface;
15			use Symfony\Component\Mime\MimeTypes;
16
17			class MediaBuilder implements BuilderInterface
18			{
19			/** @var EntityManagerInterface */
20			private $em;
21			/** @var FileHandler */
22			private $fileHandler;
23			/** @var MimeTypes\|ExtensionGuesserInterface */
24			private $mimeTypeGuesser;
25
26			private $folder;
27
28			public function __construct(EntityManager $em, FileHandler $fileHandler, /* MimeTypes */$mimeTypeGuesser)
			0 ignored issues – show Bug introduced 2020-09-03 21:13 UTC by Report Bug Copy Issue Report You have injected the EntityManager via parameter `$em`. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via `getManager()` each time you need it. The `EntityManager` might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following: function someFunction(ManagerRegistry $registry) { $em = $registry->getManager(); $em->getConnection()->beginTransaction(); try { // Do something. $em->getConnection()->commit(); } catch (\Exception $ex) { $em->getConnection()->rollback(); $em->close(); throw $ex; } } If that code throws an exception and the `EntityManager` is closed. Any other code which depends on the same instance of the `EntityManager` during this request will fail. On the other hand, if you instead inject the `ManagerRegistry`, the `getManager()` method guarantees that you will always get a usable manager instance. Loading history...
29			{
30			$this->em = $em;
31			$this->fileHandler = $fileHandler;
32			$this->mimeTypeGuesser = $mimeTypeGuesser;
33			if ($mimeTypeGuesser instanceof MimeTypeGuesserFactoryInterface) {
34			@trigger_error(sprintf('Passing an instance of "%s" for the "$mimeTypeGuesser" parameter is deprecated since KunstmaanMediaBundle 5.7 and will be replaced by the "@mime_types" service in KunstmaanMediaBundle 6.0. Inject the correct service instead.', MimeTypeGuesserFactoryInterface::class), E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2020-09-03 21:13 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
35
36			$this->mimeTypeGuesser = $mimeTypeGuesser->get();
			0 ignored issues – show Documentation Bug introduced 2020-09-03 21:13 UTC by Report Bug Copy Issue Report It seems like `$mimeTypeGuesser->get()` of type `object<Symfony\Component...meTypeGuesserInterface>` is incompatible with the declared type `object<Symfony\Component...ensionGuesserInterface>` of property `$mimeTypeGuesser`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
37			}
38			}
39
40			public function canBuild(Fixture $fixture)
41			{
42			if ($fixture->getEntity() instanceof Media) {
43			return true;
44			}
45
46			return false;
47			}
48
49			public function preBuild(Fixture $fixture)
50			{
51			$properties = $fixture->getProperties();
52			if (!isset($properties['folder'])) {
53			throw new \Exception('There is no folder specified for media fixture '.$fixture->getName());
54			}
55
56			$this->folder = $this->em->getRepository(Folder::class)->findOneBy(['rel' => $properties['folder']]);
57
58			if (!$this->folder instanceof Folder) {
59			$this->folder = $this->em->getRepository(Folder::class)->findOneBy(['internalName' => $properties['folder']]);
60			}
61
62			if (!$this->folder instanceof Folder) {
63			throw new \Exception('Could not find the specified folder for media fixture '.$fixture->getName());
64			}
65			}
66
67			public function postBuild(Fixture $fixture)
68			{
69			/** @var Media $media */
70			$media = $fixture->getEntity();
71
72			$filePath = $media->getOriginalFilename();
73			$data = new File($filePath, true);
74			$contentType = $this->guessMimeType($data->getPathname());
75
76			if (method_exists($data, 'getClientOriginalName')) {
77			$media->setOriginalFilename($data->getClientOriginalName());
78			} else {
79			$media->setOriginalFilename($data->getFilename());
80			}
81
82			if ($media->getName() === null) {
83			$media->setName($media->getOriginalFilename());
84			}
85
86			$media->setContent($data);
87
88			$media->setContentType($contentType);
89			$media->setFolder($this->folder);
			0 ignored issues – show Documentation introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report `$this->folder` is of type `object\|null`, but the function expects a `object<Kunstmaan\MediaBundle\Entity\Folder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
90
91			$this->fileHandler->prepareMedia($media);
92			$this->fileHandler->updateMedia($media);
93			$this->fileHandler->saveMedia($media);
94			}
95
96			private function guessMimeType($pathName): ?string
			0 ignored issues – show Documentation introduced 2020-09-03 21:13 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
97			{
98			if ($this->mimeTypeGuesser instanceof MimeTypeGuesserInterface) {
99			return $this->mimeTypeGuesser->guess($pathName);
100			}
101
102			return $this->mimeTypeGuesser->guessMimeType($pathName);
			0 ignored issues – show Bug introduced 2020-09-03 21:13 UTC by Report Bug Copy Issue Report The method `guessMimeType` does only exist in `Symfony\Component\Mime\MimeTypes`, but not in `Symfony\Component\HttpFo...tensionGuesserInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
103			}
104
105			public function postFlushBuild(Fixture $fixture)
106			{
107			return;
108			}
109			}
110

Kunstmaan / KunstmaanBundlesCMS

Pull Request — master (#2668)

MediaBuilder::postBuild() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like