@frontastic/common 2.48.3 → 2.48.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/composer.json +3 -2
  3. package/docs/README.md +50 -0
  4. package/docs/php/AccountApiBundle/Command/CreateAccountCommand.md +1 -1
  5. package/docs/php/AccountApiBundle/Controller/LegacyAccountAuthController.md +2 -2
  6. package/docs/php/CoreBundle/Domain/Mailer/SwiftMail.md +2 -2
  7. package/docs/php/CoreBundle/EventListener/JsonExceptionListener.md +2 -2
  8. package/docs/php/CoreBundle/EventListener/JsonViewListener.md +2 -2
  9. package/docs/php/DevelopmentBundle/EventListener/BrowserConsoleDebuggerListener.md +2 -2
  10. package/docs/php/Mvc/EventDispatcher/EventDispatcher.md +40 -0
  11. package/docs/php/Mvc/Exception/FormAlreadyHandledException.md +25 -0
  12. package/docs/php/Mvc/Exception/NoFormHandledException.md +19 -0
  13. package/docs/php/Mvc/Exception/UnauthenticatedUserException.md +7 -0
  14. package/docs/php/Mvc/Flash.md +30 -0
  15. package/docs/php/Mvc/Form/InvalidFormRequest.md +88 -0
  16. package/docs/php/Mvc/Form/ValidFormRequest.md +103 -0
  17. package/docs/php/Mvc/FormRequest.md +86 -0
  18. package/docs/php/Mvc/Headers.md +27 -0
  19. package/docs/php/Mvc/RedirectRoute.md +63 -0
  20. package/docs/php/Mvc/TemplateView.md +65 -0
  21. package/docs/php/Mvc/TokenContext.md +124 -0
  22. package/docs/php/Mvc/ViewStruct.md +56 -0
  23. package/docs/php/MvcBundle/Controller/GyroControllerNameParser.md +38 -0
  24. package/docs/php/MvcBundle/Controller/ResultConverter/ArrayToTemplateResponseConverter.md +64 -0
  25. package/docs/php/MvcBundle/Controller/ResultConverter/ControllerResultConverter.md +40 -0
  26. package/docs/php/MvcBundle/Controller/ResultConverter/ControllerYieldApplier.md +42 -0
  27. package/docs/php/MvcBundle/Controller/ResultConverter/CookieYieldApplier.md +44 -0
  28. package/docs/php/MvcBundle/Controller/ResultConverter/FlashYieldApplier.md +44 -0
  29. package/docs/php/MvcBundle/Controller/ResultConverter/HeadersYieldApplier.md +44 -0
  30. package/docs/php/MvcBundle/Controller/ResultConverter/RedirectConverter.md +57 -0
  31. package/docs/php/MvcBundle/DependencyInjection/CompatibleTreeBuilder.md +32 -0
  32. package/docs/php/MvcBundle/DependencyInjection/Configuration.md +22 -0
  33. package/docs/php/MvcBundle/DependencyInjection/FrontasticCommonMvcExtension.md +32 -0
  34. package/docs/php/MvcBundle/EventListener/ConvertExceptionListener.md +40 -0
  35. package/docs/php/MvcBundle/EventListener/ParamConverterListener.md +42 -0
  36. package/docs/php/MvcBundle/EventListener/ViewListener.md +53 -0
  37. package/docs/php/MvcBundle/FrontasticCommonMvcBundle.md +7 -0
  38. package/docs/php/MvcBundle/MockTokenContext.md +137 -0
  39. package/docs/php/MvcBundle/ParamConverter/ServiceProvider.md +35 -0
  40. package/docs/php/MvcBundle/ParamConverter/SymfonyServiceProvider.md +56 -0
  41. package/docs/php/MvcBundle/Request/SymfonyFormRequest.md +105 -0
  42. package/docs/php/MvcBundle/SymfonyTokenContext.md +143 -0
  43. package/docs/php/MvcBundle/Versions.md +17 -0
  44. package/docs/php/MvcBundle/View/BundleLocation.md +38 -0
  45. package/docs/php/MvcBundle/View/SymfonyConventionsTemplateGuesser.md +48 -0
  46. package/docs/php/MvcBundle/View/TemplateGuesser.md +31 -0
  47. package/docs/php/ReplicatorBundle/Domain/Customer.md +0 -1
  48. package/docs/php/SpecificationBundle/Domain/SchemaFieldTypes.md +5 -0
  49. package/package.json +1 -1
  50. package/src/json/library/common.json +2 -1
  51. package/src/json/masterPageSchemaSchema.json +3 -0
package/CHANGELOG.md CHANGED
@@ -1,4 +1,10 @@
1
1
 
2
+ ## Version 2.48.4 (2024-05-02)
3
+
4
+ ** New Features and Improvements **
5
+
6
+ - Add compatibility with Guzzle version 7
7
+
2
8
  ## Version 2.48.3 (2024-01-11)
3
9
 
4
10
  ** New Features and Improvements **
package/composer.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "frontastic/common",
3
3
  "license": "None",
4
- "version": "2.48.3",
4
+ "version": "2.48.4",
5
5
  "repositories": [
6
6
  {
7
7
  "type": "path",
@@ -26,7 +26,8 @@
26
26
  "composer/package-versions-deprecated": "@stable",
27
27
  "contentful/contentful": "^6.0|^7.0",
28
28
  "domnikl/statsd": "^2.6",
29
- "guzzlehttp/guzzle": "^6.3",
29
+ "guzzlehttp/guzzle": "^6.3||^7",
30
+ "guzzlehttp/promises": "^1.0",
30
31
  "justinrainbow/json-schema": "@stable",
31
32
  "frontastic/data-object": "@stable",
32
33
  "league/oauth2-client": "^2.3",
package/docs/README.md CHANGED
@@ -195,6 +195,55 @@ Here you find the API documentation for the relevant classes:
195
195
  * JsonSerializer
196
196
  * [ObjectEnhancer](php/JsonSerializer/ObjectEnhancer.md)
197
197
  * [Kernel](php/Kernel.md)
198
+ * Mvc
199
+ * EventDispatcher
200
+ * [EventDispatcher](php/Mvc/EventDispatcher/EventDispatcher.md)
201
+ * Exception
202
+ * [FormAlreadyHandledException](php/Mvc/Exception/FormAlreadyHandledException.md)
203
+ * [NoFormHandledException](php/Mvc/Exception/NoFormHandledException.md)
204
+ * [UnauthenticatedUserException](php/Mvc/Exception/UnauthenticatedUserException.md)
205
+ * [Flash](php/Mvc/Flash.md)
206
+ * Form
207
+ * [InvalidFormRequest](php/Mvc/Form/InvalidFormRequest.md)
208
+ * [ValidFormRequest](php/Mvc/Form/ValidFormRequest.md)
209
+ * [FormRequest](php/Mvc/FormRequest.md)
210
+ * [Headers](php/Mvc/Headers.md)
211
+ * [RedirectRoute](php/Mvc/RedirectRoute.md)
212
+ * [TemplateView](php/Mvc/TemplateView.md)
213
+ * [TokenContext](php/Mvc/TokenContext.md)
214
+ * [ViewStruct](php/Mvc/ViewStruct.md)
215
+ * MvcBundle
216
+ * Controller
217
+ * [GyroControllerNameParser](php/MvcBundle/Controller/GyroControllerNameParser.md)
218
+ * ResultConverter
219
+ * [ArrayToTemplateResponseConverter](php/MvcBundle/Controller/ResultConverter/ArrayToTemplateResponseConverter.md)
220
+ * [ControllerResultConverter](php/MvcBundle/Controller/ResultConverter/ControllerResultConverter.md)
221
+ * [ControllerYieldApplier](php/MvcBundle/Controller/ResultConverter/ControllerYieldApplier.md)
222
+ * [CookieYieldApplier](php/MvcBundle/Controller/ResultConverter/CookieYieldApplier.md)
223
+ * [FlashYieldApplier](php/MvcBundle/Controller/ResultConverter/FlashYieldApplier.md)
224
+ * [HeadersYieldApplier](php/MvcBundle/Controller/ResultConverter/HeadersYieldApplier.md)
225
+ * [RedirectConverter](php/MvcBundle/Controller/ResultConverter/RedirectConverter.md)
226
+ * DependencyInjection
227
+ * [CompatibleTreeBuilder](php/MvcBundle/DependencyInjection/CompatibleTreeBuilder.md)
228
+ * [Configuration](php/MvcBundle/DependencyInjection/Configuration.md)
229
+ * [FrontasticCommonMvcExtension](php/MvcBundle/DependencyInjection/FrontasticCommonMvcExtension.md)
230
+ * EventListener
231
+ * [ConvertExceptionListener](php/MvcBundle/EventListener/ConvertExceptionListener.md)
232
+ * [ParamConverterListener](php/MvcBundle/EventListener/ParamConverterListener.md)
233
+ * [ViewListener](php/MvcBundle/EventListener/ViewListener.md)
234
+ * [FrontasticCommonMvcBundle](php/MvcBundle/FrontasticCommonMvcBundle.md)
235
+ * [MockTokenContext](php/MvcBundle/MockTokenContext.md)
236
+ * ParamConverter
237
+ * [ServiceProvider](php/MvcBundle/ParamConverter/ServiceProvider.md)
238
+ * [SymfonyServiceProvider](php/MvcBundle/ParamConverter/SymfonyServiceProvider.md)
239
+ * Request
240
+ * [SymfonyFormRequest](php/MvcBundle/Request/SymfonyFormRequest.md)
241
+ * [SymfonyTokenContext](php/MvcBundle/SymfonyTokenContext.md)
242
+ * [Versions](php/MvcBundle/Versions.md)
243
+ * View
244
+ * [BundleLocation](php/MvcBundle/View/BundleLocation.md)
245
+ * [SymfonyConventionsTemplateGuesser](php/MvcBundle/View/SymfonyConventionsTemplateGuesser.md)
246
+ * [TemplateGuesser](php/MvcBundle/View/TemplateGuesser.md)
198
247
  * ProductApiBundle
199
248
  * Controller
200
249
  * [LegacyCategoryController](php/ProductApiBundle/Controller/LegacyCategoryController.md)
@@ -387,6 +436,7 @@ Here you find the API documentation for the relevant classes:
387
436
  * [GroupFieldConfiguration](php/SpecificationBundle/Domain/Schema/GroupFieldConfiguration.md)
388
437
  * [StreamFieldConfiguration](php/SpecificationBundle/Domain/Schema/StreamFieldConfiguration.md)
389
438
  * [SchemaError](php/SpecificationBundle/Domain/SchemaError.md)
439
+ * [SchemaFieldTypes](php/SpecificationBundle/Domain/SchemaFieldTypes.md)
390
440
  * [SpecParser](php/SpecificationBundle/Domain/SpecParser.md)
391
441
  * [TasticSpecParser](php/SpecificationBundle/Domain/TasticSpecParser.md)
392
442
  * [ValidatingSpecParser](php/SpecificationBundle/Domain/ValidatingSpecParser.md)
@@ -2,6 +2,6 @@
2
2
 
3
3
  **Fully Qualified**: [`\Frontastic\Common\AccountApiBundle\Command\CreateAccountCommand`](../../../../src/php/AccountApiBundle/Command/CreateAccountCommand.php)
4
4
 
5
- **Extends**: `\Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand`
5
+ **Extends**: `\Symfony\Component\Console\Command\Command`
6
6
 
7
7
  Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -69,14 +69,14 @@ Return Value: `\Symfony\Component\HttpFoundation\Response`
69
69
  ```php
70
70
  public function requestResetAction(
71
71
  \Symfony\Component\HttpFoundation\Request $request
72
- ): \QafooLabs\MVC\RedirectRoute
72
+ ): RedirectRoute
73
73
  ```
74
74
 
75
75
  Argument|Type|Default|Description
76
76
  --------|----|-------|-----------
77
77
  `$request`|`\Symfony\Component\HttpFoundation\Request`||
78
78
 
79
- Return Value: `\QafooLabs\MVC\RedirectRoute`
79
+ Return Value: [`RedirectRoute`](../../Mvc/RedirectRoute.md)
80
80
 
81
81
  ### resetAction()
82
82
 
@@ -14,7 +14,7 @@
14
14
  ```php
15
15
  public function __construct(
16
16
  \Swift_Mailer $mailer,
17
- \Symfony\Component\Templating\EngineInterface $twig,
17
+ \Twig\Environment $twig,
18
18
  string $sender = 'support@frontastic.io'
19
19
  ): mixed
20
20
  ```
@@ -22,7 +22,7 @@ public function __construct(
22
22
  Argument|Type|Default|Description
23
23
  --------|----|-------|-----------
24
24
  `$mailer`|`\Swift_Mailer`||
25
- `$twig`|`\Symfony\Component\Templating\EngineInterface`||
25
+ `$twig`|`\Twig\Environment`||
26
26
  `$sender`|`string`|`'support@frontastic.io'`|
27
27
 
28
28
  Return Value: `mixed`
@@ -25,13 +25,13 @@ Return Value: `mixed`
25
25
 
26
26
  ```php
27
27
  public function onKernelException(
28
- \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent $event
28
+ \Symfony\Component\HttpKernel\Event\ExceptionEvent $event
29
29
  ): mixed
30
30
  ```
31
31
 
32
32
  Argument|Type|Default|Description
33
33
  --------|----|-------|-----------
34
- `$event`|`\Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent`||
34
+ `$event`|`\Symfony\Component\HttpKernel\Event\ExceptionEvent`||
35
35
 
36
36
  Return Value: `mixed`
37
37
 
@@ -25,13 +25,13 @@ Return Value: `mixed`
25
25
 
26
26
  ```php
27
27
  public function onKernelView(
28
- \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $event
28
+ \Symfony\Component\HttpKernel\Event\ViewEvent $event
29
29
  ): mixed
30
30
  ```
31
31
 
32
32
  Argument|Type|Default|Description
33
33
  --------|----|-------|-----------
34
- `$event`|`\Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent`||
34
+ `$event`|`\Symfony\Component\HttpKernel\Event\ViewEvent`||
35
35
 
36
36
  Return Value: `mixed`
37
37
 
@@ -25,13 +25,13 @@ Return Value: `mixed`
25
25
 
26
26
  ```php
27
27
  public function onKernelResponse(
28
- \Symfony\Component\HttpKernel\Event\FilterResponseEvent $event
28
+ \Symfony\Component\HttpKernel\Event\ResponseEvent $event
29
29
  ): mixed
30
30
  ```
31
31
 
32
32
  Argument|Type|Default|Description
33
33
  --------|----|-------|-----------
34
- `$event`|`\Symfony\Component\HttpKernel\Event\FilterResponseEvent`||
34
+ `$event`|`\Symfony\Component\HttpKernel\Event\ResponseEvent`||
35
35
 
36
36
  Return Value: `mixed`
37
37
 
@@ -0,0 +1,40 @@
1
+ # EventDispatcher
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\EventDispatcher\EventDispatcher`](../../../../src/php/Mvc/EventDispatcher/EventDispatcher.php)
4
+
5
+ ## Methods
6
+
7
+ * [__construct()](#__construct)
8
+ * [dispatch()](#dispatch)
9
+
10
+ ### __construct()
11
+
12
+ ```php
13
+ public function __construct(
14
+ \Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher
15
+ ): mixed
16
+ ```
17
+
18
+ Argument|Type|Default|Description
19
+ --------|----|-------|-----------
20
+ `$eventDispatcher`|`\Symfony\Component\EventDispatcher\EventDispatcherInterface`||
21
+
22
+ Return Value: `mixed`
23
+
24
+ ### dispatch()
25
+
26
+ ```php
27
+ public function dispatch(
28
+ object $event,
29
+ ?string $eventName = null
30
+ ): void
31
+ ```
32
+
33
+ Argument|Type|Default|Description
34
+ --------|----|-------|-----------
35
+ `$event`|`object`||
36
+ `$eventName`|`?string`|`null`|
37
+
38
+ Return Value: `void`
39
+
40
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,25 @@
1
+ # FormAlreadyHandledException
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\Exception\FormAlreadyHandledException`](../../../../src/php/Mvc/Exception/FormAlreadyHandledException.php)
4
+
5
+ **Extends**: `\RuntimeException`
6
+
7
+ ## Methods
8
+
9
+ * [__construct()](#__construct)
10
+
11
+ ### __construct()
12
+
13
+ ```php
14
+ public function __construct(
15
+ ?string $name
16
+ ): mixed
17
+ ```
18
+
19
+ Argument|Type|Default|Description
20
+ --------|----|-------|-----------
21
+ `$name`|`?string`||
22
+
23
+ Return Value: `mixed`
24
+
25
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,19 @@
1
+ # NoFormHandledException
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\Exception\NoFormHandledException`](../../../../src/php/Mvc/Exception/NoFormHandledException.php)
4
+
5
+ **Extends**: `\RuntimeException`
6
+
7
+ ## Methods
8
+
9
+ * [__construct()](#__construct)
10
+
11
+ ### __construct()
12
+
13
+ ```php
14
+ public function __construct(): mixed
15
+ ```
16
+
17
+ Return Value: `mixed`
18
+
19
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,7 @@
1
+ # UnauthenticatedUserException
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\Exception\UnauthenticatedUserException`](../../../../src/php/Mvc/Exception/UnauthenticatedUserException.php)
4
+
5
+ **Extends**: `\Exception`
6
+
7
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,30 @@
1
+ # Flash
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\Flash`](../../../src/php/Mvc/Flash.php)
4
+
5
+ Property|Type|Default|Required|Description
6
+ --------|----|-------|--------|-----------
7
+ `type` | `string` | | - |
8
+ `message` | `string` | | - |
9
+
10
+ ## Methods
11
+
12
+ * [__construct()](#__construct)
13
+
14
+ ### __construct()
15
+
16
+ ```php
17
+ public function __construct(
18
+ string $type,
19
+ string $message
20
+ ): mixed
21
+ ```
22
+
23
+ Argument|Type|Default|Description
24
+ --------|----|-------|-----------
25
+ `$type`|`string`||
26
+ `$message`|`string`||
27
+
28
+ Return Value: `mixed`
29
+
30
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,88 @@
1
+ # InvalidFormRequest
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\Form\InvalidFormRequest`](../../../../src/php/Mvc/Form/InvalidFormRequest.php)
4
+
5
+ **Implements**: [`FormRequest`](../FormRequest.md)
6
+
7
+ ## Methods
8
+
9
+ * [handle()](#handle)
10
+ * [getValidData()](#getvaliddata)
11
+ * [isValid()](#isvalid)
12
+ * [isBound()](#isbound)
13
+ * [getForm()](#getform)
14
+ * [createFormView()](#createformview)
15
+
16
+ ### handle()
17
+
18
+ ```php
19
+ public function handle(
20
+ string $formType,
21
+ mixed $bindData = null,
22
+ array $options = []
23
+ ): bool
24
+ ```
25
+
26
+ *Attempt to handle a form and return true when handled and data is valid.*
27
+
28
+ Argument|Type|Default|Description
29
+ --------|----|-------|-----------
30
+ `$formType`|`string`||
31
+ `$bindData`|`mixed`|`null`|
32
+ `$options`|`array`|`[]`|
33
+
34
+ Return Value: `bool`
35
+
36
+ ### getValidData()
37
+
38
+ ```php
39
+ public function getValidData(): mixed
40
+ ```
41
+
42
+ *Use this to retrieve the validated data from the form even when you attached `$bindData`.*
43
+
44
+ Only by using this method you can mock the form handling by providing a replacement valid value in tests.
45
+
46
+ Return Value: `mixed`
47
+
48
+ ### isValid()
49
+
50
+ ```php
51
+ public function isValid(): bool
52
+ ```
53
+
54
+ *Is the bound form valid?*
55
+
56
+ Return Value: `bool`
57
+
58
+ ### isBound()
59
+
60
+ ```php
61
+ public function isBound(): bool
62
+ ```
63
+
64
+ *Is the request bound to a form?*
65
+
66
+ Return Value: `bool`
67
+
68
+ ### getForm()
69
+
70
+ ```php
71
+ public function getForm(): \Symfony\Component\Form\FormInterface
72
+ ```
73
+
74
+ Return Value: `\Symfony\Component\Form\FormInterface`
75
+
76
+ ### createFormView()
77
+
78
+ ```php
79
+ public function createFormView(): \Symfony\Component\Form\FormView
80
+ ```
81
+
82
+ *Create the form view for the handled form.*
83
+
84
+ Throws exception when no form was handled yet.
85
+
86
+ Return Value: `\Symfony\Component\Form\FormView`
87
+
88
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,103 @@
1
+ # ValidFormRequest
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\Form\ValidFormRequest`](../../../../src/php/Mvc/Form/ValidFormRequest.php)
4
+
5
+ **Implements**: [`FormRequest`](../FormRequest.md)
6
+
7
+ ## Methods
8
+
9
+ * [__construct()](#__construct)
10
+ * [handle()](#handle)
11
+ * [getValidData()](#getvaliddata)
12
+ * [isValid()](#isvalid)
13
+ * [isBound()](#isbound)
14
+ * [getForm()](#getform)
15
+ * [createFormView()](#createformview)
16
+
17
+ ### __construct()
18
+
19
+ ```php
20
+ public function __construct(
21
+ mixed $validData
22
+ ): mixed
23
+ ```
24
+
25
+ Argument|Type|Default|Description
26
+ --------|----|-------|-----------
27
+ `$validData`|`mixed`||
28
+
29
+ Return Value: `mixed`
30
+
31
+ ### handle()
32
+
33
+ ```php
34
+ public function handle(
35
+ string $formType,
36
+ mixed $bindData = null,
37
+ array $options = []
38
+ ): bool
39
+ ```
40
+
41
+ *Attempt to handle a form and return true when handled and data is valid.*
42
+
43
+ Argument|Type|Default|Description
44
+ --------|----|-------|-----------
45
+ `$formType`|`string`||
46
+ `$bindData`|`mixed`|`null`|
47
+ `$options`|`array`|`[]`|
48
+
49
+ Return Value: `bool`
50
+
51
+ ### getValidData()
52
+
53
+ ```php
54
+ public function getValidData(): mixed
55
+ ```
56
+
57
+ *Use this to retrieve the validated data from the form even when you attached `$bindData`.*
58
+
59
+ Only by using this method you can mock the form handling by providing a replacement valid value in tests.
60
+
61
+ Return Value: `mixed`
62
+
63
+ ### isValid()
64
+
65
+ ```php
66
+ public function isValid(): bool
67
+ ```
68
+
69
+ *Is the bound form valid?*
70
+
71
+ Return Value: `bool`
72
+
73
+ ### isBound()
74
+
75
+ ```php
76
+ public function isBound(): bool
77
+ ```
78
+
79
+ *Is the request bound to a form?*
80
+
81
+ Return Value: `bool`
82
+
83
+ ### getForm()
84
+
85
+ ```php
86
+ public function getForm(): \Symfony\Component\Form\FormInterface
87
+ ```
88
+
89
+ Return Value: `\Symfony\Component\Form\FormInterface`
90
+
91
+ ### createFormView()
92
+
93
+ ```php
94
+ public function createFormView(): \Symfony\Component\Form\FormView
95
+ ```
96
+
97
+ *Create the form view for the handled form.*
98
+
99
+ Throws exception when no form was handled yet.
100
+
101
+ Return Value: `\Symfony\Component\Form\FormView`
102
+
103
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,86 @@
1
+ # `interface` FormRequest
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\FormRequest`](../../../src/php/Mvc/FormRequest.php)
4
+
5
+ ## Methods
6
+
7
+ * [handle()](#handle)
8
+ * [getValidData()](#getvaliddata)
9
+ * [isValid()](#isvalid)
10
+ * [isBound()](#isbound)
11
+ * [getForm()](#getform)
12
+ * [createFormView()](#createformview)
13
+
14
+ ### handle()
15
+
16
+ ```php
17
+ public function handle(
18
+ string $formType,
19
+ mixed $bindData = null,
20
+ array $options = []
21
+ ): bool
22
+ ```
23
+
24
+ *Attempt to handle a form and return true when handled and data is valid.*
25
+
26
+ Argument|Type|Default|Description
27
+ --------|----|-------|-----------
28
+ `$formType`|`string`||
29
+ `$bindData`|`mixed`|`null`|
30
+ `$options`|`array`|`[]`|
31
+
32
+ Return Value: `bool`
33
+
34
+ ### getValidData()
35
+
36
+ ```php
37
+ public function getValidData(): mixed
38
+ ```
39
+
40
+ *Use this to retrieve the validated data from the form even when you attached `$bindData`.*
41
+
42
+ Only by using this method you can mock the form handling by providing a replacement valid value in tests.
43
+
44
+ Return Value: `mixed`
45
+
46
+ ### isValid()
47
+
48
+ ```php
49
+ public function isValid(): bool
50
+ ```
51
+
52
+ *Is the bound form valid?*
53
+
54
+ Return Value: `bool`
55
+
56
+ ### isBound()
57
+
58
+ ```php
59
+ public function isBound(): bool
60
+ ```
61
+
62
+ *Is the request bound to a form?*
63
+
64
+ Return Value: `bool`
65
+
66
+ ### getForm()
67
+
68
+ ```php
69
+ public function getForm(): \Symfony\Component\Form\FormInterface
70
+ ```
71
+
72
+ Return Value: `\Symfony\Component\Form\FormInterface`
73
+
74
+ ### createFormView()
75
+
76
+ ```php
77
+ public function createFormView(): ?\Symfony\Component\Form\FormView
78
+ ```
79
+
80
+ *Create the form view for the handled form.*
81
+
82
+ Throws exception when no form was handled yet.
83
+
84
+ Return Value: `?\Symfony\Component\Form\FormView`
85
+
86
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,27 @@
1
+ # Headers
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\Headers`](../../../src/php/Mvc/Headers.php)
4
+
5
+ Property|Type|Default|Required|Description
6
+ --------|----|-------|--------|-----------
7
+ `values` | `array<string, string>` | `[]` | - |
8
+
9
+ ## Methods
10
+
11
+ * [__construct()](#__construct)
12
+
13
+ ### __construct()
14
+
15
+ ```php
16
+ public function __construct(
17
+ array $values
18
+ ): mixed
19
+ ```
20
+
21
+ Argument|Type|Default|Description
22
+ --------|----|-------|-----------
23
+ `$values`|`array`||
24
+
25
+ Return Value: `mixed`
26
+
27
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).
@@ -0,0 +1,63 @@
1
+ # RedirectRoute
2
+
3
+ **Fully Qualified**: [`\Frontastic\Common\Mvc\RedirectRoute`](../../../src/php/Mvc/RedirectRoute.php)
4
+
5
+ ## Methods
6
+
7
+ * [__construct()](#__construct)
8
+ * [getRouteName()](#getroutename)
9
+ * [getParameters()](#getparameters)
10
+ * [getResponse()](#getresponse)
11
+ * [getStatusCode()](#getstatuscode)
12
+
13
+ ### __construct()
14
+
15
+ ```php
16
+ public function __construct(
17
+ string $routeName,
18
+ array $parameters = [],
19
+ mixed $response = null
20
+ ): mixed
21
+ ```
22
+
23
+ Argument|Type|Default|Description
24
+ --------|----|-------|-----------
25
+ `$routeName`|`string`||
26
+ `$parameters`|`array`|`[]`|
27
+ `$response`|`mixed`|`null`|
28
+
29
+ Return Value: `mixed`
30
+
31
+ ### getRouteName()
32
+
33
+ ```php
34
+ public function getRouteName(): string
35
+ ```
36
+
37
+ Return Value: `string`
38
+
39
+ ### getParameters()
40
+
41
+ ```php
42
+ public function getParameters(): array
43
+ ```
44
+
45
+ Return Value: `array`
46
+
47
+ ### getResponse()
48
+
49
+ ```php
50
+ public function getResponse(): ?\Symfony\Component\HttpFoundation\Response
51
+ ```
52
+
53
+ Return Value: `?\Symfony\Component\HttpFoundation\Response`
54
+
55
+ ### getStatusCode()
56
+
57
+ ```php
58
+ public function getStatusCode(): int
59
+ ```
60
+
61
+ Return Value: `int`
62
+
63
+ Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).