AbterPhp\Admin\Http\Controllers\ApiAbstract

Complexity

Total Complexity

18

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	11	2
A	create()	0	22	3
A	isEntityNotFound()	0	7	2
A	__construct()	0	10	1
A	delete()	0	16	3
A	list()	0	18	2
A	getUserIdentifier()	0	3	1
A	update()	0	27	4

<?php

declare(strict_types=1);

namespace AbterPhp\Admin\Http\Controllers;

use AbterPhp\Framework\Databases\Queries\FoundRows;
use AbterPhp\Framework\Http\Service\Execute\IRepoService;
use Opulence\Http\Responses\Response;
use Opulence\Orm\OrmException;
use Opulence\Routing\Controller;
use Psr\Log\LoggerInterface;

abstract class ApiAbstract extends Controller
{
    use ApiResponseTrait;
    use ApiIssueTrait;
    use ApiDataTrait;

    public const LOG_MSG_CREATE_FAILURE = 'Creating %1$s failed.';
    public const LOG_MSG_UPDATE_FAILURE = 'Updating %1$s with id "%2$s" failed.';
    public const LOG_MSG_DELETE_FAILURE = 'Deleting %1$s with id "%2$s" failed.';
    public const LOG_MSG_GET_FAILURE    = 'Retrieving %1$s with id "%2$s" failed.';
    public const LOG_MSG_LIST_FAILURE   = 'Retrieving %1$s failed.';

    public const LOG_CONTEXT_EXCEPTION  = 'Exception';
    public const LOG_PREVIOUS_EXCEPTION = 'Previous exception #%d';

    public const ENTITY_SINGULAR = '';
    public const ENTITY_PLURAL   = '';

    protected LoggerInterface $logger;

    protected IRepoService $repoService;

    protected FoundRows $foundRows;

    /**
     * ApiAbstract constructor.
     *
     * @param LoggerInterface $logger
     * @param IRepoService    $repoService
     * @param FoundRows       $foundRows
     * @param string          $problemBaseUrl
     */
    public function __construct(
        LoggerInterface $logger,
        IRepoService $repoService,
        FoundRows $foundRows,
        string $problemBaseUrl
    ) {
        $this->logger         = $logger;
        $this->repoService    = $repoService;
        $this->foundRows      = $foundRows;
        $this->problemBaseUrl = $problemBaseUrl;
    }

    /**
     * @param string $entityId
     *
     * @return Response
     */
    public function get(string $entityId): Response
    {
        try {
            $entity = $this->repoService->retrieveEntity($entityId);
        } catch (\Exception $e) {
            $msg = sprintf(static::LOG_MSG_GET_FAILURE, static::ENTITY_SINGULAR, $entityId);

            return $this->handleException($msg, $e);
        }

        return $this->handleGetSuccess($entity);
    }

    /**
     * @return Response
     */
    public function list(): Response
    {
        $query = $this->request->getQuery();

        $offset = (int)$query->get('offset', 0);
        $limit  = (int)$query->get('limit', 100);

        try {
            $entities = $this->repoService->retrieveList($offset, $limit, [], [], []);
        } catch (\Exception $e) {
            $msg = sprintf(static::LOG_MSG_LIST_FAILURE, static::ENTITY_PLURAL);

            return $this->handleException($msg, $e);
        }

        $maxCount = $this->foundRows->get();

        return $this->handleListSuccess($entities, $maxCount);
    }

    /**
     * @return Response
     */
    public function create(): Response
    {
        try {
            $data = $this->getCreateData();

            $errors = $this->repoService->validateForm($data);

            if (count($errors) > 0) {
                $msg = sprintf(static::LOG_MSG_CREATE_FAILURE, static::ENTITY_SINGULAR);

                return $this->handleErrors($msg, $errors);
            }

            $fileData = $this->getFileData($data);
            $entity   = $this->repoService->create($data, $fileData);
        } catch (\Exception $e) {
            $msg = sprintf(static::LOG_MSG_CREATE_FAILURE, static::ENTITY_SINGULAR);

            return $this->handleException($msg, $e);
        }

        return $this->handleCreateSuccess($entity);
    }

    /**
     * @param string $entityId
     *
     * @return Response
     */
    public function update(string $entityId): Response
    {
        try {
            $data = $this->getUpdateData();

            $errors = $this->repoService->validateForm($data);

            if (count($errors) > 0) {
                $msg = sprintf(static::LOG_MSG_UPDATE_FAILURE, static::ENTITY_SINGULAR, $entityId);

                return $this->handleErrors($msg, $errors);
            }

            $fileData = $this->getFileData($data);
            $entity   = $this->repoService->retrieveEntity($entityId);
            $this->repoService->update($entity, $data, $fileData);
        } catch (\Exception $e) {
            if ($this->isEntityNotFound($e)) {
                return $this->handleNotFound();
            }

            $msg = sprintf(static::LOG_MSG_UPDATE_FAILURE, static::ENTITY_SINGULAR, $entityId);

            return $this->handleException($msg, $e);
        }

        return $this->handleUpdateSuccess($entity);
    }

    /**
     * @param string $entityId
     *
     * @return Response
     */
    public function delete(string $entityId): Response
    {
        try {
            $entity = $this->repoService->retrieveEntity($entityId);
            $this->repoService->delete($entity);
        } catch (\Exception $e) {
            if ($this->isEntityNotFound($e)) {
                return $this->handleNotFound();
            }

            $msg = sprintf(static::LOG_MSG_DELETE_FAILURE, static::ENTITY_SINGULAR, $entityId);

            return $this->handleException($msg, $e);
        }

        return $this->handleDeleteSuccess();
    }

    /**
     * @param \Exception $e
     *
     * @return bool
     */
    protected function isEntityNotFound(\Exception $e): bool
    {
        if (!($e instanceof OrmException)) {
            return false;
        }

        return $e->getMessage() === 'Failed to find entity';
    }

    /**
     * @return string
     */
    protected function getUserIdentifier(): string
    {
        return (string)$this->request->getHeaders()->get('xxx-user-username');
    }
}