3 declare(strict_types
=1);
5 namespace Shaarli\Container
;
7 use malkusch\lock\mutex\FlockMutex
;
8 use Psr\Log\LoggerInterface
;
9 use Shaarli\Bookmark\BookmarkFileService
;
10 use Shaarli\Bookmark\BookmarkServiceInterface
;
11 use Shaarli\Config\ConfigManager
;
12 use Shaarli\Feed\FeedBuilder
;
13 use Shaarli\Formatter\FormatterFactory
;
14 use Shaarli\Front\Controller\Visitor\ErrorController
;
15 use Shaarli\Front\Controller\Visitor\ErrorNotFoundController
;
17 use Shaarli\Http\HttpAccess
;
18 use Shaarli\Http\MetadataRetriever
;
19 use Shaarli\Netscape\NetscapeBookmarkUtils
;
20 use Shaarli\Plugin\PluginManager
;
21 use Shaarli\Render\PageBuilder
;
22 use Shaarli\Render\PageCacheManager
;
23 use Shaarli\Security\CookieManager
;
24 use Shaarli\Security\LoginManager
;
25 use Shaarli\Security\SessionManager
;
26 use Shaarli\Thumbnailer
;
27 use Shaarli\Updater\Updater
;
28 use Shaarli\Updater\UpdaterUtils
;
31 * Class ContainerBuilder
33 * Helper used to build a Slim container instance with Shaarli's object dependencies.
34 * Note that most injected objects MUST be added as closures, to let the container instantiate
35 * only the objects it requires during the execution.
39 class ContainerBuilder
41 /** @var ConfigManager */
44 /** @var SessionManager */
47 /** @var CookieManager */
48 protected $cookieManager;
50 /** @var LoginManager */
53 /** @var PluginManager */
54 protected $pluginManager;
56 /** @var LoggerInterface */
59 /** @var string|null */
60 protected $basePath = null;
62 public function __construct(
64 SessionManager
$session,
65 CookieManager
$cookieManager,
67 PluginManager
$pluginManager,
68 LoggerInterface
$logger
71 $this->session
= $session;
72 $this->login
= $login;
73 $this->cookieManager
= $cookieManager;
74 $this->pluginManager
= $pluginManager;
75 $this->logger
= $logger;
78 public function build(): ShaarliContainer
80 $container = new ShaarliContainer();
82 $container['conf'] = $this->conf
;
83 $container['sessionManager'] = $this->session
;
84 $container['cookieManager'] = $this->cookieManager
;
85 $container['loginManager'] = $this->login
;
86 $container['pluginManager'] = $this->pluginManager
;
87 $container['logger'] = $this->logger
;
88 $container['basePath'] = $this->basePath
;
91 $container['history'] = function (ShaarliContainer
$container): History
{
92 return new History($container->conf
->get('resource.history'));
95 $container['bookmarkService'] = function (ShaarliContainer
$container): BookmarkServiceInterface
{
96 return new BookmarkFileService(
99 new FlockMutex(fopen(SHAARLI_MUTEX_FILE
, 'r'), 2),
100 $container->loginManager
->isLoggedIn()
104 $container['metadataRetriever'] = function (ShaarliContainer
$container): MetadataRetriever
{
105 return new MetadataRetriever($container->conf
, $container->httpAccess
);
108 $container['pageBuilder'] = function (ShaarliContainer
$container): PageBuilder
{
109 return new PageBuilder(
111 $container->sessionManager
->getSession(),
113 $container->bookmarkService
,
114 $container->sessionManager
->generateToken(),
115 $container->loginManager
->isLoggedIn()
119 $container['formatterFactory'] = function (ShaarliContainer
$container): FormatterFactory
{
120 return new FormatterFactory(
122 $container->loginManager
->isLoggedIn()
126 $container['pageCacheManager'] = function (ShaarliContainer
$container): PageCacheManager
{
127 return new PageCacheManager(
128 $container->conf
->get('resource.page_cache'),
129 $container->loginManager
->isLoggedIn()
133 $container['feedBuilder'] = function (ShaarliContainer
$container): FeedBuilder
{
134 return new FeedBuilder(
135 $container->bookmarkService
,
136 $container->formatterFactory
->getFormatter(),
137 $container->environment
,
138 $container->loginManager
->isLoggedIn()
142 $container['thumbnailer'] = function (ShaarliContainer
$container): Thumbnailer
{
143 return new Thumbnailer($container->conf
);
146 $container['httpAccess'] = function (): HttpAccess
{
147 return new HttpAccess();
150 $container['netscapeBookmarkUtils'] = function (ShaarliContainer
$container): NetscapeBookmarkUtils
{
151 return new NetscapeBookmarkUtils($container->bookmarkService
, $container->conf
, $container->history
);
154 $container['updater'] = function (ShaarliContainer
$container): Updater
{
156 UpdaterUtils
::readUpdatesFile($container->conf
->get('resource.updates')),
157 $container->bookmarkService
,
159 $container->loginManager
->isLoggedIn()
163 $container['notFoundHandler'] = function (ShaarliContainer
$container): ErrorNotFoundController
{
164 return new ErrorNotFoundController($container);
166 $container['errorHandler'] = function (ShaarliContainer
$container): ErrorController
{
167 return new ErrorController($container);
169 $container['phpErrorHandler'] = function (ShaarliContainer
$container): ErrorController
{
170 return new ErrorController($container);