BoneUserPackage::addViews() - Code Metrics - Inspection of "add config file" - delboy1978uk/bone-user - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 7e4d75...0f3d1e )

by Derek Stephen

created 2025-11-02 14:09 UTC

BoneUserPackage::addViews() A

↳ Parent: BoneUserPackage

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	3
c	1
b	0
f	0
dl	0
loc	5
ccs	4
cts	4
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php

declare(strict_types=1);

namespace Bone\User;

use Barnacle\Container;
use Barnacle\RegistrationInterface;
use Bone\Application;
use Bone\Console\CommandRegistrationInterface;
use Bone\Contracts\Container\AdminPanelProviderInterface;
use Bone\Contracts\Container\DefaultSettingsProviderInterface;
use Bone\Contracts\Container\FixtureProviderInterface;
use Bone\Controller\Init;
use Bone\I18n\I18nRegistrationInterface;
use Bone\Mail\Service\MailService;
use Bone\Paseto\PasetoService;
use Bone\Router\Router;
use Bone\Router\RouterConfigInterface;
use Bone\User\Controller\BoneUserApiController;
use Bone\User\Controller\BoneUserController;
use Bone\User\Fixtures\LoadUsers;
use Bone\User\Http\Controller\Admin\PersonAdminController;
use Bone\User\Http\Controller\Admin\UserAdminController;
use Bone\User\Http\Middleware\SessionAuth;
use Bone\User\Http\Middleware\SessionAuthRedirect;
use Bone\User\View\Helper\LoginWidget;
use Bone\View\Util\AdminLink;
use Bone\View\ViewRegistrationInterface;
use Del\Booty\AssetRegistrationInterface;
use Del\Console\CreateUserCommand;
use Del\Console\ResetPasswordCommand;
use Del\Service\UserService;
use Del\SessionManager;
use League\Route\RouteGroup;
use League\Route\Strategy\JsonStrategy;
use Laminas\Diactoros\ResponseFactory;
use Laminas\I18n\Translator\Translator;

class BoneUserPackage implements RegistrationInterface, RouterConfigInterface, I18nRegistrationInterface,
                                 AssetRegistrationInterface, ViewRegistrationInterface, CommandRegistrationInterface,
                                 FixtureProviderInterface, AdminPanelProviderInterface, DefaultSettingsProviderInterface
{
    public function addToContainer(Container $c)
    {
        $c[BoneUserController::class] = $c->factory(function (Container $c) {
            /** @var MailService $mailService */
            $mailService = $c->get(MailService::class);
            /** @var UserService $userService */
            $userService = $c->get(UserService::class);
            $pasetoService = $c->get(PasetoService::class);
            $defaultLayout = $c->get('default_layout');
            $adminLayout = $c->has('admin_layout') ? $c->get('admin_layout') : $defaultLayout;
            $options = [];

            if ($c->has('bone-user')) {
                $options = $c->get('bone-user');
            }

            $loginRedirectRoute = $options['loginRedirectRoute'] ?? '/user/home';
            $registrationEnabled = $options['enableRegistration'] ?? true;
            $profileRequired = $options['requireProfile'] ?? false;
            $rememberMeCookie = $options['rememberMeCookie'] ?? false;
            $controller = new BoneUserController($userService, $mailService, $loginRedirectRoute, $adminLayout, $pasetoService, $registrationEnabled, $profileRequired, $rememberMeCookie);

            return  Init::controller($controller, $c);
        });

        $c[BoneUserApiController::class] = $c->factory(function (Container $c) {
            /** @var UserService $userService */
            $userService = $c->get(UserService::class);
            $dir = $c->get('uploads_dir');
            $img = $c->get('image_dir');
            $tmp = $c->get('temp_dir');
            $mailService = $c->get(MailService::class);

            return Init::controller(new BoneUserApiController($userService, $dir, $img, $tmp, $mailService), $c);
        });


        $c[SessionAuth::class] = $c->factory(function (Container $c) {
            /** @var SessionManager $session */
            $session = $c->get(SessionManager::class);
            /** @var UserService $userService */
            $userService = $c->get(UserService::class);
            /** @var PasetoService $pasetoService */
            $pasetoService = $c->get(PasetoService::class);

            return new SessionAuth($session, $userService, $pasetoService);
        });

        $c[SessionAuthRedirect::class] = $c->factory(function (Container $c) {
            /** @var SessionManager $session */
            $session = $c->get(SessionManager::class);
            /** @var UserService $userService */
            $userService = $c->get(UserService::class);
            /** @var PasetoService $pasetoService */
            $pasetoService = $c->get(PasetoService::class);

            return new SessionAuthRedirect($session, $userService, $pasetoService);
        });
    }

    public function getAssetFolders(): array
    {
        return [
            'bone-user' => dirname(__DIR__) . '/data/assets',
        ];
    }

    public function getTranslationsDirectory(): string
    {
        return dirname(__DIR__) . '/data/translations';
    }

    public function addViews(): array
    {
        return [
            'boneuser' => __DIR__ . '/View/BoneUser/',
            'email.user' => __DIR__ . '/View/email/',
        ];
    }

    public function addViewExtensions(Container $c): array
    {
        $userService = $c->get(UserService::class);
        $translator = $c->get(Translator::class);
        $sessionManager = $c->get(SessionManager::class);
        $uploadFolder = $c->get('uploads_dir');
        $loginWidget = new LoginWidget($userService, $translator, $sessionManager, $uploadFolder);

        return [$loginWidget];
    }

    public function addRoutes(Container $c, Router $router): Router
    {
        $router->group('/user', function (RouteGroup $route) {
            $route->map('GET', '/', [BoneUserController::class, 'indexAction']);
            $route->map('GET', '/lost-password/{email}', [BoneUserController::class, 'forgotPasswordAction']);
            $route->map('GET', '/login', [BoneUserController::class, 'loginAction']);
            $route->map('POST', '/login', [BoneUserController::class, 'loginFormAction']);
            $route->map('GET', '/logout', [BoneUserController::class, 'logoutAction']);
            $route->map('GET', '/activate/{email}/{token}', [BoneUserController::class, 'activateAction']);
            $route->map('GET', '/reset-email/{email}/{new-email}/{token}', [BoneUserController::class, 'resetEmailAction']);
            $route->map('GET', '/reset-password/{email}/{token}', [BoneUserController::class, 'resetPasswordAction']);
            $route->map('POST', '/reset-password/{email}/{token}', [BoneUserController::class, 'resetPasswordAction']);
            $route->map('GET', '/resend-activation-mail/{email}', [BoneUserController::class, 'resendActivationEmailAction']);
        });

        $canRegister = true;
        $admin = false;

        if ($c->has('bone-user')) {
            $config = $c->get('bone-user');
            $canRegister = $config['enableRegistration'] ?? true;
            $admin = $config['admin'] ?? false;
        }

        if ($canRegister) {
            $router->map('GET', '/user/register', [BoneUserController::class, 'registerAction']);
            $router->map('POST', '/user/register', [BoneUserController::class, 'registerAction']);
        }

        $auth = $c->get(SessionAuth::class);
        $router->map('GET', '/user/change-password', [BoneUserController::class, 'changePasswordAction'])->middleware($auth);
        $router->map('POST', '/user/change-password', [BoneUserController::class, 'changePasswordAction'])->middleware($auth);
        $router->map('GET', '/user/change-email', [BoneUserController::class, 'changeEmailAction'])->middleware($auth);
        $router->map('POST', '/user/change-email', [BoneUserController::class, 'changeEmailAction'])->middleware($auth);
        $router->map('GET', '/user/edit-profile', [BoneUserController::class, 'editProfileAction'])->middleware($auth);
        $router->map('POST', '/user/edit-profile', [BoneUserController::class, 'editProfileAction'])->middleware($auth);
        $router->map('GET', '/user/home', [BoneUserController::class, 'homePageAction'])->middleware($auth);
        $factory = new ResponseFactory();
        $strategy = new JsonStrategy($factory);
        $strategy->setContainer($c);

        $router->group('/api/user', function (RouteGroup $route) use ($auth) {
            $route->map('POST', '/choose-avatar', [BoneUserApiController::class, 'chooseAvatarAction'])->middleware($auth);
            $route->map('POST', '/upload-avatar', [BoneUserApiController::class, 'uploadAvatarAction'])->middleware($auth);
            $route->map('GET', '/avatar', [BoneUserApiController::class, 'avatar'])->middleware($auth);
        })
        ->setStrategy($strategy);

        if ($admin === true) {
            $router->adminResource('people', PersonAdminController::class, $c);
            $router->adminResource('users', UserAdminController::class, $c);
        }

        return $router;
    }

    public function registerConsoleCommands(Container $container): array
    {
        return [
            new ResetPasswordCommand($container->get(UserService::class)),
            new CreateUserCommand($container->get(UserService::class)),
        ];
    }

    public function getFixtures(): array
    {
        return [
            LoadUsers::class
        ];
    }

    public function getAdminLinks(): array
    {
        $c = Application::ahoy()->getContainer();
        $admin = false;

        if ($c->has('bone-user')) {
            $config = $c->get('bone-user');
            $admin = $config['admin'] ?? false;
        }

        if ($admin === true) {
            return [
                new AdminLink('People', '/admin/people', 'nav-icon fa fa-address-book'),
                new AdminLink('Users', '/admin/users', 'nav-icon fa fa-users'),
            ];
        }

        return [];
    }

    public function getRequiredPackages(): array
    {
        return [
            'Bone\Mail\MailPackage',
            'Bone\BoneDoctrine\BoneDoctrinePackage',
            'Bone\Paseto\PasetoPackage',
            'Del\Person\PersonPackage',
            'Del\User\UserPackage',
            'BoneUserPackage',
        ];
    }

    public function getSettingsFileName(): string
    {
        return __DIR__ . '/../data/config/bone-user.php';
    }


}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Bone\User;
6
7		use Barnacle\Container;
8		use Barnacle\RegistrationInterface;
9		use Bone\Application;
10		use Bone\Console\CommandRegistrationInterface;
11		use Bone\Contracts\Container\AdminPanelProviderInterface;
12		use Bone\Contracts\Container\DefaultSettingsProviderInterface;
13		use Bone\Contracts\Container\FixtureProviderInterface;
14		use Bone\Controller\Init;
15		use Bone\I18n\I18nRegistrationInterface;
16		use Bone\Mail\Service\MailService;
17		use Bone\Paseto\PasetoService;
18		use Bone\Router\Router;
19		use Bone\Router\RouterConfigInterface;
20		use Bone\User\Controller\BoneUserApiController;
21		use Bone\User\Controller\BoneUserController;
22		use Bone\User\Fixtures\LoadUsers;
23		use Bone\User\Http\Controller\Admin\PersonAdminController;
24		use Bone\User\Http\Controller\Admin\UserAdminController;
25		use Bone\User\Http\Middleware\SessionAuth;
26		use Bone\User\Http\Middleware\SessionAuthRedirect;
27		use Bone\User\View\Helper\LoginWidget;
28		use Bone\View\Util\AdminLink;
29		use Bone\View\ViewRegistrationInterface;
30		use Del\Booty\AssetRegistrationInterface;
31		use Del\Console\CreateUserCommand;
32		use Del\Console\ResetPasswordCommand;
33		use Del\Service\UserService;
34		use Del\SessionManager;
35		use League\Route\RouteGroup;
36		use League\Route\Strategy\JsonStrategy;
37		use Laminas\Diactoros\ResponseFactory;
38		use Laminas\I18n\Translator\Translator;
39
40		class BoneUserPackage implements RegistrationInterface, RouterConfigInterface, I18nRegistrationInterface,
41		AssetRegistrationInterface, ViewRegistrationInterface, CommandRegistrationInterface,
42		FixtureProviderInterface, AdminPanelProviderInterface, DefaultSettingsProviderInterface
43		{
44	3	public function addToContainer(Container $c)
45		{
46	3	$c[BoneUserController::class] = $c->factory(function (Container $c) {
47		/** @var MailService $mailService */
48	1	$mailService = $c->get(MailService::class);
49		/** @var UserService $userService */
50	1	$userService = $c->get(UserService::class);
51	1	$pasetoService = $c->get(PasetoService::class);
52	1	$defaultLayout = $c->get('default_layout');
53	1	$adminLayout = $c->has('admin_layout') ? $c->get('admin_layout') : $defaultLayout;
54	1	$options = [];
55
56	1	if ($c->has('bone-user')) {
57	1	$options = $c->get('bone-user');
58		}
59
60	1	$loginRedirectRoute = $options['loginRedirectRoute'] ?? '/user/home';
61	1	$registrationEnabled = $options['enableRegistration'] ?? true;
62	1	$profileRequired = $options['requireProfile'] ?? false;
63	1	$rememberMeCookie = $options['rememberMeCookie'] ?? false;
64	1	$controller = new BoneUserController($userService, $mailService, $loginRedirectRoute, $adminLayout, $pasetoService, $registrationEnabled, $profileRequired, $rememberMeCookie);
65
66	1	return Init::controller($controller, $c);
67	3	});
68
69	3	$c[BoneUserApiController::class] = $c->factory(function (Container $c) {
70		/** @var UserService $userService */
71	1	$userService = $c->get(UserService::class);
72	1	$dir = $c->get('uploads_dir');
73	1	$img = $c->get('image_dir');
74	1	$tmp = $c->get('temp_dir');
75	1	$mailService = $c->get(MailService::class);
76
77	1	return Init::controller(new BoneUserApiController($userService, $dir, $img, $tmp, $mailService), $c);
78	3	});
79
80
81	3	$c[SessionAuth::class] = $c->factory(function (Container $c) {
82		/** @var SessionManager $session */
83	2	$session = $c->get(SessionManager::class);
84		/** @var UserService $userService */
85	2	$userService = $c->get(UserService::class);
86		/** @var PasetoService $pasetoService */
87	2	$pasetoService = $c->get(PasetoService::class);
88
89	2	return new SessionAuth($session, $userService, $pasetoService);
90	3	});
91
92	3	$c[SessionAuthRedirect::class] = $c->factory(function (Container $c) {
93		/** @var SessionManager $session */
94	1	$session = $c->get(SessionManager::class);
95		/** @var UserService $userService */
96	1	$userService = $c->get(UserService::class);
97		/** @var PasetoService $pasetoService */
98	1	$pasetoService = $c->get(PasetoService::class);
99
100	1	return new SessionAuthRedirect($session, $userService, $pasetoService);
101	3	});
102		}
103
104	1	public function getAssetFolders(): array
105		{
106	1	return [
107	1	'bone-user' => dirname(__DIR__) . '/data/assets',
108	1	];
109		}
110
111	1	public function getTranslationsDirectory(): string
112		{
113	1	return dirname(__DIR__) . '/data/translations';
114		}
115
116	1	public function addViews(): array
117		{
118	1	return [
119	1	'boneuser' => __DIR__ . '/View/BoneUser/',
120	1	'email.user' => __DIR__ . '/View/email/',
121	1	];
122		}
123
124	1	public function addViewExtensions(Container $c): array
125		{
126	1	$userService = $c->get(UserService::class);
127	1	$translator = $c->get(Translator::class);
128	1	$sessionManager = $c->get(SessionManager::class);
129	1	$uploadFolder = $c->get('uploads_dir');
130	1	$loginWidget = new LoginWidget($userService, $translator, $sessionManager, $uploadFolder);
131
132	1	return [$loginWidget];
133		}
134
135	1	public function addRoutes(Container $c, Router $router): Router
136		{
137	1	$router->group('/user', function (RouteGroup $route) {
138	1	$route->map('GET', '/', [BoneUserController::class, 'indexAction']);
139	1	$route->map('GET', '/lost-password/{email}', [BoneUserController::class, 'forgotPasswordAction']);
140	1	$route->map('GET', '/login', [BoneUserController::class, 'loginAction']);
141	1	$route->map('POST', '/login', [BoneUserController::class, 'loginFormAction']);
142	1	$route->map('GET', '/logout', [BoneUserController::class, 'logoutAction']);
143	1	$route->map('GET', '/activate/{email}/{token}', [BoneUserController::class, 'activateAction']);
144	1	$route->map('GET', '/reset-email/{email}/{new-email}/{token}', [BoneUserController::class, 'resetEmailAction']);
145	1	$route->map('GET', '/reset-password/{email}/{token}', [BoneUserController::class, 'resetPasswordAction']);
146	1	$route->map('POST', '/reset-password/{email}/{token}', [BoneUserController::class, 'resetPasswordAction']);
147	1	$route->map('GET', '/resend-activation-mail/{email}', [BoneUserController::class, 'resendActivationEmailAction']);
148	1	});
149
150	1	$canRegister = true;
151	1	$admin = false;
152
153	1	if ($c->has('bone-user')) {
154	1	$config = $c->get('bone-user');
155	1	$canRegister = $config['enableRegistration'] ?? true;
156	1	$admin = $config['admin'] ?? false;
157		}
158
159	1	if ($canRegister) {
160	1	$router->map('GET', '/user/register', [BoneUserController::class, 'registerAction']);
161	1	$router->map('POST', '/user/register', [BoneUserController::class, 'registerAction']);
162		}
163
164	1	$auth = $c->get(SessionAuth::class);
165	1	$router->map('GET', '/user/change-password', [BoneUserController::class, 'changePasswordAction'])->middleware($auth);
166	1	$router->map('POST', '/user/change-password', [BoneUserController::class, 'changePasswordAction'])->middleware($auth);
167	1	$router->map('GET', '/user/change-email', [BoneUserController::class, 'changeEmailAction'])->middleware($auth);
168	1	$router->map('POST', '/user/change-email', [BoneUserController::class, 'changeEmailAction'])->middleware($auth);
169	1	$router->map('GET', '/user/edit-profile', [BoneUserController::class, 'editProfileAction'])->middleware($auth);
170	1	$router->map('POST', '/user/edit-profile', [BoneUserController::class, 'editProfileAction'])->middleware($auth);
171	1	$router->map('GET', '/user/home', [BoneUserController::class, 'homePageAction'])->middleware($auth);
172	1	$factory = new ResponseFactory();
173	1	$strategy = new JsonStrategy($factory);
174	1	$strategy->setContainer($c);
175
176	1	$router->group('/api/user', function (RouteGroup $route) use ($auth) {
177	1	$route->map('POST', '/choose-avatar', [BoneUserApiController::class, 'chooseAvatarAction'])->middleware($auth);
178	1	$route->map('POST', '/upload-avatar', [BoneUserApiController::class, 'uploadAvatarAction'])->middleware($auth);
179	1	$route->map('GET', '/avatar', [BoneUserApiController::class, 'avatar'])->middleware($auth);
180	1	})
181	1	->setStrategy($strategy);
182
183	1	if ($admin === true) {
184	1	$router->adminResource('people', PersonAdminController::class, $c);
185	1	$router->adminResource('users', UserAdminController::class, $c);
186		}
187
188	1	return $router;
189		}
190
191	1	public function registerConsoleCommands(Container $container): array
192		{
193	1	return [
194	1	new ResetPasswordCommand($container->get(UserService::class)),
195	1	new CreateUserCommand($container->get(UserService::class)),
196	1	];
197		}
198
199		public function getFixtures(): array
200		{
201		return [
202		LoadUsers::class
203		];
204		}
205
206		public function getAdminLinks(): array
207		{
208		$c = Application::ahoy()->getContainer();
209		$admin = false;
210
211		if ($c->has('bone-user')) {
212		$config = $c->get('bone-user');
213		$admin = $config['admin'] ?? false;
214		}
215
216		if ($admin === true) {
217		return [
218		new AdminLink('People', '/admin/people', 'nav-icon fa fa-address-book'),
219		new AdminLink('Users', '/admin/users', 'nav-icon fa fa-users'),
220		];
221		}
222
223		return [];
224		}
225
226		public function getRequiredPackages(): array
227		{
228		return [
229		'Bone\Mail\MailPackage',
230		'Bone\BoneDoctrine\BoneDoctrinePackage',
231		'Bone\Paseto\PasetoPackage',
232		'Del\Person\PersonPackage',
233		'Del\User\UserPackage',
234		'BoneUserPackage',
235		];
236		}
237
238		public function getSettingsFileName(): string
239		{
240		return __DIR__ . '/../data/config/bone-user.php';
241		}
242
243
244		}
245

delboy1978uk / bone-user

Push — master ( 7e4d75...0f3d1e )

BoneUserPackage::addViews() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like