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