Issues (3641)

Spryker/Glue/Kernel/Backend/AbstractFactory.php (1 issue)

1
<?php
2
3
/**
4
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
5
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
6
 */
7
8
namespace Spryker\Glue\Kernel\Backend;
9
10
use Spryker\Glue\Kernel\AbstractBundleDependencyProvider;
11
use Spryker\Glue\Kernel\AbstractFactory as GlueAbstractFactory;
12
use Spryker\Glue\Kernel\Backend\AbstractBundleDependencyProvider as BackendAbstractBundleDependencyProvider;
13
use Spryker\Glue\Kernel\Backend\ClassResolver\DependencyProviderResolver;
14
use Spryker\Glue\Kernel\Backend\Container as BackendContainer;
15
use Spryker\Glue\Kernel\Backend\Exception\InvalidContainerException;
16
use Spryker\Glue\Kernel\Backend\Exception\InvalidDependencyProviderException;
17
use Spryker\Glue\Kernel\Container;
0 ignored issues
show
This use statement conflicts with another class in this namespace, Spryker\Glue\Kernel\Backend\Container. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
18
19
/**
20
 * @method \Spryker\Glue\Kernel\Backend\Container getContainer()
21
 * @method setContainer(\Spryker\Glue\Kernel\Backend\Container $container)
22
 */
23
abstract class AbstractFactory extends GlueAbstractFactory
24
{
25
    /**
26
     * @return \Spryker\Glue\Kernel\Backend\Container
27
     */
28
    protected function createContainer(): Container
29
    {
30
        $containerGlobals = $this->createContainerGlobals();
31
32
        return new BackendContainer($containerGlobals->getContainerGlobals());
33
    }
34
35
    /**
36
     * @param \Spryker\Glue\Kernel\Backend\AbstractBundleDependencyProvider $dependencyProvider
37
     * @param \Spryker\Glue\Kernel\Backend\Container $container
38
     *
39
     * @throws \Spryker\Glue\Kernel\Backend\Exception\InvalidDependencyProviderException
40
     * @throws \Spryker\Glue\Kernel\Backend\Exception\InvalidContainerException
41
     *
42
     * @return \Spryker\Glue\Kernel\Backend\Container
43
     */
44
    protected function provideDependencies(AbstractBundleDependencyProvider $dependencyProvider, Container $container)
45
    {
46
        if (!$dependencyProvider instanceof BackendAbstractBundleDependencyProvider) {
47
            throw new InvalidDependencyProviderException(
48
                sprintf('Glue backend modules must use the %s', BackendAbstractBundleDependencyProvider::class),
49
            );
50
        }
51
52
        if (!$container instanceof BackendContainer) {
53
            throw new InvalidContainerException(sprintf('Glue backend modules must use the %s', BackendContainer::class));
54
        }
55
56
        return $dependencyProvider->provideDependencies($container);
57
    }
58
59
    /**
60
     * @return \Spryker\Glue\Kernel\Backend\AbstractBundleDependencyProvider
61
     */
62
    protected function resolveDependencyProvider(): AbstractBundleDependencyProvider
63
    {
64
        return $this->createDependencyProviderResolver()->resolve($this);
65
    }
66
67
    /**
68
     * @return \Spryker\Glue\Kernel\Backend\ClassResolver\DependencyProviderResolver
69
     */
70
    protected function createDependencyProviderResolver(): DependencyProviderResolver
71
    {
72
        return new DependencyProviderResolver();
73
    }
74
}
75