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