application/container/ContainerBuilder.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace Shaarli\Container;
   6
   7 use Shaarli\Bookmark\BookmarkFileService;
   8 use Shaarli\Bookmark\BookmarkServiceInterface;
   9 use Shaarli\Config\ConfigManager;
  10 use Shaarli\Formatter\FormatterFactory;
  11 use Shaarli\History;
  12 use Shaarli\Plugin\PluginManager;
  13 use Shaarli\Render\PageBuilder;
  14 use Shaarli\Render\PageCacheManager;
  15 use Shaarli\Security\LoginManager;
  16 use Shaarli\Security\SessionManager;
  17
  18 /**
  19  * Class ContainerBuilder
  20  *
  21  * Helper used to build a Slim container instance with Shaarli's object dependencies.
  22  * Note that most injected objects MUST be added as closures, to let the container instantiate
  23  * only the objects it requires during the execution.
  24  *
  25  * @package Container
  26  */
  27 class ContainerBuilder
  28 {
  29     /** @var ConfigManager */
  30     protected $conf;
  31
  32     /** @var SessionManager */
  33     protected $session;
  34
  35     /** @var LoginManager */
  36     protected $login;
  37
  38     /** @var string */
  39     protected $webPath;
  40
  41     public function __construct(
  42         ConfigManager $conf,
  43         SessionManager $session,
  44         LoginManager $login,
  45         string $webPath
  46     ) {
  47         $this->conf = $conf;
  48         $this->session = $session;
  49         $this->login = $login;
  50         $this->webPath = $webPath;
  51     }
  52
  53     public function build(): ShaarliContainer
  54     {
  55         $container = new ShaarliContainer();
  56
  57         $container['conf'] = $this->conf;
  58         $container['sessionManager'] = $this->session;
  59         $container['loginManager'] = $this->login;
  60         $container['webPath'] = $this->webPath;
  61
  62         $container['plugins'] = function (ShaarliContainer $container): PluginManager {
  63             return new PluginManager($container->conf);
  64         };
  65
  66         $container['history'] = function (ShaarliContainer $container): History {
  67             return new History($container->conf->get('resource.history'));
  68         };
  69
  70         $container['bookmarkService'] = function (ShaarliContainer $container): BookmarkServiceInterface {
  71             return new BookmarkFileService(
  72                 $container->conf,
  73                 $container->history,
  74                 $container->loginManager->isLoggedIn()
  75             );
  76         };
  77
  78         $container['pageBuilder'] = function (ShaarliContainer $container): PageBuilder {
  79             return new PageBuilder(
  80                 $container->conf,
  81                 $container->sessionManager->getSession(),
  82                 $container->bookmarkService,
  83                 $container->sessionManager->generateToken(),
  84                 $container->loginManager->isLoggedIn()
  85             );
  86         };
  87
  88         $container['pluginManager'] = function (ShaarliContainer $container): PluginManager {
  89             return new PluginManager($container->conf);
  90         };
  91
  92         $container['formatterFactory'] = function (ShaarliContainer $container): FormatterFactory {
  93             return new FormatterFactory($container->conf, $container->loginManager->isLoggedIn());
  94         };
  95
  96         $container['pageCacheManager'] = function (ShaarliContainer $container): PageCacheManager {
  97             return new PageCacheManager($container->conf->get('resource.page_cache'));
  98         };
  99
 100         return $container;
 101     }
 102 }