Completed
Pull Request — master (#485)
by Maximilian
04:14
created

LoadDashboardTreeData::load()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 48
Code Lines 37

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 48
rs 9.125
cc 1
eloc 37
nc 1
nop 1
1
<?php
2
3
/*
4
 * This file is part of the Symfony CMF package.
5
 *
6
 * (c) 2011-2017 Symfony CMF
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Sonata\DoctrinePHPCRAdminBundle\Tests\Resources\DataFixtures\Phpcr;
13
14
use Doctrine\Common\DataFixtures\FixtureInterface;
15
use Doctrine\Common\Persistence\ObjectManager;
16
use PHPCR\Util\NodeHelper;
17
use Sonata\DoctrinePHPCRAdminBundle\Tests\Resources\Document\Content;
18
19
class LoadDashboardTreeData implements FixtureInterface
20
{
21
    public function load(ObjectManager $manager)
22
    {
23
        NodeHelper::createPath($manager->getPhpcrSession(), '/test');
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Doctrine\Common\Persistence\ObjectManager as the method getPhpcrSession() does only exist in the following implementations of said interface: Doctrine\ODM\PHPCR\Decor...ocumentManagerDecorator, Doctrine\ODM\PHPCR\DocumentManager, Doctrine\Tests\ODM\PHPCR...ManagerGetClassMetadata.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
24
25
        NodeHelper::createPath($manager->getPhpcrSession(), '/test/content');
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Doctrine\Common\Persistence\ObjectManager as the method getPhpcrSession() does only exist in the following implementations of said interface: Doctrine\ODM\PHPCR\Decor...ocumentManagerDecorator, Doctrine\ODM\PHPCR\DocumentManager, Doctrine\Tests\ODM\PHPCR...ManagerGetClassMetadata.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
26
        NodeHelper::createPath($manager->getPhpcrSession(), '/test/routes');
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Doctrine\Common\Persistence\ObjectManager as the method getPhpcrSession() does only exist in the following implementations of said interface: Doctrine\ODM\PHPCR\Decor...ocumentManagerDecorator, Doctrine\ODM\PHPCR\DocumentManager, Doctrine\Tests\ODM\PHPCR...ManagerGetClassMetadata.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
27
28
        $contentRoot = $manager->find(null, '/test/content');
29
        $routeRoot = $manager->find(null, '/test/routes');
30
31
        $content = new Content();
32
        $content->setName('content-1');
33
        $content->setTitle('Content 1');
34
        $content->setParentDocument($contentRoot);
35
        $manager->persist($content);
36
37
        $content = new Content();
38
        $content->setName('content-2');
39
        $content->setTitle('Content 2');
40
        $content->setParentDocument($contentRoot);
41
        $manager->persist($content);
42
43
        $content = new Content();
44
        $content->setName('content-1');
45
        $content->setTitle('Content 1');
46
        $content->setParentDocument($contentRoot);
47
        $manager->persist($content);
48
49
        $routeAlike = new Content();
50
        $routeAlike->setName('route-1');
51
        $routeAlike->setTitle('Route 1');
52
        $routeAlike->setParentDocument($routeRoot);
53
        $manager->persist($routeAlike);
54
55
        $routeAlike = new Content();
56
        $routeAlike->setName('route-2');
57
        $routeAlike->setTitle('Route 2');
58
        $routeAlike->setParentDocument($routeRoot);
59
        $manager->persist($routeAlike);
60
61
        $routeAlike = new Content();
62
        $routeAlike->setName('route-3');
63
        $routeAlike->setTitle('Route 3');
64
        $routeAlike->setParentDocument($routeRoot);
65
        $manager->persist($routeAlike);
66
67
        $manager->flush();
68
    }
69
}
70