vendor/contao-bootstrap/core/src/Environment.php line 163

Open in your IDE?
  1. <?php
  3. /**
  4.  * Contao Bootstrap
  5.  *
  6.  * @package    contao-bootstrap
  7.  * @subpackage Core
  8.  * @author     David Molineus <david.molineus@netzmacht.de>
  9.  * @copyright  2017 netzmacht David Molineus. All rights reserved.
  10.  * @license    LGPL-3.0 https://github.com/contao-bootstrap/core
  11.  * @filesource
  12.  */
  14. namespace ContaoBootstrap\Core;
  16. use Contao\LayoutModel;
  17. use ContaoBootstrap\Core\Config\ArrayConfig;
  18. use ContaoBootstrap\Core\Environment\Context;
  19. use ContaoBootstrap\Core\Exception\LeavingContextFailed;
  20. use ContaoBootstrap\Core\Message\Event\ContextEntered;
  21. use ContaoBootstrap\Core\Message\Command\BuildContextConfig;
  22. use Symfony\Component\EventDispatcher\EventDispatcherInterface as MessageBus;
  24. /**
  25.  * Class Environment contain all things being provided in the bootstrap environment.
  26.  *
  27.  * @package ContaoBootstrap\Core
  28.  */
  29. final class Environment
  30. {
  31.     /**
  32.      * Bootstrap enabled state.
  33.      *
  34.      * @var bool
  35.      */
  36.     protected $enabled = false;
  38.     /**
  39.      * Bootstrap config.
  40.      *
  41.      * @var Config
  42.      */
  43.     protected $config;
  45.     /**
  46.      * Layout model of current page.
  47.      *
  48.      * @var \LayoutModel
  49.      */
  50.     private $layout;
  52.     /**
  53.      * Current context.
  54.      *
  55.      * @var Context
  56.      */
  57.     private $context;
  59.     /**
  60.      * List of contexts.
  61.      *
  62.      * @var Context[]
  63.      */
  64.     private $contextStack;
  66.     /**
  67.      * MessageBus.
  68.      *
  69.      * @var MessageBus
  70.      */
  71.     private $messageBus;
  73.     /**
  74.      * Construct.
  75.      *
  76.      * @param MessageBus $messageBus Message bus.
  77.      */
  78.     public function __construct(MessageBus $messageBus)
  79.     {
  80.         $this->messageBus = $messageBus;
  81.         $this->config     = new ArrayConfig();
  82.     }
  84.     /**
  85.      * Get bootstrap config.
  86.      *
  87.      * @return Config
  88.      */
  89.     public function getConfig(): Config
  90.     {
  91.         return $this->config;
  92.     }
  94.     /**
  95.      * Enter a context.
  96.      *
  97.      * @param Context $context Context.
  98.      *
  99.      * @return void
  100.      */
  101.     public function enterContext(Context $context): void
  102.     {
  103.         // Already in the context.
  104.         if ($this->context && $this->context->match($context)) {
  105.             return;
  106.         }
  108.         $this->switchContext($context, true);
  109.     }
  111.     /**
  112.      * Leave current context and enter the context which was used before.
  113.      *
  114.      * @param Context|null $currentContext Optional expected current context. Won't do anything if context not match.
  115.      *
  116.      * @return void
  117.      * @throws LeavingContextFailed When context stack is empty.
  118.      */
  119.     public function leaveContext(?Context $currentContext = null): void
  120.     {
  121.         if (!$this->context) {
  122.             throw LeavingContextFailed::noContext();
  123.         }
  125.         // Not in expected context. Just quit.
  126.         if ($currentContext && !$currentContext->match($this->context)) {
  127.             return;
  128.         }
  130.         // Get last know context which was used before current context.
  131.         $context = array_pop($this->contextStack);
  133.         if ($context === null) {
  134.             throw LeavingContextFailed::inContext($this->context);
  135.         }
  137.         $this->switchContext($context);
  138.     }
  140.     /**
  141.      * Switch to another context.
  142.      *
  143.      * @param Context $context            New context.
  144.      * @param bool    $keepCurrentInStack If true current context is added to the stack.
  145.      *
  146.      * @return void
  147.      */
  148.     private function switchContext(Context $context, bool $keepCurrentInStack = false): void
  149.     {
  150.         $command = new BuildContextConfig($this, $context, $this->config);
  151.         $this->messageBus->dispatch($command::NAME, $command);
  153.         if ($command->getConfig()) {
  154.             $this->config = $command->getConfig();
  155.         }
  157.         if ($keepCurrentInStack && $this->context) {
  158.             $this->contextStack[] = $this->context;
  159.         }
  161.         $this->context = $context;
  163.         $event = new ContextEntered($this, $context);
  164.         $this->messageBus->dispatch($event::NAME, $event);
  165.     }
  167.     /**
  168.      * Consider if bootstrap theme is enabled.
  169.      *
  170.      * @return bool
  171.      */
  172.     public function isEnabled(): bool
  173.     {
  174.         return $this->enabled;
  175.     }
  177.     /**
  178.      * Enable current bootstrap theme.
  179.      *
  180.      * @param bool $enabled Enabled state.
  181.      *
  182.      * @return $this
  183.      */
  184.     public function setEnabled(bool $enabled): self
  185.     {
  186.         $this->enabled = $enabled;
  188.         return $this;
  189.     }
  191.     /**
  192.      * Set the layout.
  193.      *
  194.      * @param LayoutModel $layout Page layout.
  195.      *
  196.      * @return $this
  197.      */
  198.     public function setLayout(LayoutModel $layout): self
  199.     {
  200.         $this->layout = $layout;
  202.         return $this;
  203.     }
  205.     /**
  206.      * Get the page layout.
  207.      *
  208.      * @return LayoutModel|null
  209.      */
  210.     public function getLayout()
  211.     {
  212.         return $this->layout;
  213.     }
  214. }