spryker / spryker-core

Bundles/Application/src/Spryker/Zed/Application/Communication/ZedBootstrap.php

<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace Spryker\Zed\Application\Communication;

use Spryker\Service\Container\ContainerInterface;
use Spryker\Shared\Application\Application as SprykerApplication;
use Spryker\Shared\Application\ApplicationConstants;
use Spryker\Shared\Config\Config;
use Spryker\Shared\Kernel\Communication\Application;
use Spryker\Shared\Kernel\Store;
use Spryker\Zed\Application\ApplicationConfig;
use Spryker\Zed\Application\ApplicationDependencyProvider;
use Spryker\Zed\Kernel\AbstractBundleDependencyProvider;
use Spryker\Zed\Kernel\BundleDependencyProviderResolverAwareTrait;
use Spryker\Zed\Kernel\Communication\Plugin\Pimple;
use Spryker\Zed\Kernel\Container;
use Spryker\Zed\Kernel\ControllerResolver\ZedFragmentControllerResolver;
use Spryker\Zed\Kernel\Dependency\Injector\DependencyInjector;
use Symfony\Component\HttpFoundation\Request;

class ZedBootstrap
{
    use BundleDependencyProviderResolverAwareTrait;

    /**
     * @var \Spryker\Shared\Kernel\Communication\Application
     */
    protected $application;

    /**
     * @var \Spryker\Shared\Application\Application|null
     */
    protected $sprykerApplication;

    /**
     * @var \Spryker\Zed\Application\ApplicationConfig
     */
    protected $config;

    public function __construct()
    {
        $this->application = $this->getBaseApplication();

        if ($this->application instanceof ContainerInterface) {
            $this->sprykerApplication = new SprykerApplication($this->application);
        }

        $this->config = new ApplicationConfig();
    }

    /**
     * @return \Spryker\Shared\Application\Application|\Spryker\Shared\Kernel\Communication\Application
     */
    public function boot()
    {
        $this->application['debug'] = function () {
            return Config::get(ApplicationConstants::ENABLE_APPLICATION_DEBUG, false);
        };

        $this->application['locale'] = Store::getInstance()->getCurrentLocale();

        $this->enableHttpMethodParameterOverride();
        $this->setUp();

        $this->application->boot();

        if ($this->sprykerApplication === null) {
            return $this->application;
        }

        $this->sprykerApplication->boot();

        return $this->sprykerApplication;
    }

    /**
     * @return void
     */
    protected function setUp()
    {
        $this->optimizeApp();
        // For BC
        if ($this->isInternalRequest()) {
            $this->registerServiceProviderForInternalRequestWithAuthentication();
            $this->setupApplication();

            return;
        }

        $this->registerServiceProvider();

        $this->setupApplication();
    }

    /**
     * @return void
     */
    protected function setupApplicationPlugins(): void
    {
        foreach ($this->getApplicationPlugins() as $applicationPlugin) {
            $this->sprykerApplication->registerApplicationPlugin($applicationPlugin);
        }
    }

    /**
     * @return void
     */
    protected function setupApplication(): void
    {
        if ($this->sprykerApplication !== null) {
            $this->setupApplicationPlugins();
        }
    }

    /**
     * @return array<\Spryker\Shared\ApplicationExtension\Dependency\Plugin\ApplicationPluginInterface>
     */
    protected function getApplicationPlugins(): array
    {
        return $this->getProvidedDependency(ApplicationDependencyProvider::PLUGINS_APPLICATION);
    }

    /**
     * @return void
     */
    protected function registerServiceProvider()
    {
        foreach ($this->getServiceProvider() as $provider) {
            $this->application->register($provider);
        }
    }

    /**
     * @return void
     */
    protected function registerServiceProviderForInternalRequestWithAuthentication()
    {
        $serviceProviders = $this->getMergedServiceProviders();

        foreach ($serviceProviders as $provider) {
            $this->application->register($provider);
        }
    }

    /**
     * @return array<\Silex\ServiceProviderInterface>
     */
    protected function getMergedServiceProviders(): array
    {
        $serviceProviders = $this->getServiceProvider();
        $internalCallServiceProvidersWithAuth = $this->getInternalCallServiceProviderWithAuthentication();
        $internalCallServiceProviders = $this->getInternalCallServiceProvider();
        $mergedServiceProviders = array_merge($serviceProviders, $internalCallServiceProvidersWithAuth, $internalCallServiceProviders);

        return array_unique($mergedServiceProviders, SORT_REGULAR);
    }

    /**
     * @return array<\Silex\ServiceProviderInterface>
     */
    protected function getServiceProvider()
    {
        return $this->getProvidedDependency(ApplicationDependencyProvider::SERVICE_PROVIDER);
    }

    /**
     * @return array<\Silex\ServiceProviderInterface>
     */
    protected function getInternalCallServiceProvider()
    {
        return $this->getProvidedDependency(ApplicationDependencyProvider::INTERNAL_CALL_SERVICE_PROVIDER);
    }

    /**
     * @return array<\Silex\ServiceProviderInterface>
     */
    protected function getInternalCallServiceProviderWithAuthentication()
    {
        return $this->getProvidedDependency(ApplicationDependencyProvider::INTERNAL_CALL_SERVICE_PROVIDER_WITH_AUTHENTICATION);
    }

    /**
     * @return void
     */
    protected function registerApiServiceProvider()
    {
        foreach ($this->getApiServiceProvider() as $provider) {
            $this->application->register($provider);
        }
    }

    /**
     * @return array<\Silex\ServiceProviderInterface>
     */
    protected function getApiServiceProvider()
    {
        return $this->getProvidedDependency(ApplicationDependencyProvider::SERVICE_PROVIDER_API);
    }

    /**
     * @return \Spryker\Shared\Kernel\Communication\Application
     */
    protected function getBaseApplication()
    {
        $application = new Application();

        $this->unsetSilexExceptionHandler($application);

        Pimple::setApplication($application);

        return $application;
    }

    /**
     * @param \Spryker\Shared\Kernel\Communication\Application $application
     *
     * @return void
     */
    private function unsetSilexExceptionHandler(Application $application)
    {
        unset($application['exception_handler']);
    }

    /**
     * @return void
     */
    protected function optimizeApp()
    {
        $application = $this->application;
        $application['resolver'] = function () use ($application) {
            return new ZedFragmentControllerResolver($application);

The class Spryker\Zed\Kernel\ControllerResolver\ZedFragmentControllerResolver has been deprecated: Use `spryker/router` instead. This will be removed without direct replacement as it will not be needed with the new Router anymore.

        };
    }

    /**
     * Allow overriding http method. Needed to use the "_method" parameter in forms.
     * This should not be changeable by projects
     *
     * @return void
     */
    private function enableHttpMethodParameterOverride()
    {
        Request::enableHttpMethodParameterOverride();
    }

    /**
     * @param \Spryker\Zed\Kernel\AbstractBundleDependencyProvider $dependencyProvider
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return \Spryker\Zed\Kernel\Container
     */
    protected function provideExternalDependencies(AbstractBundleDependencyProvider $dependencyProvider, Container $container)
    {
        $dependencyProvider->provideBusinessLayerDependencies($container);
        $dependencyProvider->provideCommunicationLayerDependencies($container);
        $dependencyProvider->providePersistenceLayerDependencies($container);

        return $container;
    }

    /**
     * @param \Spryker\Zed\Kernel\Dependency\Injector\DependencyInjector $dependencyInjector
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return \Spryker\Shared\Kernel\ContainerInterface|\Spryker\Zed\Kernel\Container
     */
    protected function injectExternalDependencies(DependencyInjector $dependencyInjector, Container $container)
    {
        $container = $dependencyInjector->injectCommunicationLayerDependencies($container);

        return $container;
    }

    /**
     * @return bool
     */
    protected function isInternalRequest()
    {
        return array_key_exists('HTTP_X_INTERNAL_REQUEST', $_SERVER);
    }
}