Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
82.22%
37 / 45
77.78%
7 / 9
 CRAP
0.00%
0 / 1
RemoveObjectAction
82.22%
37 / 45
77.78%
7 / 9
 24.72
0.00%
0 / 1
 __construct
100.00%
1 / 1
100.00%
1 / 1
 1
 isAuthorized
71.43%
10 / 14
0.00%
0 / 1
 15.36
 __invoke
75.00%
12 / 16
0.00%
0 / 1
 3.14
 getInputType
100.00%
1 / 1
100.00%
1 / 1
 1
 getOutputType
100.00%
1 / 1
100.00%
1 / 1
 1
 getPossibleActionResponseStatuses
100.00%
5 / 5
100.00%
1 / 1
 1
 getDescription
100.00%
1 / 1
100.00%
1 / 1
 1
 getTags
100.00%
1 / 1
100.00%
1 / 1
 1
 getRouteAttributes
100.00%
5 / 5
100.00%
1 / 1
 1
1<?php
2namespace Apie\Common\Actions;
3
4use Apie\Common\IntegrationTestLogger;
5use Apie\Core\Actions\ActionInterface;
6use Apie\Core\Actions\ActionResponse;
7use Apie\Core\Actions\ActionResponseStatus;
8use Apie\Core\Actions\ActionResponseStatusList;
9use Apie\Core\Actions\ApieFacadeInterface;
10use Apie\Core\Attributes\RemovalCheck;
11use Apie\Core\BoundedContext\BoundedContextId;
12use Apie\Core\Context\ApieContext;
13use Apie\Core\ContextConstants;
14use Apie\Core\Entities\EntityInterface;
15use Apie\Core\Exceptions\EntityNotFoundException;
16use Apie\Core\Exceptions\InvalidTypeException;
17use Apie\Core\IdentifierUtils;
18use Apie\Core\Lists\StringList;
19use Apie\Core\Utils\EntityUtils;
20use Apie\Core\ValueObjects\Exceptions\InvalidStringForValueObjectException;
21use LogicException;
22use ReflectionClass;
23
24/**
25 * Action to remove an existing object.
26 */
27final class RemoveObjectAction implements ActionInterface
28{
29    public function __construct(private readonly ApieFacadeInterface $apieFacade)
30    {
31    }
32
33    public static function isAuthorized(ApieContext $context, bool $runtimeChecks, bool $throwError = false): bool
34    {
35        $refl = new ReflectionClass($context->getContext(ContextConstants::RESOURCE_NAME, $throwError));
36        if (EntityUtils::isPolymorphicEntity($refl) && $runtimeChecks && $context->hasContext(ContextConstants::RESOURCE)) {
37            $refl = new ReflectionClass($context->getContext(ContextConstants::RESOURCE, $throwError));
38        }
39        if (!$context->appliesToContext($refl, $runtimeChecks, $throwError ? new LogicException('Class does not allow it') : null)) {
40            return false;
41        }
42        $returnValue = false;
43        foreach ($refl->getAttributes(RemovalCheck::class) as $removeAttribute) {
44            $returnValue = true;
45            $removeCheck = $removeAttribute->newInstance();
46            if ($removeCheck->isStaticCheck() && !$removeCheck->applies($context)) {
47                return false;
48            }
49            if ($runtimeChecks && $removeCheck->isRuntimeCheck() && !$removeCheck->applies($context)) {
50                return false;
51            }
52        }
53        return $returnValue;
54    }
55    
56    /**
57     * @param array<string|int, mixed> $rawContents
58     */
59    public function __invoke(ApieContext $context, array $rawContents): ActionResponse
60    {
61        $context->withContext(ContextConstants::APIE_ACTION, __CLASS__)->checkAuthorization();
62        $resourceClass = new ReflectionClass($context->getContext(ContextConstants::RESOURCE_NAME));
63        $id = $context->getContext(ContextConstants::RESOURCE_ID);
64        if (!$resourceClass->implementsInterface(EntityInterface::class)) {
65            throw new InvalidTypeException($resourceClass->name, 'EntityInterface');
66        }
67        $boundedContextId = new BoundedContextId($context->getContext(ContextConstants::BOUNDED_CONTEXT_ID));
68        try {
69            $resource = $this->apieFacade->find(
70                IdentifierUtils::idStringToIdentifier($id, $context),
71                $boundedContextId
72            );
73        } catch (InvalidStringForValueObjectException|EntityNotFoundException $error) {
74            IntegrationTestLogger::logException($error);
75            return ActionResponse::createClientError($this->apieFacade, $context, $error);
76        }
77        $context = $context->withContext(ContextConstants::RESOURCE, $resource);
78        $this->apieFacade->removeExisting($resource, $boundedContextId);
79
80        return ActionResponse::createRemovedSuccess($this->apieFacade, $context);
81    }
82
83    /**
84     * @return ReflectionClass<EntityInterface>
85     */
86    public static function getInputType(ReflectionClass $class): ReflectionClass
87    {
88        return $class;
89    }
90
91    /**
92     * @return ReflectionClass<EntityInterface>
93     */
94    public static function getOutputType(ReflectionClass $class): ReflectionClass
95    {
96        return $class;
97    }
98
99    public static function getPossibleActionResponseStatuses(): ActionResponseStatusList
100    {
101        return new ActionResponseStatusList([
102            ActionResponseStatus::DELETED,
103            ActionResponseStatus::CLIENT_ERROR,
104            ActionResponseStatus::PERISTENCE_ERROR
105        ]);
106    }
107
108    /**
109     * @param ReflectionClass<object> $class
110     */
111    public static function getDescription(ReflectionClass $class): string
112    {
113        return 'Removes an instance of ' . $class->getShortName();
114    }
115    
116    /**
117     * @param ReflectionClass<object> $class
118     */
119    public static function getTags(ReflectionClass $class): StringList
120    {
121        return new StringList([$class->getShortName(), 'resource']);
122    }
123
124    /**
125     * @param ReflectionClass<object> $class
126     */
127    public static function getRouteAttributes(ReflectionClass $class): array
128    {
129        return [
130            ContextConstants::EDIT_OBJECT => true,
131            ContextConstants::RESOURCE_NAME => $class->name,
132            ContextConstants::DISPLAY_FORM => true,
133        ];
134    }
135}