Skip to content

Commit d6d6bc7

Browse files
[FEATURE] Add new form event AfterCurrentPageIsResolvedEvent (#6171)
Resolves: TYPO3-Documentation/Changelog-To-Doc#1386 Releases: main
1 parent 98ec38e commit d6d6bc7

File tree

3 files changed

+82
-0
lines changed

3 files changed

+82
-0
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. include:: /Includes.rst.txt
2+
.. index:: Events; AfterCurrentPageIsResolvedEvent
3+
4+
.. _AfterCurrentPageIsResolvedEvent:
5+
6+
===============================
7+
AfterCurrentPageIsResolvedEvent
8+
===============================
9+
10+
.. versionadded:: 14.0
11+
The event :php-short:`TYPO3\CMS\Form\Event\AfterCurrentPageIsResolvedEvent`
12+
serves as an improved replacement for the removed hook
13+
:php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['afterInitializeCurrentPage']`.
14+
15+
The event :php-short:`TYPO3\CMS\Form\Event\AfterCurrentPageIsResolvedEvent`
16+
allows the current page to be manipulated after it has been resolved.
17+
18+
.. _AfterCurrentPageIsResolvedEvent-example:
19+
20+
Example
21+
=======
22+
23+
.. literalinclude:: _AfterCurrentPageIsResolvedEvent/_MyEventListener.php
24+
:language: php
25+
:caption: EXT:my_extension/Classes/EventListener/MyEventListener.php
26+
27+
.. _AfterCurrentPageIsResolvedEvent-api:
28+
29+
API
30+
===
31+
32+
.. include:: /CodeSnippets/Events/Form/AfterCurrentPageIsResolvedEvent.rst.txt
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace MyVendor\MyExtension\EventListener;
6+
7+
use TYPO3\CMS\Core\Attribute\AsEventListener;
8+
use TYPO3\CMS\Form\Event\AfterCurrentPageIsResolvedEvent;
9+
10+
#[AsEventListener(
11+
identifier: 'my-extension/after-current-page-is-resolved-event',
12+
)]
13+
final readonly class MyEventListener
14+
{
15+
public function __invoke(AfterCurrentPageIsResolvedEvent $event): void
16+
{
17+
$event->currentPage->setRenderingOption('enabled', false);
18+
}
19+
}
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets
2+
.. php:namespace:: TYPO3\CMS\Form\Event
3+
4+
.. php:class:: AfterCurrentPageIsResolvedEvent
5+
6+
Listeners to this event will be able to manipulate the current
7+
page after it has been resolved.
8+
9+
.. php:attr:: currentPage
10+
:public:
11+
12+
The current page
13+
14+
.. php:attr:: formRuntime
15+
:readonly:
16+
:public:
17+
18+
The form runtime object
19+
20+
.. php:attr:: lastDisplayedPage
21+
:readonly:
22+
:public:
23+
24+
The last displayed page
25+
26+
.. php:attr:: request
27+
:readonly:
28+
:public:
29+
30+
The current request
31+

0 commit comments

Comments
 (0)