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\Feed\FeedBuilder;
  11 use Shaarli\Formatter\FormatterFactory;
  12 use Shaarli\History;
  13 use Shaarli\Http\HttpAccess;
  14 use Shaarli\Netscape\NetscapeBookmarkUtils;
  15 use Shaarli\Plugin\PluginManager;
  16 use Shaarli\Render\PageBuilder;
  17 use Shaarli\Render\PageCacheManager;
  18 use Shaarli\Security\CookieManager;
  19 use Shaarli\Security\LoginManager;
  20 use Shaarli\Security\SessionManager;
  21 use Shaarli\Thumbnailer;
  22 use Shaarli\Updater\Updater;
  23 use Shaarli\Updater\UpdaterUtils;
  24
  25 /**
  26  * Class ContainerBuilder
  27  *
  28  * Helper used to build a Slim container instance with Shaarli's object dependencies.
  29  * Note that most injected objects MUST be added as closures, to let the container instantiate
  30  * only the objects it requires during the execution.
  31  *
  32  * @package Container
  33  */
  34 class ContainerBuilder
  35 {
  36     /** @var ConfigManager */
  37     protected $conf;
  38
  39     /** @var SessionManager */
  40     protected $session;
  41
  42     /** @var CookieManager */
  43     protected $cookieManager;
  44
  45     /** @var LoginManager */
  46     protected $login;
  47
  48     /** @var string|null */
  49     protected $basePath = null;
  50
  51     public function __construct(
  52         ConfigManager $conf,
  53         SessionManager $session,
  54         CookieManager $cookieManager,
  55         LoginManager $login
  56     ) {
  57         $this->conf = $conf;
  58         $this->session = $session;
  59         $this->login = $login;
  60         $this->cookieManager = $cookieManager;
  61     }
  62
  63     public function build(): ShaarliContainer
  64     {
  65         $container = new ShaarliContainer();
  66
  67         $container['conf'] = $this->conf;
  68         $container['sessionManager'] = $this->session;
  69         $container['cookieManager'] = $this->cookieManager;
  70         $container['loginManager'] = $this->login;
  71         $container['basePath'] = $this->basePath;
  72
  73         $container['plugins'] = function (ShaarliContainer $container): PluginManager {
  74             return new PluginManager($container->conf);
  75         };
  76
  77         $container['history'] = function (ShaarliContainer $container): History {
  78             return new History($container->conf->get('resource.history'));
  79         };
  80
  81         $container['bookmarkService'] = function (ShaarliContainer $container): BookmarkServiceInterface {
  82             return new BookmarkFileService(
  83                 $container->conf,
  84                 $container->history,
  85                 $container->loginManager->isLoggedIn()
  86             );
  87         };
  88
  89         $container['pageBuilder'] = function (ShaarliContainer $container): PageBuilder {
  90             return new PageBuilder(
  91                 $container->conf,
  92                 $container->sessionManager->getSession(),
  93                 $container->bookmarkService,
  94                 $container->sessionManager->generateToken(),
  95                 $container->loginManager->isLoggedIn()
  96             );
  97         };
  98
  99         $container['pluginManager'] = function (ShaarliContainer $container): PluginManager {
 100             $pluginManager = new PluginManager($container->conf);
 101
 102             $pluginManager->load($container->conf->get('general.enabled_plugins'));
 103
 104             return $pluginManager;
 105         };
 106
 107         $container['formatterFactory'] = function (ShaarliContainer $container): FormatterFactory {
 108             return new FormatterFactory(
 109                 $container->conf,
 110                 $container->loginManager->isLoggedIn()
 111             );
 112         };
 113
 114         $container['pageCacheManager'] = function (ShaarliContainer $container): PageCacheManager {
 115             return new PageCacheManager(
 116                 $container->conf->get('resource.page_cache'),
 117                 $container->loginManager->isLoggedIn()
 118             );
 119         };
 120
 121         $container['feedBuilder'] = function (ShaarliContainer $container): FeedBuilder {
 122             return new FeedBuilder(
 123                 $container->bookmarkService,
 124                 $container->formatterFactory->getFormatter(),
 125                 $container->environment,
 126                 $container->loginManager->isLoggedIn()
 127             );
 128         };
 129
 130         $container['thumbnailer'] = function (ShaarliContainer $container): Thumbnailer {
 131             return new Thumbnailer($container->conf);
 132         };
 133
 134         $container['httpAccess'] = function (): HttpAccess {
 135             return new HttpAccess();
 136         };
 137
 138         $container['netscapeBookmarkUtils'] = function (ShaarliContainer $container): NetscapeBookmarkUtils {
 139             return new NetscapeBookmarkUtils($container->bookmarkService, $container->conf, $container->history);
 140         };
 141
 142         $container['updater'] = function (ShaarliContainer $container): Updater {
 143             return new Updater(
 144                 UpdaterUtils::read_updates_file($container->conf->get('resource.updates')),
 145                 $container->bookmarkService,
 146                 $container->conf,
 147                 $container->loginManager->isLoggedIn()
 148             );
 149         };
 150
 151         return $container;
 152     }
 153 }