@frontastic/common 2.48.2 → 2.48.4

package/docs/php/Mvc/TemplateView.md

@@ -0,0 +1,65 @@
+#  TemplateView
+
+**Fully Qualified**: [`\Frontastic\Common\Mvc\TemplateView`](../../../src/php/Mvc/TemplateView.php)
+
+## Methods
+
+* [__construct()](#__construct)
+* [getViewParams()](#getviewparams)
+* [getActionTemplateName()](#getactiontemplatename)
+* [getStatusCode()](#getstatuscode)
+* [getHeaders()](#getheaders)
+
+### __construct()
+
+```php
+public function __construct(
+    mixed $viewParams,
+    ?string $actionTemplateName = null,
+    int $statusCode = 200,
+    array $headers = []
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$viewParams`|`mixed`||
+`$actionTemplateName`|`?string`|`null`|
+`$statusCode`|`int`|`200`|
+`$headers`|`array`|`[]`|
+
+Return Value: `mixed`
+
+### getViewParams()
+
+```php
+public function getViewParams(): array
+```
+
+Return Value: `array`
+
+### getActionTemplateName()
+
+```php
+public function getActionTemplateName(): ?string
+```
+
+Return Value: `?string`
+
+### getStatusCode()
+
+```php
+public function getStatusCode(): int
+```
+
+Return Value: `int`
+
+### getHeaders()
+
+```php
+public function getHeaders(): array
+```
+
+Return Value: `array`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/Mvc/TokenContext.md

@@ -0,0 +1,124 @@
+# `interface`  TokenContext
+
+**Fully Qualified**: [`\Frontastic\Common\Mvc\TokenContext`](../../../src/php/Mvc/TokenContext.php)
+
+## Methods
+
+* [getCurrentUserId()](#getcurrentuserid)
+* [getCurrentUsername()](#getcurrentusername)
+* [getCurrentUser()](#getcurrentuser)
+* [hasToken()](#hastoken)
+* [hasNonAnonymousToken()](#hasnonanonymoustoken)
+* [getToken()](#gettoken)
+* [isGranted()](#isgranted)
+* [assertIsGranted()](#assertisgranted)
+
+### 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/Mvc/ViewStruct.md

@@ -0,0 +1,56 @@
+# `abstract`  ViewStruct
+
+**Fully Qualified**: [`\Frontastic\Common\Mvc\ViewStruct`](../../../src/php/Mvc/ViewStruct.php)
+
+Target for properties and view logic passed to any templating mechanism or
+serialization method. Returning a ViewStruct from a controller is catched by
+the ViewListener and transformed into a Twig template for example:
+
+     # View/Default/HelloView.php      class HelloView extends ViewStruct     
+{          public $name;
+
+         public function reverseName()          {              return
+strrev($this->name);          }      }
+
+     # Controller/DefaultController.php
+
+     {          public function helloAction($name)          {             
+return new HelloView(array('name' => $name));          }      }
+
+     # Resources/views/Default/hello.html.twig      Hello {{ view.name }} or
+{{ view.reverseName() }}!
+
+## Methods
+
+* [__construct()](#__construct)
+* [__get()](#__get)
+
+### __construct()
+
+```php
+public function __construct(
+    array $data
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$data`|`array`||
+
+Return Value: `mixed`
+
+### __get()
+
+```php
+public function __get(
+    string $name
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$name`|`string`||
+
+Return Value: `mixed`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Controller/GyroControllerNameParser.md

@@ -0,0 +1,38 @@
+#  GyroControllerNameParser
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Controller\GyroControllerNameParser`](../../../../src/php/MvcBundle/Controller/GyroControllerNameParser.php)
+
+## Methods
+
+* [__construct()](#__construct)
+* [parse()](#parse)
+
+### __construct()
+
+```php
+public function __construct(
+    \Symfony\Component\DependencyInjection\ContainerInterface $container
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$container`|`\Symfony\Component\DependencyInjection\ContainerInterface`||
+
+Return Value: `mixed`
+
+### parse()
+
+```php
+public function parse(
+    string $controller
+): string
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$controller`|`string`||
+
+Return Value: `string`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Controller/ResultConverter/ArrayToTemplateResponseConverter.md

@@ -0,0 +1,64 @@
+#  ArrayToTemplateResponseConverter
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Controller\ResultConverter\ArrayToTemplateResponseConverter`](../../../../../src/php/MvcBundle/Controller/ResultConverter/ArrayToTemplateResponseConverter.php)
+
+**Implements**: [`ControllerResultConverter`](ControllerResultConverter.md)
+
+Guess the template names with the same algorithm that @Template() in Sensio's
+FrameworkExtraBundle uses.
+
+## Methods
+
+* [__construct()](#__construct)
+* [supports()](#supports)
+* [convert()](#convert)
+
+### __construct()
+
+```php
+public function __construct(
+    \Twig\Environment $twig,
+    TemplateGuesser $guesser,
+    string $engine
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$twig`|`\Twig\Environment`||
+`$guesser`|[`TemplateGuesser`](../../View/TemplateGuesser.md)||
+`$engine`|`string`||
+
+Return Value: `mixed`
+
+### supports()
+
+```php
+public function supports(
+    mixed $result
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$result`|`mixed`||
+
+Return Value: `bool`
+
+### convert()
+
+```php
+public function convert(
+    mixed $result,
+    \Symfony\Component\HttpFoundation\Request $request
+): \Symfony\Component\HttpFoundation\Response
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$result`|`mixed`||
+`$request`|`\Symfony\Component\HttpFoundation\Request`||
+
+Return Value: `\Symfony\Component\HttpFoundation\Response`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Controller/ResultConverter/ControllerResultConverter.md

@@ -0,0 +1,40 @@
+# `interface`  ControllerResultConverter
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Controller\ResultConverter\ControllerResultConverter`](../../../../../src/php/MvcBundle/Controller/ResultConverter/ControllerResultConverter.php)
+
+## Methods
+
+* [supports()](#supports)
+* [convert()](#convert)
+
+### supports()
+
+```php
+public function supports(
+    mixed $result
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$result`|`mixed`||
+
+Return Value: `bool`
+
+### convert()
+
+```php
+public function convert(
+    mixed $result,
+    \Symfony\Component\HttpFoundation\Request $request
+): \Symfony\Component\HttpFoundation\Response
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$result`|`mixed`||
+`$request`|`\Symfony\Component\HttpFoundation\Request`||
+
+Return Value: `\Symfony\Component\HttpFoundation\Response`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Controller/ResultConverter/ControllerYieldApplier.md

@@ -0,0 +1,42 @@
+# `interface`  ControllerYieldApplier
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Controller\ResultConverter\ControllerYieldApplier`](../../../../../src/php/MvcBundle/Controller/ResultConverter/ControllerYieldApplier.php)
+
+## Methods
+
+* [supports()](#supports)
+* [apply()](#apply)
+
+### supports()
+
+```php
+public function supports(
+    mixed $yield
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$yield`|`mixed`||
+
+Return Value: `bool`
+
+### apply()
+
+```php
+public function apply(
+    mixed $yield,
+    \Symfony\Component\HttpFoundation\Request $request,
+    \Symfony\Component\HttpFoundation\Response $response
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$yield`|`mixed`||
+`$request`|`\Symfony\Component\HttpFoundation\Request`||
+`$response`|`\Symfony\Component\HttpFoundation\Response`||
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Controller/ResultConverter/CookieYieldApplier.md

@@ -0,0 +1,44 @@
+#  CookieYieldApplier
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Controller\ResultConverter\CookieYieldApplier`](../../../../../src/php/MvcBundle/Controller/ResultConverter/CookieYieldApplier.php)
+
+**Implements**: [`ControllerYieldApplier`](ControllerYieldApplier.md)
+
+## Methods
+
+* [supports()](#supports)
+* [apply()](#apply)
+
+### supports()
+
+```php
+public function supports(
+    mixed $yield
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$yield`|`mixed`||
+
+Return Value: `bool`
+
+### apply()
+
+```php
+public function apply(
+    mixed $yield,
+    \Symfony\Component\HttpFoundation\Request $request,
+    \Symfony\Component\HttpFoundation\Response $response
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$yield`|`mixed`||
+`$request`|`\Symfony\Component\HttpFoundation\Request`||
+`$response`|`\Symfony\Component\HttpFoundation\Response`||
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Controller/ResultConverter/FlashYieldApplier.md

@@ -0,0 +1,44 @@
+#  FlashYieldApplier
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Controller\ResultConverter\FlashYieldApplier`](../../../../../src/php/MvcBundle/Controller/ResultConverter/FlashYieldApplier.php)
+
+**Implements**: [`ControllerYieldApplier`](ControllerYieldApplier.md)
+
+## Methods
+
+* [supports()](#supports)
+* [apply()](#apply)
+
+### supports()
+
+```php
+public function supports(
+    mixed $yield
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$yield`|`mixed`||
+
+Return Value: `bool`
+
+### apply()
+
+```php
+public function apply(
+    mixed $yield,
+    \Symfony\Component\HttpFoundation\Request $request,
+    \Symfony\Component\HttpFoundation\Response $response
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$yield`|`mixed`||
+`$request`|`\Symfony\Component\HttpFoundation\Request`||
+`$response`|`\Symfony\Component\HttpFoundation\Response`||
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Controller/ResultConverter/HeadersYieldApplier.md

@@ -0,0 +1,44 @@
+#  HeadersYieldApplier
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Controller\ResultConverter\HeadersYieldApplier`](../../../../../src/php/MvcBundle/Controller/ResultConverter/HeadersYieldApplier.php)
+
+**Implements**: [`ControllerYieldApplier`](ControllerYieldApplier.md)
+
+## Methods
+
+* [supports()](#supports)
+* [apply()](#apply)
+
+### supports()
+
+```php
+public function supports(
+    mixed $yield
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$yield`|`mixed`||
+
+Return Value: `bool`
+
+### apply()
+
+```php
+public function apply(
+    mixed $yield,
+    \Symfony\Component\HttpFoundation\Request $request,
+    \Symfony\Component\HttpFoundation\Response $response
+): void
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$yield`|`mixed`||
+`$request`|`\Symfony\Component\HttpFoundation\Request`||
+`$response`|`\Symfony\Component\HttpFoundation\Response`||
+
+Return Value: `void`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/MvcBundle/Controller/ResultConverter/RedirectConverter.md

@@ -0,0 +1,57 @@
+#  RedirectConverter
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\Controller\ResultConverter\RedirectConverter`](../../../../../src/php/MvcBundle/Controller/ResultConverter/RedirectConverter.php)
+
+**Implements**: [`ControllerResultConverter`](ControllerResultConverter.md)
+
+## Methods
+
+* [__construct()](#__construct)
+* [supports()](#supports)
+* [convert()](#convert)
+
+### __construct()
+
+```php
+public function __construct(
+    \Symfony\Component\Routing\Generator\UrlGeneratorInterface $router
+): mixed
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$router`|`\Symfony\Component\Routing\Generator\UrlGeneratorInterface`||
+
+Return Value: `mixed`
+
+### supports()
+
+```php
+public function supports(
+    mixed $result
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$result`|`mixed`||
+
+Return Value: `bool`
+
+### convert()
+
+```php
+public function convert(
+    mixed $result,
+    \Symfony\Component\HttpFoundation\Request $request
+): \Symfony\Component\HttpFoundation\Response
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$result`|`mixed`||
+`$request`|`\Symfony\Component\HttpFoundation\Request`||
+
+Return Value: `\Symfony\Component\HttpFoundation\Response`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

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

@@ -0,0 +1,32 @@
+#  CompatibleTreeBuilder
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\DependencyInjection\CompatibleTreeBuilder`](../../../../src/php/MvcBundle/DependencyInjection/CompatibleTreeBuilder.php)
+
+## Methods
+
+* [root()](#root)
+* [getTreeBuilder()](#gettreebuilder)
+
+### root()
+
+```php
+public function root(
+    string $name
+): \Symfony\Component\Config\Definition\Builder\NodeDefinition
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$name`|`string`||
+
+Return Value: `\Symfony\Component\Config\Definition\Builder\NodeDefinition`
+
+### getTreeBuilder()
+
+```php
+public function getTreeBuilder(): \Symfony\Component\Config\Definition\Builder\TreeBuilder
+```
+
+Return Value: `\Symfony\Component\Config\Definition\Builder\TreeBuilder`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

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

@@ -0,0 +1,22 @@
+#  Configuration
+
+**Fully Qualified**: [`\Frontastic\Common\MvcBundle\DependencyInjection\Configuration`](../../../../src/php/MvcBundle/DependencyInjection/Configuration.php)
+
+**Implements**: `\Symfony\Component\Config\Definition\ConfigurationInterface`
+
+To learn more see {@link
+http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}
+
+## Methods
+
+* [getConfigTreeBuilder()](#getconfigtreebuilder)
+
+### getConfigTreeBuilder()
+
+```php
+public function getConfigTreeBuilder(): \Symfony\Component\Config\Definition\Builder\TreeBuilder
+```
+
+Return Value: `\Symfony\Component\Config\Definition\Builder\TreeBuilder`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).