Issues in TranslationFixtures.php - All Issues - Inspection of "[AllBundles] Switch from styleci to flintci" - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 5.6 (#2830)

by Jeroen

created 2020-11-06 12:16 UTC

DataFixtures/ORM/TranslationFixtures.php (2 issues)

Labels

Severity

Joakim Löfgren 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\TranslatorBundle\DataFixtures\ORM;

use Doctrine\Common\DataFixtures\AbstractFixture;
use Doctrine\Common\DataFixtures\OrderedFixtureInterface;
use Doctrine\Common\Persistence\ObjectManager;
use Kunstmaan\TranslatorBundle\Entity\Translation as Entity;
use Kunstmaan\TranslatorBundle\Model\Translation as Model;

/**
 * Fixture for creation the basic translations
 */
class TranslationFixtures extends AbstractFixture implements OrderedFixtureInterface
{
    /**
     * @var Kunstmaan\TranslatorBundle\Repository\TranslationRepository
     */
    protected $repo;

    /**
     * Load data fixtures with the passed EntityManager
     */
    public function load(ObjectManager $manager)
    {
        $this->repo = $manager->getRepository('Kunstmaan\TranslatorBundle\Entity\Translation');


        $helloWorld = new Model();
        $helloWorld->setKeyword('heading.hello_world');
        $helloWorld->setDomain('messages');

        $translations = [
            'en' => 'Hello World!',
            'fr' => 'Bonjour tout le monde',
            'nl' => 'Hallo wereld!',
        ];

        $needForFlush = false;
        foreach ($translations as $language => $text) {
            if ($this->hasFixtureInstalled('messages', 'heading.hello_world', $language)) {
                continue;
            }

            $helloWorld->addText($language, $text);
            $needForFlush = true;
        }

        $this->repo->createTranslations($helloWorld);
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.
    }
}

        if ($needForFlush === true) {
            $manager->flush();
        }
    }

    /**
     * Checks if the specified translation is installed.
     *
     * @param string $domain
     * @param string $keyword
     * @param string $locale
     *
     * @return bool
     */
    public function hasFixtureInstalled($domain, $keyword, $locale)
    {
        $criteria = ['domain' => $domain, 'keyword' => $keyword, 'locale' => $locale];

        return $this->repo->findOneBy($criteria) instanceof Entity;
    }

    /**
     * Get the order of this fixture
     *
     * @return int
     */
    public function getOrder()
    {
        return 1;
    }
}


1			<?php
2
3			namespace Kunstmaan\TranslatorBundle\DataFixtures\ORM;
4
5			use Doctrine\Common\DataFixtures\AbstractFixture;
6			use Doctrine\Common\DataFixtures\OrderedFixtureInterface;
7			use Doctrine\Common\Persistence\ObjectManager;
8			use Kunstmaan\TranslatorBundle\Entity\Translation as Entity;
9			use Kunstmaan\TranslatorBundle\Model\Translation as Model;
10
11			/**
12			* Fixture for creation the basic translations
13			*/
14			class TranslationFixtures extends AbstractFixture implements OrderedFixtureInterface
15			{
16			/**
17			* @var Kunstmaan\TranslatorBundle\Repository\TranslationRepository
18			*/
19			protected $repo;
20
21			/**
22			* Load data fixtures with the passed EntityManager
23			*/
24			public function load(ObjectManager $manager)
25			{
26			$this->repo = $manager->getRepository('Kunstmaan\TranslatorBundle\Entity\Translation');
			0 ignored issues – show Documentation Bug introduced 2020-01-09 14:19 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$manager->getRepository(...\\Entity\\Translation')` of type `object<Doctrine\Persistence\ObjectRepository>` is incompatible with the declared type `object<Kunstmaan\Transla...\TranslationRepository>` of property `$repo`. 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...
27
28			$helloWorld = new Model();
29			$helloWorld->setKeyword('heading.hello_world');
30			$helloWorld->setDomain('messages');
31
32			$translations = [
33			'en' => 'Hello World!',
34			'fr' => 'Bonjour tout le monde',
35			'nl' => 'Hallo wereld!',
36			];
37
38			$needForFlush = false;
39			foreach ($translations as $language => $text) {
40			if ($this->hasFixtureInstalled('messages', 'heading.hello_world', $language)) {
41			continue;
42			}
43
44			$helloWorld->addText($language, $text);
45			$needForFlush = true;
46			}
47
48			$this->repo->createTranslations($helloWorld);
			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 `createTranslations()` does only exist in the following implementations of said interface: `Kunstmaan\TranslatorBund...y\TranslationRepository`. 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...
49
50			if ($needForFlush === true) {
51			$manager->flush();
52			}
53			}
54
55			/**
56			* Checks if the specified translation is installed.
57			*
58			* @param string $domain
59			* @param string $keyword
60			* @param string $locale
61			*
62			* @return bool
63			*/
64			public function hasFixtureInstalled($domain, $keyword, $locale)
65			{
66			$criteria = ['domain' => $domain, 'keyword' => $keyword, 'locale' => $locale];
67
68			return $this->repo->findOneBy($criteria) instanceof Entity;
69			}
70
71			/**
72			* Get the order of this fixture
73			*
74			* @return int
75			*/
76			public function getOrder()
77			{
78			return 1;
79			}
80			}
81

Kunstmaan / KunstmaanBundlesCMS

Pull Request — 5.6 (#2830)

DataFixtures/ORM/TranslationFixtures.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like