Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
ContextConstants
n/a
0 / 0
n/a
0 / 0
1
n/a
0 / 0
 __construct
n/a
0 / 0
n/a
0 / 0
1
1<?php
2namespace Apie\Core;
3
4use Apie\Common\Actions\RunAction;
5use Apie\Common\Actions\RunItemMethodAction;
6use Apie\Core\Actions\HasRouteDefinition;
7use Apie\Core\Indexing\FromDateObject;
8use Apie\DoctrineEntityDatalayer\Query\RequiresPermissionFilter;
9
10/**
11 * Contains a list of context key constants as used for ApieContext and in route definitions (which are copied to
12 * ApieContext values).
13 */
14final class ContextConstants
15{
16    /**
17     * @codeCoverageIgnore
18     */
19    private function __construct()
20    {
21    }
22
23    /**
24     * ID of the selected bounded context.
25     */
26    public const BOUNDED_CONTEXT_ID = 'boundedContextId';
27    /**
28     * Name of resource entity. Used by getting and creating resources of a specific class.
29     */
30    public const RESOURCE_NAME = 'resourceName';
31
32    /**
33     * Id of resource. This one is often filled in the routing placeholder.
34     */
35    public const RESOURCE_ID = 'id';
36
37    /**
38     * Resource retrieved that we can apply actions to.
39     */
40    public const RESOURCE = 'resource';
41
42    /**
43     * Internal operation id of action used.
44     *
45     * @see HasRouteDefinition::getOperationId()
46     */
47    public const OPERATION_ID = 'operationId';
48
49    /**
50     * Internal class used for the Apie action.
51     */
52    public const APIE_ACTION = '_apie_action';
53
54    /**
55     * Used for running a specific method call.
56     * @see RunAction
57     */
58    public const SERVICE_CLASS = 'serviceClass';
59
60    /**
61     * Used for picking the right class of a method.
62     *
63     * @see RunItemMethodAction
64     */
65    public const METHOD_CLASS = 'methodClass';
66
67    /**
68     * Used for running a specific method call.
69     * @see RunAction
70     * @see RunItemMethodAction
71     */
72    public const METHOD_NAME = 'methodName';
73
74    /**
75     * Raw contents of POST body or GET parameters.
76     */
77    public const RAW_CONTENTS = 'raw-contents';
78
79    /**
80     * Last validation errors
81     */
82    public const VALIDATION_ERRORS = 'validation-errors';
83
84    /**
85     * Added if an OpenAPI spec is generated.
86     */
87    public const OPENAPI = 'openapi';
88
89    /**
90     * Added if a REST API call is done.
91     */
92    public const REST_API='rest';
93
94    /**
95     * Added if CMS request is done.
96     */
97    public const CMS='cms';
98
99    /**
100     * Added if serializing the profile fields in apie/cms
101     */
102    public const SHOW_PROFILE = 'show_profile';
103
104    public const CREATE_OBJECT = 'create';
105
106    public const REPLACE_OBJECT = 'replace';
107
108    public const EDIT_OBJECT = 'edit';
109
110    public const REMOVE_OBJECT = 'remove';
111
112    public const GET_ALL_OBJECTS = 'all';
113
114    public const GET_OBJECT = 'get';
115
116    public const RESOURCE_METHOD = 'resource-call';
117
118    public const GLOBAL_METHOD = 'method-call';
119
120    /**
121     * Disable context filter when using toPaginatedResult
122     *
123     * @see RequiresPermissionFilter
124     */
125    public const DISABLE_CONTEXT_FILTER = 'disable-context-filter';
126
127    /**
128     * @see FromDateObject
129     * @configured date formats for DateTime objects for indexing.
130     */
131    public const DATEFORMATS = 'date-formats';
132
133    /**
134     * Displays a form on this page.
135     */
136    public const DISPLAY_FORM = 'display-form';
137
138    public const AUTHENTICATED_USER = 'authenticated';
139
140    public const LOCALE = 'locale';
141
142    /**
143     * Used for workarounds with frameworks using middleware or events for authentication and redoing the controller
144     * again.
145     *
146     * @internal
147     */
148    public const ALREADY_CALCULATED = 'already_calculated';
149}