chore: Migrate API tag controllers.

Signed-off-by: Rubén D <nuxsmin@syspass.org>

app/modules/api/Controllers/Tag/CreateController.php

@@ -0,0 +1,84 @@
+<?php
+/*
+ * sysPass
+ *
+ * @author nuxsmin
+ * @link https://syspass.org
+ * @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
+ *
+ * This file is part of sysPass.
+ *
+ * sysPass is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * sysPass is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace SP\Modules\Api\Controllers\Tag;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Core\Events\EventMessage;
+use SP\DataModel\TagData;
+use SP\Domain\Api\Services\ApiResponse;
+
+/**
+ * Class CreateController
+ */
+final class CreateController extends TagBase
+{
+    /**
+     * createAction
+     */
+    public function createAction(): void
+    {
+        try {
+            $this->setupApi(ActionsInterface::TAG_CREATE);
+
+            $tagData = $this->buildTagData();
+
+            $id = $this->tagService->create($tagData);
+
+            $tagData->setId($id);
+
+            $this->eventDispatcher->notifyEvent(
+                'create.tag',
+                new Event(
+                    $this,
+                    EventMessage::factory()
+                        ->addDescription(__u('Tag added'))
+                        ->addDetail(__u('Name'), $tagData->getName())
+                        ->addDetail('ID', $id)
+                )
+            );
+
+            $this->returnResponse(ApiResponse::makeSuccess($tagData, $id, __('Tag added')));
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->returnResponseException($e);
+        }
+    }
+
+    /**
+     * @return \SP\DataModel\TagData
+     * @throws \SP\Domain\Common\Services\ServiceException
+     */
+    private function buildTagData(): TagData
+    {
+        $tagData = new TagData();
+        $tagData->setName($this->apiService->getParamString('name', true));
+
+        return $tagData;
+    }
+}

app/modules/api/Controllers/Tag/DeleteController.php

@@ -0,0 +1,72 @@
+<?php
+/*
+ * sysPass
+ *
+ * @author nuxsmin
+ * @link https://syspass.org
+ * @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
+ *
+ * This file is part of sysPass.
+ *
+ * sysPass is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * sysPass is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace SP\Modules\Api\Controllers\Tag;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Core\Events\EventMessage;
+use SP\Domain\Api\Services\ApiResponse;
+
+/**
+ * Class DeleteController
+ */
+final class DeleteController extends TagBase
+{
+    /**
+     * deleteAction
+     */
+    public function deleteAction(): void
+    {
+        try {
+            $this->setupApi(ActionsInterface::TAG_DELETE);
+
+            $id = $this->apiService->getParamInt('id', true);
+
+            $tagData = $this->tagService->getById($id);
+
+            $this->tagService->delete($id);
+
+            $this->eventDispatcher->notifyEvent(
+                'delete.tag',
+                new Event(
+                    $this,
+                    EventMessage::factory()
+                        ->addDescription(__u('Tag removed'))
+                        ->addDetail(__u('Name'), $tagData->getName())
+                        ->addDetail('ID', $id)
+                )
+            );
+
+            $this->returnResponse(ApiResponse::makeSuccess($tagData, $id, __('Tag removed')));
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->returnResponseException($e);
+        }
+    }
+
+}

app/modules/api/Controllers/Tag/EditController.php

@@ -0,0 +1,83 @@
+<?php
+/*
+ * sysPass
+ *
+ * @author nuxsmin
+ * @link https://syspass.org
+ * @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
+ *
+ * This file is part of sysPass.
+ *
+ * sysPass is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * sysPass is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace SP\Modules\Api\Controllers\Tag;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Core\Events\EventMessage;
+use SP\DataModel\TagData;
+use SP\Domain\Api\Services\ApiResponse;
+
+/**
+ * Class EditController
+ */
+final class EditController extends TagBase
+{
+    /**
+     * editAction
+     */
+    public function editAction(): void
+    {
+        try {
+            $this->setupApi(ActionsInterface::TAG_EDIT);
+
+            $tagData = $this->buildTagData();
+
+            $this->tagService->update($tagData);
+
+            $this->eventDispatcher->notifyEvent(
+                'edit.tag',
+                new Event(
+                    $this,
+                    EventMessage::factory()
+                        ->addDescription(__u('Tag updated'))
+                        ->addDetail(__u('Name'), $tagData->getName())
+                        ->addDetail('ID', $tagData->getId())
+                )
+            );
+
+            $this->returnResponse(ApiResponse::makeSuccess($tagData, $tagData->getId(), __('Tag updated')));
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->returnResponseException($e);
+        }
+    }
+
+    /**
+     * @return \SP\DataModel\TagData
+     * @throws \SP\Domain\Common\Services\ServiceException
+     */
+    private function buildTagData(): TagData
+    {
+        $tagData = new TagData();
+        $tagData->setId($this->apiService->getParamInt('id', true));
+        $tagData->setName($this->apiService->getParamString('name', true));
+
+        return $tagData;
+    }
+}

app/modules/api/Controllers/Tag/SearchController.php

@@ -0,0 +1,74 @@
+<?php
+/*
+ * sysPass
+ *
+ * @author nuxsmin
+ * @link https://syspass.org
+ * @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
+ *
+ * This file is part of sysPass.
+ *
+ * sysPass is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * sysPass is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace SP\Modules\Api\Controllers\Tag;
+
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\DataModel\ItemSearchData;
+use SP\Domain\Api\Services\ApiResponse;
+
+/**
+ * Class SearchController
+ */
+final class SearchController extends TagBase
+{
+    /**
+     * searchAction
+     */
+    public function searchAction(): void
+    {
+        try {
+            $this->setupApi(ActionsInterface::TAG_SEARCH);
+
+            $itemSearchData = $this->buildSearchData();
+
+            $this->eventDispatcher->notifyEvent('search.tag', new Event($this));
+            $this->returnResponse(
+                ApiResponse::makeSuccess(
+                    $this->tagService->search($itemSearchData)->getDataAsArray()
+                )
+            );
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->returnResponseException($e);
+        }
+    }
+
+    /**
+     * @return \SP\DataModel\ItemSearchData
+     * @throws \SP\Domain\Common\Services\ServiceException
+     */
+    private function buildSearchData(): ItemSearchData
+    {
+        $itemSearchData = new ItemSearchData();
+        $itemSearchData->setSeachString($this->apiService->getParamString('text'));
+        $itemSearchData->setLimitCount($this->apiService->getParamInt('count', false, self::SEARCH_COUNT_ITEMS));
+
+        return $itemSearchData;
+    }
+}

app/modules/api/Controllers/Tag/TagBase.php

@@ -0,0 +1,59 @@
+<?php
+/*
+ * sysPass
+ *
+ * @author nuxsmin
+ * @link https://syspass.org
+ * @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
+ *
+ * This file is part of sysPass.
+ *
+ * sysPass is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * sysPass is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace SP\Modules\Api\Controllers\Tag;
+
+
+use Klein\Klein;
+use SP\Core\Acl\Acl;
+use SP\Core\Application;
+use SP\Domain\Api\ApiServiceInterface;
+use SP\Domain\Tag\TagServiceInterface;
+use SP\Modules\Api\Controllers\ControllerBase;
+use SP\Modules\Api\Controllers\Help\TagHelp;
+
+/**
+ * Class TagBase
+ */
+abstract class TagBase extends ControllerBase
+{
+    protected TagServiceInterface $tagService;
+
+    /**
+     * @throws \SP\Core\Exceptions\InvalidClassException
+     */
+    public function __construct(
+        Application $application,
+        Klein $router,
+        ApiServiceInterface $apiService,
+        Acl $acl,
+        TagServiceInterface $tagService
+    ) {
+        parent::__construct($application, $router, $apiService, $acl);
+
+        $this->tagService = $tagService;
+
+        $this->apiService->setHelpClass(TagHelp::class);
+    }
+}

app/modules/api/Controllers/Tag/ViewController.php

@@ -0,0 +1,67 @@
+<?php
+/*
+ * sysPass
+ *
+ * @author nuxsmin
+ * @link https://syspass.org
+ * @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
+ *
+ * This file is part of sysPass.
+ *
+ * sysPass is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * sysPass is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace SP\Modules\Api\Controllers\Tag;
+
+use Exception;
+use SP\Core\Acl\ActionsInterface;
+use SP\Core\Events\Event;
+use SP\Core\Events\EventMessage;
+use SP\Domain\Api\Services\ApiResponse;
+
+/**
+ * Class ViewController
+ *
+ * @package SP\Modules\Api\Controllers
+ */
+final class ViewController extends TagBase
+{
+    /**
+     * viewAction
+     */
+    public function viewAction(): void
+    {
+        try {
+            $this->setupApi(ActionsInterface::TAG_VIEW);
+
+            $id = $this->apiService->getParamInt('id', true);
+            $tagData = $this->tagService->getById($id);
+
+            $this->eventDispatcher->notifyEvent(
+                'show.tag',
+                new Event($this, EventMessage::factory()
+                    ->addDescription(__u('Tag displayed'))
+                    ->addDetail(__u('Name'), $tagData->getName())
+                    ->addDetail('ID', $id)
+                )
+            );
+
+            $this->returnResponse(ApiResponse::makeSuccess($tagData, $id));
+        } catch (Exception $e) {
+            processException($e);
+
+            $this->returnResponseException($e);
+        }
+    }
+}

app/modules/api/Controllers/TagController.php

@@ -1,229 +0,0 @@
-<?php
-/*
- * sysPass
- *
- * @author nuxsmin
- * @link https://syspass.org
- * @copyright 2012-2021, Rubén Domínguez nuxsmin@$syspass.org
- *
- * This file is part of sysPass.
- *
- * sysPass is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * sysPass is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-namespace SP\Modules\Api\Controllers;
-
-use Exception;
-use SP\Core\Acl\ActionsInterface;
-use SP\Core\Events\Event;
-use SP\Core\Events\EventMessage;
-use SP\DataModel\ItemSearchData;
-use SP\DataModel\TagData;
-use SP\Domain\Api\Services\ApiResponse;
-use SP\Domain\Tag\Services\TagService;
-use SP\Modules\Api\Controllers\Help\TagHelp;
-
-/**
- * Class TagController
- *
- * @package SP\Modules\Api\Controllers
- */
-final class TagController extends ControllerBase
-{
-    private ?TagService $tagService = null;
-
-    /**
-     * viewAction
-     */
-    public function viewAction(): void
-    {
-        try {
-            $this->setupApi(ActionsInterface::TAG_VIEW);
-
-            $id = $this->apiService->getParamInt('id', true);
-            $tagData = $this->tagService->getById($id);
-
-            $this->eventDispatcher->notifyEvent(
-                'show.tag',
-                new Event($this, EventMessage::factory()
-                    ->addDescription(__u('Tag displayed'))
-                    ->addDetail(__u('Name'), $tagData->getName())
-                    ->addDetail('ID', $id)
-                )
-            );
-
-            $this->returnResponse(ApiResponse::makeSuccess($tagData, $id));
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->returnResponseException($e);
-        }
-    }
-
-    /**
-     * createAction
-     */
-    public function createAction(): void
-    {
-        try {
-            $this->setupApi(ActionsInterface::TAG_CREATE);
-
-            $tagData = new TagData();
-            $tagData->setName($this->apiService->getParamString('name', true));
-
-            $id = $this->tagService->create($tagData);
-
-            $tagData->setId($id);
-
-            $this->eventDispatcher->notifyEvent(
-                'create.tag',
-                new Event(
-                    $this,
-                    EventMessage::factory()
-                        ->addDescription(__u('Tag added'))
-                        ->addDetail(__u('Name'), $tagData->getName())
-                        ->addDetail('ID', $id)
-                )
-            );
-
-            $this->returnResponse(
-                ApiResponse::makeSuccess(
-                    $tagData,
-                    $id,
-                    __('Tag added')
-                )
-            );
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->returnResponseException($e);
-        }
-    }
-
-    /**
-     * editAction
-     */
-    public function editAction(): void
-    {
-        try {
-            $this->setupApi(ActionsInterface::TAG_EDIT);
-
-            $tagData = new TagData();
-            $tagData->setId($this->apiService->getParamInt('id', true));
-            $tagData->setName($this->apiService->getParamString('name', true));
-
-            $this->tagService->update($tagData);
-
-            $this->eventDispatcher->notifyEvent(
-                'edit.tag',
-                new Event(
-                    $this,
-                    EventMessage::factory()
-                        ->addDescription(__u('Tag updated'))
-                        ->addDetail(__u('Name'), $tagData->getName())
-                        ->addDetail('ID', $tagData->getId())
-                )
-            );
-
-            $this->returnResponse(
-                ApiResponse::makeSuccess(
-                    $tagData,
-                    $tagData->getId(),
-                    __('Tag updated')
-                )
-            );
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->returnResponseException($e);
-        }
-    }
-
-    /**
-     * deleteAction
-     */
-    public function deleteAction(): void
-    {
-        try {
-            $this->setupApi(ActionsInterface::TAG_DELETE);
-
-            $id = $this->apiService->getParamInt('id', true);
-
-            $tagData = $this->tagService->getById($id);
-
-            $this->tagService->delete($id);
-
-            $this->eventDispatcher->notifyEvent(
-                'delete.tag',
-                new Event(
-                    $this,
-                    EventMessage::factory()
-                        ->addDescription(__u('Tag removed'))
-                        ->addDetail(__u('Name'), $tagData->getName())
-                        ->addDetail('ID', $id)
-                )
-            );
-
-            $this->returnResponse(
-                ApiResponse::makeSuccess(
-                    $tagData,
-                    $id,
-                    __('Tag removed')
-                )
-            );
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->returnResponseException($e);
-        }
-    }
-
-    /**
-     * searchAction
-     */
-    public function searchAction(): void
-    {
-        try {
-            $this->setupApi(ActionsInterface::TAG_SEARCH);
-
-            $itemSearchData = new ItemSearchData();
-            $itemSearchData->setSeachString($this->apiService->getParamString('text'));
-            $itemSearchData->setLimitCount($this->apiService->getParamInt('count', false, self::SEARCH_COUNT_ITEMS));
-
-            $this->eventDispatcher->notifyEvent(
-                'search.tag',
-                new Event($this)
-            );
-
-            $this->returnResponse(
-                ApiResponse::makeSuccess(
-                    $this->tagService->search($itemSearchData)->getDataAsArray()
-                )
-            );
-        } catch (Exception $e) {
-            processException($e);
-
-            $this->returnResponseException($e);
-        }
-    }
-
-    /**
-     * @throws \SP\Core\Exceptions\InvalidClassException
-     */
-    protected function initialize(): void
-    {
-        $this->tagService = $this->dic->get(TagService::class);
-        $this->apiService->setHelpClass(TagHelp::class);
-    }
-}