@frontastic/common 2.48.2 → 2.48.4

package/docs/php/MvcBundle/DependencyInjection/FrontasticCommonMvcExtension.md

@@ -0,0 +1,32 @@
+#  FrontasticCommonMvcExtension
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\DependencyInjection\FrontasticCommonMvcExtension`](../../../../src/php/MvcBundle/DependencyInjection/FrontasticCommonMvcExtension.php)
+
+**Extends**: `\Symfony\Component\HttpKernel\DependencyInjection\Extension`
+
+To learn more see {@link
+http://symfony.com/doc/current/cookbook/bundles/extension.html}
+
+## Methods
+
+* [load()](#load)
+
+### load()
+
+```php
+public function load(
+    array $configs,
+    \Symfony\Component\DependencyInjection\ContainerBuilder $container
+): void
+```
+
+*{@inheritDoc}*
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$configs`|`array`||
+`$container`|`\Symfony\Component\DependencyInjection\ContainerBuilder`||
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/EventListener/ConvertExceptionListener.md

@@ -0,0 +1,40 @@
+#  ConvertExceptionListener
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\EventListener\ConvertExceptionListener`](../../../../src/php/MvcBundle/EventListener/ConvertExceptionListener.php)
+
+## Methods
+
+* [__construct()](#__construct)
+* [onKernelException()](#onkernelexception)
+
+### __construct()
+
+```php
+public function __construct(
+    ?\Psr\Log\LoggerInterface $logger = null,
+    array $exceptionClassMap = []
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$logger`|`?\Psr\Log\LoggerInterface`|`null`|
+`$exceptionClassMap`|`array`|`[]`|
+
+Return Value: `mixed`
+
+### onKernelException()
+
+```php
+public function onKernelException(
+    mixed $event
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$event`|`mixed`||
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/EventListener/ParamConverterListener.md

@@ -0,0 +1,42 @@
+#  ParamConverterListener
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\EventListener\ParamConverterListener`](../../../../src/php/MvcBundle/EventListener/ParamConverterListener.php)
+
+This replicates the SensioFrameworkExtraBundle behavior but keeps it simple
+and without a dependency to allow usage outside Symfony Framework apps (Silex,
+..).
+
+## Methods
+
+* [__construct()](#__construct)
+* [onKernelController()](#onkernelcontroller)
+
+### __construct()
+
+```php
+public function __construct(
+    ServiceProvider $container
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$container`|[`ServiceProvider`](../ParamConverter/ServiceProvider.md)||
+
+Return Value: `mixed`
+
+### onKernelController()
+
+```php
+public function onKernelController(
+    \Symfony\Component\HttpKernel\Event\ControllerEvent $event
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$event`|`\Symfony\Component\HttpKernel\Event\ControllerEvent`||
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/EventListener/ViewListener.md

@@ -0,0 +1,53 @@
+#  ViewListener
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\EventListener\ViewListener`](../../../../src/php/MvcBundle/EventListener/ViewListener.php)
+
+## Methods
+
+* [addConverter()](#addconverter)
+* [addYieldApplier()](#addyieldapplier)
+* [onKernelView()](#onkernelview)
+
+### addConverter()
+
+```php
+public function addConverter(
+    ControllerResultConverter $converter
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$converter`|[`ControllerResultConverter`](../Controller/ResultConverter/ControllerResultConverter.md)||
+
+Return Value: `void`
+
+### addYieldApplier()
+
+```php
+public function addYieldApplier(
+    ControllerYieldApplier $applier
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$applier`|[`ControllerYieldApplier`](../Controller/ResultConverter/ControllerYieldApplier.md)||
+
+Return Value: `void`
+
+### onKernelView()
+
+```php
+public function onKernelView(
+    mixed $event
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$event`|`mixed`||
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/FrontasticCommonMvcBundle.md

@@ -0,0 +1,7 @@
+#  FrontasticCommonMvcBundle
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\FrontasticCommonMvcBundle`](../../../src/php/MvcBundle/FrontasticCommonMvcBundle.php)
+
+**Extends**: `\Symfony\Component\HttpKernel\Bundle\Bundle`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/MockTokenContext.md

@@ -0,0 +1,137 @@
+#  MockTokenContext
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\MockTokenContext`](../../../src/php/MvcBundle/MockTokenContext.php)
+
+**Implements**: [`TokenContext`](../Mvc/TokenContext.md)
+
+## Methods
+
+* [__construct()](#__construct)
+* [getCurrentUserId()](#getcurrentuserid)
+* [getCurrentUsername()](#getcurrentusername)
+* [getCurrentUser()](#getcurrentuser)
+* [hasToken()](#hastoken)
+* [hasNonAnonymousToken()](#hasnonanonymoustoken)
+* [getToken()](#gettoken)
+* [isGranted()](#isgranted)
+* [assertIsGranted()](#assertisgranted)
+
+### __construct()
+
+```php
+public function __construct(
+    \Symfony\Component\Security\Core\User\UserInterface $user = null
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$user`|`\Symfony\Component\Security\Core\User\UserInterface`|`null`|
+
+Return Value: `mixed`
+
+### getCurrentUserId()
+
+```php
+public function getCurrentUserId(): mixed
+```
+
+*If a security context and token exists, retrieve the user id.*
+
+Throws UnauthenticatedUserException when no valid token exists.
+
+Return Value: `mixed`
+
+### getCurrentUsername()
+
+```php
+public function getCurrentUsername(): string
+```
+
+*If a security context and token exists, retrieve the username.*
+
+Throws UnauthenticatedUserException when no valid token exists.
+
+Return Value: `string`
+
+### getCurrentUser()
+
+```php
+public function getCurrentUser(
+    string $expectedClass
+): \Symfony\Component\Security\Core\User\UserInterface
+```
+
+*Get the current User object*
+
+Throws UnauthenticatedUserException when no valid token exists.
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$expectedClass`|`string`||
+
+Return Value: `\Symfony\Component\Security\Core\User\UserInterface`
+
+### hasToken()
+
+```php
+public function hasToken(): bool
+```
+
+Return Value: `bool`
+
+### hasNonAnonymousToken()
+
+```php
+public function hasNonAnonymousToken(): bool
+```
+
+Return Value: `bool`
+
+### getToken()
+
+```php
+public function getToken(
+    string $expectedClass
+): \Symfony\Component\Security\Core\Authentication\Token\TokenInterface
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$expectedClass`|`string`||
+
+Return Value: `\Symfony\Component\Security\Core\Authentication\Token\TokenInterface`
+
+### isGranted()
+
+```php
+public function isGranted(
+    mixed $attributes,
+    ?object $object = null
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$attributes`|`mixed`||
+`$object`|`?object`|`null`|
+
+Return Value: `bool`
+
+### assertIsGranted()
+
+```php
+public function assertIsGranted(
+    mixed $attributes,
+    ?object $object = null
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$attributes`|`mixed`||
+`$object`|`?object`|`null`|
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/ParamConverter/ServiceProvider.md

@@ -0,0 +1,35 @@
+# `interface`  ServiceProvider
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\ParamConverter\ServiceProvider`](../../../../src/php/MvcBundle/ParamConverter/ServiceProvider.php)
+
+## Methods
+
+* [getFormFactory()](#getformfactory)
+* [getTokenStorage()](#gettokenstorage)
+* [getAuthorizationChecker()](#getauthorizationchecker)
+
+### getFormFactory()
+
+```php
+public function getFormFactory(): \Symfony\Component\Form\FormFactoryInterface
+```
+
+Return Value: `\Symfony\Component\Form\FormFactoryInterface`
+
+### getTokenStorage()
+
+```php
+public function getTokenStorage(): \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface
+```
+
+Return Value: `\Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface`
+
+### getAuthorizationChecker()
+
+```php
+public function getAuthorizationChecker(): \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface
+```
+
+Return Value: `\Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/ParamConverter/SymfonyServiceProvider.md

@@ -0,0 +1,56 @@
+#  SymfonyServiceProvider
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\ParamConverter\SymfonyServiceProvider`](../../../../src/php/MvcBundle/ParamConverter/SymfonyServiceProvider.php)
+
+**Implements**: [`ServiceProvider`](ServiceProvider.md)
+
+## Methods
+
+* [__construct()](#__construct)
+* [getFormFactory()](#getformfactory)
+* [getTokenStorage()](#gettokenstorage)
+* [getAuthorizationChecker()](#getauthorizationchecker)
+
+### __construct()
+
+```php
+public function __construct(
+    ?\Symfony\Component\Form\FormFactoryInterface $formFactory,
+    ?\Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokenStorage,
+    ?\Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface $authorizationChecker
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$formFactory`|`?\Symfony\Component\Form\FormFactoryInterface`||
+`$tokenStorage`|`?\Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface`||
+`$authorizationChecker`|`?\Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface`||
+
+Return Value: `mixed`
+
+### getFormFactory()
+
+```php
+public function getFormFactory(): \Symfony\Component\Form\FormFactoryInterface
+```
+
+Return Value: `\Symfony\Component\Form\FormFactoryInterface`
+
+### getTokenStorage()
+
+```php
+public function getTokenStorage(): \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface
+```
+
+Return Value: `\Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface`
+
+### getAuthorizationChecker()
+
+```php
+public function getAuthorizationChecker(): \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface
+```
+
+Return Value: `\Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Request/SymfonyFormRequest.md

@@ -0,0 +1,105 @@
+#  SymfonyFormRequest
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Request\SymfonyFormRequest`](../../../../src/php/MvcBundle/Request/SymfonyFormRequest.php)
+
+**Implements**: [`FormRequest`](../../Mvc/FormRequest.md)
+
+## Methods
+
+* [__construct()](#__construct)
+* [handle()](#handle)
+* [getValidData()](#getvaliddata)
+* [isValid()](#isvalid)
+* [isBound()](#isbound)
+* [getForm()](#getform)
+* [createFormView()](#createformview)
+
+### __construct()
+
+```php
+public function __construct(
+    \Symfony\Component\HttpFoundation\Request $request,
+    \Symfony\Component\Form\FormFactoryInterface $formFactory
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$request`|`\Symfony\Component\HttpFoundation\Request`||
+`$formFactory`|`\Symfony\Component\Form\FormFactoryInterface`||
+
+Return Value: `mixed`
+
+### handle()
+
+```php
+public function handle(
+    string $formType,
+    mixed $bindData = null,
+    array $options = []
+): bool
+```
+
+*Attempt to handle a form and return true when handled and data is valid.*
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$formType`|`string`||
+`$bindData`|`mixed`|`null`|
+`$options`|`array`|`[]`|
+
+Return Value: `bool`
+
+### getValidData()
+
+```php
+public function getValidData(): mixed
+```
+
+*Use this to retrieve the validated data from the form even when you attached `$bindData`.*
+
+Only by using this method you can mock the form handling by providing a replacement valid value in tests.
+
+Return Value: `mixed`
+
+### isValid()
+
+```php
+public function isValid(): bool
+```
+
+*Is the bound form valid?*
+
+Return Value: `bool`
+
+### isBound()
+
+```php
+public function isBound(): bool
+```
+
+*Is the request bound to a form?*
+
+Return Value: `bool`
+
+### getForm()
+
+```php
+public function getForm(): \Symfony\Component\Form\FormInterface
+```
+
+Return Value: `\Symfony\Component\Form\FormInterface`
+
+### createFormView()
+
+```php
+public function createFormView(): \Symfony\Component\Form\FormView
+```
+
+*Create the form view for the handled form.*
+
+Throws exception when no form was handled yet.
+
+Return Value: `\Symfony\Component\Form\FormView`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/SymfonyTokenContext.md

@@ -0,0 +1,143 @@
+#  SymfonyTokenContext
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\SymfonyTokenContext`](../../../src/php/MvcBundle/SymfonyTokenContext.php)
+
+**Implements**: [`TokenContext`](../Mvc/TokenContext.md)
+
+## Methods
+
+* [__construct()](#__construct)
+* [getCurrentUserId()](#getcurrentuserid)
+* [getCurrentUsername()](#getcurrentusername)
+* [getCurrentUser()](#getcurrentuser)
+* [hasToken()](#hastoken)
+* [hasNonAnonymousToken()](#hasnonanonymoustoken)
+* [getToken()](#gettoken)
+* [isGranted()](#isgranted)
+* [assertIsGranted()](#assertisgranted)
+
+### __construct()
+
+```php
+public function __construct(
+    \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokenStorage,
+    \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface $authorizationChecker
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$tokenStorage`|`\Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface`||
+`$authorizationChecker`|`\Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface`||
+
+Return Value: `mixed`
+
+### getCurrentUserId()
+
+```php
+public function getCurrentUserId(): mixed
+```
+
+*If a security context and token exists, retrieve the user id.*
+
+Throws UnauthenticatedUserException when no valid token exists.
+
+Return Value: `mixed`
+
+### getCurrentUsername()
+
+```php
+public function getCurrentUsername(): string
+```
+
+*If a security context and token exists, retrieve the username.*
+
+Throws UnauthenticatedUserException when no valid token exists.
+
+Return Value: `string`
+
+### getCurrentUser()
+
+```php
+public function getCurrentUser(
+    string $expectedClass
+): \Symfony\Component\Security\Core\User\UserInterface
+```
+
+*Get the current User object*
+
+Throws UnauthenticatedUserException when no valid token exists.
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$expectedClass`|`string`||
+
+Return Value: `\Symfony\Component\Security\Core\User\UserInterface`
+
+### hasToken()
+
+```php
+public function hasToken(): bool
+```
+
+Return Value: `bool`
+
+### hasNonAnonymousToken()
+
+```php
+public function hasNonAnonymousToken(): bool
+```
+
+Return Value: `bool`
+
+### getToken()
+
+```php
+public function getToken(
+    string $expectedClass
+): \Symfony\Component\Security\Core\Authentication\Token\TokenInterface
+```
+
+*Get the Security Token*
+
+Throws UnauthenticatedUserException when no valid token exists.
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$expectedClass`|`string`||
+
+Return Value: `\Symfony\Component\Security\Core\Authentication\Token\TokenInterface`
+
+### isGranted()
+
+```php
+public function isGranted(
+    mixed $attributes,
+    ?object $object = null
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$attributes`|`mixed`||
+`$object`|`?object`|`null`|
+
+Return Value: `bool`
+
+### assertIsGranted()
+
+```php
+public function assertIsGranted(
+    mixed $attributes,
+    ?object $object = null
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$attributes`|`mixed`||
+`$object`|`?object`|`null`|
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Versions.md

@@ -0,0 +1,17 @@
+#  Versions
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Versions`](../../../src/php/MvcBundle/Versions.php)
+
+## Methods
+
+* [isSecurityVersion6()](#issecurityversion6)
+
+### isSecurityVersion6()
+
+```php
+static public function isSecurityVersion6(): bool
+```
+
+Return Value: `bool`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).