Merge pull request 'fix #349 + refactoring' (#351) from feature/issue349-tables-apps into develop

Reviewed-on: https://gitnet.fr/deblan/side_menu/pulls/351

lib/Controller/AdminSettingController.php

@@ -22,37 +22,25 @@ use OCA\SideMenu\AppInfo\Application;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\DataDownloadResponse;
 use OCP\AppFramework\Http\RedirectResponse;
-use OCP\AppFramework\Http\Response;
 use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IURLGenerator;
 
 class AdminSettingController extends Controller
 {
-    /**
+    public function __construct(
-     * @var IConfig
+        $appName,
-     */
+        IRequest $request,
-    protected $config;
+        protected IConfig $config,
-
+        protected IURLGenerator $urlGenerator
-    /**
+    ) {
-     * @var IURLGenerator
-     */
-    protected $urlGenerator;
-
-    public function __construct($appName, IRequest $request, IConfig $config, IURLGenerator $urlGenerator)
-    {
         parent::__construct($appName, $request);
-
-        $this->config = $config;
-        $this->urlGenerator = $urlGenerator;
     }
 
     /**
      * @NoCSRFRequired
-     *
-     * @return RedirectResponse
      */
-    public function removeCache()
+    public function removeCache(): RedirectResponse
     {
         $this->config->setAppValue(Application::APP_ID, 'cache-categories', '[]');
 
@@ -63,10 +51,8 @@ class AdminSettingController extends Controller
 
     /**
      * @NoCSRFRequired
-     *
-     * @return Response
      */
-    public function exportConfiguration()
+    public function exportConfiguration(): DataDownloadResponse
     {
         $keys = $this->config->getAppKeys(Application::APP_ID);
         $appConfig = [];

lib/Controller/AppController.php

@@ -29,28 +29,14 @@ use OCP\IUserSession;
 
 class AppController extends Controller
 {
-    /**
-     * @var ConfigProxy
-     */
-    protected $config;
-
-    /**
-     * @var AppRepository
-     */
-    protected $appRepository;
-
     public function __construct(
         string $appName,
         IRequest $request,
-        AppRepository $appRepository,
+        protected AppRepository $appRepository,
-        IURLGenerator $urlGenerator,
+        protected IURLGenerator $urlGenerator,
-        ConfigProxy $config
+        protected ConfigProxy $config
     ) {
         parent::__construct($appName, $request);
-
-        $this->appRepository = $appRepository;
-        $this->urlGenerator = $urlGenerator;
-        $this->config = $config;
     }
 
     /**

lib/Controller/CssController.php

@@ -32,49 +32,26 @@ use OCP\IUserSession;
 
 class CssController extends Controller
 {
-    /**
+    protected ?User $user;
-     * @var ConfigProxy
-     */
-    protected $config;
-
-    /**
-     * @var User
-     */
-    protected $user;
-
-    /**
-     * @var ThemingDefaults
-     */
-    protected $theming;
-
-    /**
-     * @var Color
-     */
-    protected $color;
 
     public function __construct(
         string $appName,
         IRequest $request,
-        ConfigProxy $config,
+        protected ConfigProxy $config,
-        ThemingDefaults $theming,
+        protected ThemingDefaults $theming,
-        Color $color
+        protected Color $color
     ) {
         parent::__construct($appName, $request);
 
         $this->user = OC::$server[IUserSession::class]->getUser();
-        $this->config = $config;
-        $this->theming = $theming;
-        $this->color = $color;
     }
 
     /**
      * @NoAdminRequired
      * @NoCSRFRequired
      * @PublicPage
-     *
-     * @return Response
      */
-    public function stylesheet()
+    public function stylesheet(): TemplateResponse
     {
         $response = new TemplateResponse(Application::APP_ID, 'css/stylesheet', $this->getConfig(), 'blank');
         $response->addHeader('Content-Type', 'text/css');
@@ -107,15 +84,15 @@ class CssController extends Controller
             $isDarkThemeUserEnabled = 'dark' === $this->config->getUserValue($this->user, 'theme', '', 'accessibility');
             $isBreezeDarkUserEnabled = $this->config->getUserValue($this->user, 'theme_enabled', '', 'breezedark');
 
-            $isBreezeDarkUserEnabled = '1' === $isBreezeDarkUserEnabled ||
+            $isBreezeDarkUserEnabled = '1' === $isBreezeDarkUserEnabled
-                ($isBreezeDarkGlobalEnabled && '' === $isBreezeDarkUserEnabled);
+                || ($isBreezeDarkGlobalEnabled && '' === $isBreezeDarkUserEnabled);
         } else {
             $isDarkThemeUserEnabled = false;
             $isBreezeDarkUserEnabled = false;
         }
 
-        $isDarkMode = ($isAccessibilityAppEnabled && $isDarkThemeUserEnabled) ||
+        $isDarkMode = ($isAccessibilityAppEnabled && $isDarkThemeUserEnabled)
-            ($isBreezeDarkAppEnabled && $isBreezeDarkUserEnabled);
+            || ($isBreezeDarkAppEnabled && $isBreezeDarkUserEnabled);
 
         $primaryColor = $this->theming->getColorPrimary();
         $lightenPrimaryColor = $this->color->adjustBrightness($primaryColor, 0.2);

lib/Controller/JsController.php

@@ -32,32 +32,14 @@ use OCP\L10N\IFactory;
 
 class JsController extends Controller
 {
-    /**
+    protected ?User $user;
-     * @var ConfigProxy
-     */
-    protected $config;
-
-    /**
-     * @var User
-     */
-    protected $user;
-
-    /**
-     * @var ThemingDefaults
-     */
-    protected $themingDefaults;
-
-    /**
-     * @var IFactory
-     */
-    protected $l10nFactory;
 
     public function __construct(
         string $appName,
         IRequest $request,
-        ConfigProxy $config,
+        protected ConfigProxy $config,
-        ThemingDefaults $themingDefaults,
+        protected ThemingDefaults $themingDefaults,
-        IFactory $l10nFactory
+        protected IFactory $l10nFactory
     ) {
         parent::__construct($appName, $request);
 

lib/Controller/NavController.php

@@ -19,7 +19,6 @@
 namespace OCA\SideMenu\Controller;
 
 use OC;
-use OC\App\AppStore\Fetcher\CategoryFetcher;
 use OC\URLGenerator;
 use OCA\SideMenu\Service\AppRepository;
 use OCA\SideMenu\Service\CategoryRepository;
@@ -32,57 +31,24 @@ use OCP\L10N\IFactory;
 
 class NavController extends Controller
 {
-    /**
-     * @var ConfigProxy
-     */
-    protected $config;
-
-    /**
-     * @var AppRepository
-     */
-    protected $appRepository;
-
-    /**
-     * @var IFactory
-     */
-    protected $l10nFactory;
-
-    /**
-     * @var CategoryFetcher
-     */
-    protected $categoryFetcher;
-
-    /**
-     * @var URLGenerator
-     */
-    protected $router;
-
     public function __construct(
         string $appName,
         IRequest $request,
-        ConfigProxy $config,
+        protected ConfigProxy $config,
-        AppRepository $appRepository,
+        protected AppRepository $appRepository,
-        CategoryRepository $categoryRepository,
+        protected CategoryRepository $categoryRepository,
-        URLGenerator $router,
+        protected URLGenerator $router,
-        IFactory $l10nFactory
+        protected IFactory $l10nFactory
     ) {
         parent::__construct($appName, $request);
-
-        $this->config = $config;
-        $this->appRepository = $appRepository;
-        $this->categoryRepository = $categoryRepository;
-        $this->l10nFactory = $l10nFactory;
-        $this->router = $router;
     }
 
     /**
      * @NoAdminRequired
      * @NoCSRFRequired
      * @PublicPage
-     *
-     * @return JSONResponse
      */
-    public function items()
+    public function items(): JSONResponse
     {
         $user = OC::$server[IUserSession::class]->getUser();
         $items = [];
@@ -189,11 +155,11 @@ class NavController extends Controller
 
         usort($items, function ($a, $b) use ($categoriesLabels) {
             foreach ($categoriesLabels as $key => $value) {
-                if ($a['categoryId'] === 'other') {
+                if ('other' === $a['categoryId']) {
                     return -1;
                 }
 
-                if ($b['categoryId'] === 'other') {
+                if ('other' === $b['categoryId']) {
                     return 1;
                 }
 

lib/Controller/PersonalSettingController.php

@@ -21,40 +21,20 @@ namespace OCA\SideMenu\Controller;
 use OCA\SideMenu\AppInfo\Application;
 use OCA\SideMenu\Service\ConfigProxy;
 use OCP\AppFramework\Controller;
-use OCP\AppFramework\Http\Response;
 use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IUserSession;
 
 class PersonalSettingController extends Controller
 {
-    /**
-     * @var IConfig
-     */
-    protected $config;
-
-    /**
-     * @var ConfigProxy
-     */
-    protected $configProxy;
-
-    /**
-     * @var IUserSession
-     */
-    protected $userSession;
-
     public function __construct(
         $appName,
         IRequest $request,
-        IConfig $config,
+        protected IConfig $config,
-        ConfigProxy $configProxy,
+        protected ConfigProxy $configProxy,
-        IUserSession $userSession
+        protected IUserSession $userSession
     ) {
         parent::__construct($appName, $request);
-
-        $this->config = $config;
-        $this->configProxy = $configProxy;
-        $this->userSession = $userSession;
     }
 
     /**
@@ -63,10 +43,8 @@ class PersonalSettingController extends Controller
      *
      * @param mixed $name
      * @param mixed $value
-     *
-     * @return Response
      */
-    public function valueSet($name, $value)
+    public function valueSet($name, $value): array
     {
         $doSave = false;
         $user = $this->userSession->getUser();

lib/Service/AppRepository.php

@@ -3,7 +3,12 @@
 namespace OCA\SideMenu\Service;
 
 use OC\User\User;
+use OCA\SideMenu\AppInfo\Application;
+use OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent;
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\INavigationManager;
+use OCP\IUserSession;
 use OCP\L10N\IFactory;
 
 /**
@@ -13,51 +18,25 @@ use OCP\L10N\IFactory;
  */
 class AppRepository
 {
-    /**
-     * @var \OC_App
-     */
-    protected $ocApp;
-
-    /**
-     * @var IFactory
-     */
-    protected $l10nFactory;
-
-    /**
-     * @var ConfigProxy
-     */
-    protected $config;
-
-    /**
-     * @var CategoryRepository
-     */
-    protected $categoryRepository;
-
-    /**
-     * @var INavigationManager
-     */
-    protected $navigationManager;
-
     public function __construct(
-        \OC_App $ocApp,
+        protected \OC_App $ocApp,
-        INavigationManager $navigationManager,
+        protected INavigationManager $navigationManager,
-        IFactory $l10nFactory,
+        protected IFactory $l10nFactory,
-        ConfigProxy $config,
+        protected ConfigProxy $config,
-        CategoryRepository $categoryRepository
+        protected CategoryRepository $categoryRepository,
+        protected IEventDispatcher $dispatcher,
+        protected IUserSession $userSession,
     ) {
-        $this->ocApp = $ocApp;
+        $this->dispatcher->dispatchTyped(new BeforeTemplateRenderedEvent(
-        $this->l10nFactory = $l10nFactory;
+            $this->userSession->isLoggedIn(),
-        $this->config = $config;
+            new TemplateResponse(Application::APP_NAME, '')
-        $this->navigationManager = $navigationManager;
+        ));
-        $this->categoryRepository = $categoryRepository;
     }
 
     /**
      * Retrieves visibles apps.
-     *
-     * @return array
      */
-    public function getVisibleApps()
+    public function getVisibleApps(): array
     {
         $navigation = $this->navigationManager->getAll();
         $appCategoriesCustom = $this->config->getAppValueArray('apps-categories-custom', '[]');
@@ -90,6 +69,14 @@ class AppRepository
                         'external_links',
                     ],
                 ];
+            } elseif ('tables_application' === substr($app['id'], 0, 18)) {
+                $visibleApps[$app['id']] = [
+                    'id' => $app['id'],
+                    'name' => $this->getAppName($app),
+                    'href' => $app['href'],
+                    'icon' => $app['icon'],
+                    'category' => [],
+                ];
             } elseif ('files' === $app['id']) {
                 $visibleApps[$app['id']] = [
                     'id' => $app['id'],
@@ -110,7 +97,7 @@ class AppRepository
         return $visibleApps;
     }
 
-    public function getAppName($app)
+    public function getAppName($app): string
     {
         return $this->config->getAppValue(
             'app.navigation.name',
@@ -119,7 +106,7 @@ class AppRepository
         );
     }
 
-    public function getOrderedApps(?User $user = null)
+    public function getOrderedApps(?User $user = null): array
     {
         $apps = $this->getVisibleApps();
         $orders = $this->config->getAppValueArray('apps-order', '[]');

lib/Service/CategoryRepository.php

@@ -15,51 +15,19 @@ use OCP\L10N\IFactory;
  */
 class CategoryRepository
 {
-    /**
-     * @var CategoryFetcher
-     */
-    protected $categoryFetcher;
-
-    /**
-     * @var IFactory
-     */
-    protected $l10nFactory;
-
-    /**
-     * @var ConfigProxy
-     */
-    protected $config;
-
-    /**
-     * @var IConfig
-     */
-    protected $iConfig;
-
-    /**
-     * @var IUserSession
-     */
-    protected $userSession;
-
     public function __construct(
-        CategoryFetcher $categoryFetcher,
+        protected CategoryFetcher $categoryFetcher,
-        ConfigProxy $config,
+        protected ConfigProxy $config,
-        IConfig $iConfig,
+        protected IConfig $iConfig,
-        IFactory $l10nFactory,
+        protected IFactory $l10nFactory,
-        IUserSession $userSession
+        protected IUserSession $userSession
     ) {
-        $this->categoryFetcher = $categoryFetcher;
-        $this->l10nFactory = $l10nFactory;
-        $this->config = $config;
-        $this->iConfig = $iConfig;
-        $this->userSession = $userSession;
     }
 
     /**
      * Retrieves categories.
-     *
-     * @return array
      */
-    public function getOrderedCategories()
+    public function getOrderedCategories(): array
     {
         $currentLanguage = substr($this->l10nFactory->findLanguage(), 0, 2);
         $type = $this->config->getAppValue('categories-order-type', 'default');

lib/Service/ConfigProxy.php

@@ -13,12 +13,7 @@ use OCP\IConfig;
  */
 class ConfigProxy
 {
-    /**
+    public function __construct(protected IConfig $config)
-     * @var IConfig
-     */
-    protected $config;
-
-    public function __construct(IConfig $config)
     {
         $this->config = $config;
     }

lib/Service/LangRepository.php

@@ -11,12 +11,7 @@ use OCP\IDBConnection;
  */
 class LangRepository
 {
-    /**
+    public function __construct(protected IDBConnection $db)
-     * @var IDBConnection
-     */
-    protected $db;
-
-    public function __construct(IDBConnection $db)
     {
         $this->db = $db;
     }

lib/Settings/Admin.php

@@ -21,75 +21,27 @@ namespace OCA\SideMenu\Settings;
 use OCA\SideMenu\AppInfo\Application;
 use OCA\SideMenu\Service\AppRepository;
 use OCA\SideMenu\Service\CategoryRepository;
+use OCA\SideMenu\Service\Color;
 use OCA\SideMenu\Service\ConfigProxy;
+use OCA\SideMenu\Service\LangRepository;
+use OCA\Theming\ThemingDefaults;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\IL10N;
 use OCP\ILogger;
 use OCP\Settings\ISettings;
-use OCA\Theming\ThemingDefaults;
-use OCA\SideMenu\Service\Color;
-use OCA\SideMenu\Service\LangRepository;
 
 class Admin implements ISettings
 {
-    /**
-     * @var IL10N
-     */
-    private $l;
-
-    /**
-     * @var ILogger
-     */
-    private $logger;
-
-    /**
-     * @var ConfigProxy
-     */
-    private $config;
-
-    /**
-     * @var AppRepository
-     */
-    private $appRepository;
-
-    /**
-     * @var CategoryRepository
-     */
-    private $categoryRepository;
-
-    /**
-     * @var ThemingDefaults
-     */
-    protected $theming;
-
-    /**
-     * @var Color
-     */
-    protected $color;
-
-    /**
-     * @var LangRepository
-     */
-    protected $langRepository;
-
     public function __construct(
-        IL10N $l,
+        protected IL10N $l,
-        ILogger $logger,
+        protected ILogger $logger,
-        ConfigProxy $config,
+        protected ConfigProxy $config,
-        AppRepository $appRepository,
+        protected AppRepository $appRepository,
-        CategoryRepository $categoryRepository,
+        protected CategoryRepository $categoryRepository,
-        ThemingDefaults $theming,
+        protected ThemingDefaults $theming,
-        Color $color,
+        protected Color $color,
-        LangRepository $langRepository
+        protected LangRepository $langRepository
     ) {
-        $this->l = $l;
-        $this->logger = $logger;
-        $this->config = $config;
-        $this->appRepository = $appRepository;
-        $this->categoryRepository = $categoryRepository;
-        $this->theming = $theming;
-        $this->color = $color;
-        $this->langRepository = $langRepository;
     }
 
     /**

lib/Settings/AdminSection.php

@@ -25,51 +25,22 @@ use OCP\Settings\IIconSection;
 
 class AdminSection implements IIconSection
 {
-    /**
+    public function __construct(
-     * @var IL10N
+        protected IURLGenerator $url,
-     */
+        protected IL10N $l
-    private $l;
+    ) {
-
-    /**
-     * @var IURLGenerator
-     */
-    private $url;
-
-    public function __construct(IURLGenerator $url, IL10N $l)
-    {
-        $this->url = $url;
-        $this->l = $l;
     }
 
-    /**
-     * returns the ID of the section. It is supposed to be a lower case string,
-     * e.g. 'ldap'.
-     *
-     * @returns string
-     */
     public function getID()
     {
         return Application::APP_ID;
     }
 
-    /**
-     * returns the translated name as it should be displayed, e.g. 'LDAP / AD
-     * integration'. Use the L10N service to translate it.
-     *
-     * @return string
-     */
     public function getName()
     {
         return $this->l->t(Application::APP_NAME);
     }
 
-    /**
-     * @return int whether the form should be rather on the top or bottom of
-     *             the settings navigation. The sections are arranged in ascending order of
-     *             the priority values. It is required to return a value between 0 and 99.
-     *
-     * E.g.: 70
-     */
     public function getPriority()
     {
         return 70;

lib/Settings/Personal.php

@@ -29,43 +29,13 @@ use OCP\Settings\ISettings;
 
 class Personal implements ISettings
 {
-    /**
-     * @var IL10N
-     */
-    private $l;
-
-    /**
-     * @var ILogger
-     */
-    private $logger;
-
-    /**
-     * @var ConfigProxy
-     */
-    private $config;
-
-    /**
-     * @var IUserSession
-     */
-    private $userSession;
-
-    /**
-     * @var AppRepository
-     */
-    private $appRepository;
-
     public function __construct(
-        IL10N $l,
+        protected IL10N $l,
-        ILogger $logger,
+        protected ILogger $logger,
-        ConfigProxy $config,
+        protected ConfigProxy $config,
-        IUserSession $userSession,
+        protected IUserSession $userSession,
-        AppRepository $appRepository
+        protected AppRepository $appRepository
     ) {
-        $this->l = $l;
-        $this->logger = $logger;
-        $this->config = $config;
-        $this->userSession = $userSession;
-        $this->appRepository = $appRepository;
     }
 
     /**

lib/Settings/PersonalSection.php

@@ -26,34 +26,13 @@ use OCP\Settings\IIconSection;
 
 class PersonalSection implements IIconSection
 {
-    /**
+    public function __construct(
-     * @var IL10N
+        protected IURLGenerator $url,
-     */
+        protected IL10N $l,
-    private $l;
+        protected ConfigProxy $configProxy
-
+    ) {
-    /**
-     * @var IURLGenerator
-     */
-    private $url;
-
-    /**
-     * @var ConfigProxy
-     */
-    private $configProxy;
-
-    public function __construct(IURLGenerator $url, IL10N $l, ConfigProxy $configProxy)
-    {
-        $this->url = $url;
-        $this->l = $l;
-        $this->configProxy = $configProxy;
     }
 
-    /**
-     * returns the ID of the section. It is supposed to be a lower case string,
-     * e.g. 'ldap'.
-     *
-     * @returns string
-     */
     public function getID()
     {
         if ($this->configProxy->getAppValueBool('force', '0')) {
@@ -63,12 +42,6 @@ class PersonalSection implements IIconSection
         return Application::APP_ID;
     }
 
-    /**
-     * returns the translated name as it should be displayed, e.g. 'LDAP / AD
-     * integration'. Use the L10N service to translate it.
-     *
-     * @return string
-     */
     public function getName()
     {
         if ($this->configProxy->getAppValueBool('force', '0')) {
@@ -78,13 +51,6 @@ class PersonalSection implements IIconSection
         return $this->l->t(Application::APP_NAME);
     }
 
-    /**
-     * @return int whether the form should be rather on the top or bottom of
-     *             the settings navigation. The sections are arranged in ascending order of
-     *             the priority values. It is required to return a value between 0 and 99.
-     *
-     * E.g.: 70
-     */
     public function getPriority()
     {
         if ($this->configProxy->getAppValueBool('force', '0')) {