ApiAbstract::handleException() - Code Metrics - Inspection of "Refactoring ApiAbstract controller" - abterphp/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 64da52...b1a7d7 )

by Peter

created 2019-07-18 14:01 UTC

ApiAbstract::handleException() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	11
nc	1
nop	2
dl	0
loc	17
rs	9.9
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace AbterPhp\Framework\Http\Controllers;

use AbterPhp\Framework\Config\Provider as ConfigProvider;
use AbterPhp\Framework\Databases\Queries\FoundRows;
use AbterPhp\Framework\Domain\Entities\IToJsoner;
filter:
    dependency_paths: ["lib/*"]
use AbterPhp\Framework\Http\Service\Execute\RepoServiceAbstract;
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;

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

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

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

    /** @var LoggerInterface */
    protected $logger;

    /** @var RepoService */
filter:
    dependency_paths: ["lib/*"]
    protected $repoService;

    /** @var FoundRows */
    protected $foundRows;

    /**
     * ApiAbstract constructor.
     *
     * @param LoggerInterface     $logger
     * @param RepoServiceAbstract $repoService
     * @param FoundRows           $foundRows
     * @param ConfigProvider      $configProvider
     */
    public function __construct(
        LoggerInterface $logger,
        RepoServiceAbstract $repoService,
        FoundRows $foundRows,
        ConfigProvider $configProvider
    ) {
        $this->logger         = $logger;
        $this->repoService    = $repoService;

        $this->foundRows      = $foundRows;
        $this->problemBaseUrl = $configProvider->getProblemBaseUrl();
    }

    /**
     * @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';
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace AbterPhp\Framework\Http\Controllers;
6
7			use AbterPhp\Framework\Config\Provider as ConfigProvider;
8			use AbterPhp\Framework\Databases\Queries\FoundRows;
9			use AbterPhp\Framework\Domain\Entities\IToJsoner;
			0 ignored issues – show Bug introduced 2019-05-27 16:06 UTC by Report Bug Copy Issue Report The type `AbterPhp\Framework\Domain\Entities\IToJsoner` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use AbterPhp\Framework\Http\Service\Execute\RepoServiceAbstract;
11			use Opulence\Http\Responses\Response;
12			use Opulence\Orm\OrmException;
13			use Opulence\Routing\Controller;
14			use Psr\Log\LoggerInterface;
15
16			abstract class ApiAbstract extends Controller
17			{
18			use ApiResponseTrait;
19			use ApiIssueTrait;
20			use ApiDataTrait;
21
22			const LOG_MSG_CREATE_FAILURE = 'Creating %1$s failed.';
23			const LOG_MSG_UPDATE_FAILURE = 'Updating %1$s with id "%2$s" failed.';
24			const LOG_MSG_DELETE_FAILURE = 'Deleting %1$s with id "%2$s" failed.';
25			const LOG_MSG_GET_FAILURE = 'Retrieving %1$s with id "%2$s" failed.';
26			const LOG_MSG_LIST_FAILURE = 'Retrieving %1$s failed.';
27
28			const LOG_CONTEXT_EXCEPTION = 'Exception';
29			const LOG_PREVIOUS_EXCEPTION = 'Previous exception #%d';
30
31			const ENTITY_SINGULAR = '';
32			const ENTITY_PLURAL = '';
33
34			/** @var LoggerInterface */
35			protected $logger;
36
37			/** @var RepoService */
			0 ignored issues – show Bug introduced 2019-06-21 19:32 UTC by Report Bug Copy Issue Report The type `AbterPhp\Framework\Http\Controllers\RepoService` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
38			protected $repoService;
39
40			/** @var FoundRows */
41			protected $foundRows;
42
43			/**
44			* ApiAbstract constructor.
45			*
46			* @param LoggerInterface $logger
47			* @param RepoServiceAbstract $repoService
48			* @param FoundRows $foundRows
49			* @param ConfigProvider $configProvider
50			*/
51			public function __construct(
52			LoggerInterface $logger,
53			RepoServiceAbstract $repoService,
54			FoundRows $foundRows,
55			ConfigProvider $configProvider
56			) {
57			$this->logger = $logger;
58			$this->repoService = $repoService;
			0 ignored issues – show Documentation Bug introduced 2019-06-21 19:32 UTC by Report Bug Copy Issue Report It seems like `$repoService` of type `AbterPhp\Framework\Http\...ute\RepoServiceAbstract` is incompatible with the declared type `AbterPhp\Framework\Http\Controllers\RepoService` of property `$repoService`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
59			$this->foundRows = $foundRows;
60			$this->problemBaseUrl = $configProvider->getProblemBaseUrl();
61			}
62
63			/**
64			* @param string $entityId
65			*
66			* @return Response
67			*/
68			public function get(string $entityId): Response
69			{
70			try {
71			$entity = $this->repoService->retrieveEntity($entityId);
72			} catch (\Exception $e) {
73			$msg = sprintf(static::LOG_MSG_GET_FAILURE, static::ENTITY_SINGULAR, $entityId);
74
75			return $this->handleException($msg, $e);
76			}
77
78			return $this->handleGetSuccess($entity);
79			}
80
81			/**
82			* @return Response
83			*/
84			public function list(): Response
85			{
86			$query = $this->request->getQuery();
87
88			$offset = (int)$query->get('offset', 0);
89			$limit = (int)$query->get('limit', 100);
90
91			try {
92			$entities = $this->repoService->retrieveList($offset, $limit, [], [], []);
93			} catch (\Exception $e) {
94			$msg = sprintf(static::LOG_MSG_LIST_FAILURE, static::ENTITY_PLURAL);
95
96			return $this->handleException($msg, $e);
97			}
98
99			$maxCount = $this->foundRows->get();
100
101			return $this->handleListSuccess($entities, $maxCount);
102			}
103
104			/**
105			* @return Response
106			*/
107			public function create(): Response
108			{
109			try {
110			$data = $this->getCreateData();
111
112			$errors = $this->repoService->validateForm($data);
113
114			if (count($errors) > 0) {
115			$msg = sprintf(static::LOG_MSG_CREATE_FAILURE, static::ENTITY_SINGULAR);
116
117			return $this->handleErrors($msg, $errors);
118			}
119
120			$fileData = $this->getFileData($data);
121			$entity = $this->repoService->create($data, $fileData);
122			} catch (\Exception $e) {
123			$msg = sprintf(static::LOG_MSG_CREATE_FAILURE, static::ENTITY_SINGULAR);
124
125			return $this->handleException($msg, $e);
126			}
127
128			return $this->handleCreateSuccess($entity);
129			}
130
131			/**
132			* @param string $entityId
133			*
134			* @return Response
135			*/
136			public function update(string $entityId): Response
137			{
138			try {
139			$data = $this->getUpdateData();
140
141			$errors = $this->repoService->validateForm($data);
142
143			if (count($errors) > 0) {
144			$msg = sprintf(static::LOG_MSG_UPDATE_FAILURE, static::ENTITY_SINGULAR, $entityId);
145
146			return $this->handleErrors($msg, $errors);
147			}
148
149			$fileData = $this->getFileData($data);
150			$entity = $this->repoService->retrieveEntity($entityId);
151			$this->repoService->update($entity, $data, $fileData);
152			} catch (\Exception $e) {
153			if ($this->isEntityNotFound($e)) {
154			return $this->handleNotFound();
155			}
156
157			$msg = sprintf(static::LOG_MSG_UPDATE_FAILURE, static::ENTITY_SINGULAR, $entityId);
158
159			return $this->handleException($msg, $e);
160			}
161
162			return $this->handleUpdateSuccess($entity);
163			}
164
165			/**
166			* @param string $entityId
167			*
168			* @return Response
169			*/
170			public function delete(string $entityId): Response
171			{
172			try {
173			$entity = $this->repoService->retrieveEntity($entityId);
174			$this->repoService->delete($entity);
175			} catch (\Exception $e) {
176			if ($this->isEntityNotFound($e)) {
177			return $this->handleNotFound();
178			}
179
180			$msg = sprintf(static::LOG_MSG_DELETE_FAILURE, static::ENTITY_SINGULAR, $entityId);
181
182			return $this->handleException($msg, $e);
183			}
184
185			return $this->handleDeleteSuccess();
186			}
187
188			/**
189			* @param \Exception $e
190			*
191			* @return bool
192			*/
193			protected function isEntityNotFound(\Exception $e): bool
194			{
195			if (!($e instanceof OrmException)) {
196			return false;
197			}
198
199			return $e->getMessage() === 'Failed to find entity';
200			}
201			}
202

abterphp / framework

Push — master ( 64da52...b1a7d7 )

ApiAbstract::handleException() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like