TYPO3 v15 dev-main snapshot ()

Classes/Event/Configuration/BeforeFlexFormConfigurationOverrideEvent.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Configuration;
+
+/**
+ * Event which is dispatched before flexForm configuration overrides framework configuration. Possible core flexForm
+ * overrides have already been processed in `$flexFormConfiguration`.
+ *
+ * Listeners can implement a custom flexForm override process by using the original flexForm configuration available
+ * in `$originalFlexFormConfiguration`.
+ */
+final class BeforeFlexFormConfigurationOverrideEvent
+{
+    public function __construct(
+        private readonly array $frameworkConfiguration,
+        private readonly array $originalFlexFormConfiguration,
+        private array $flexFormConfiguration
+    ) {}
+
+    public function getFrameworkConfiguration(): array
+    {
+        return $this->frameworkConfiguration;
+    }
+
+    public function getOriginalFlexFormConfiguration(): array
+    {
+        return $this->originalFlexFormConfiguration;
+    }
+
+    public function getFlexFormConfiguration(): array
+    {
+        return $this->flexFormConfiguration;
+    }
+
+    public function setFlexFormConfiguration(array $flexFormConfiguration): void
+    {
+        $this->flexFormConfiguration = $flexFormConfiguration;
+    }
+}

Classes/Event/Mvc/AfterRequestDispatchedEvent.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Mvc;
+
+use Psr\Http\Message\ResponseInterface;
+use TYPO3\CMS\Extbase\Mvc\RequestInterface;
+
+/**
+ * Event which is fired after the dispatcher has successfully dispatched a request to a controller/action.
+ */
+final readonly class AfterRequestDispatchedEvent
+{
+    public function __construct(
+        private RequestInterface $request,
+        private ResponseInterface $response
+    ) {}
+
+    public function getRequest(): RequestInterface
+    {
+        return $this->request;
+    }
+
+    public function getResponse(): ResponseInterface
+    {
+        return $this->response;
+    }
+}

Classes/Event/Mvc/BeforeActionAuthorizationDeniedEvent.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Mvc;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use TYPO3\CMS\Extbase\Attribute\Authorize;
+use TYPO3\CMS\Extbase\Authorization\AuthorizationFailureReason;
+
+/**
+ * Event that is triggered when an extbase action authorization check fails and before the authorization denied
+ * PropagateResponseException is thrown. Extension developers can use this event to prevent the default behavior
+ * and provide a custom response.
+ *
+ * Security notice: When providing a custom response, it must be ensured, that no objects are persisted using
+ * the extbase persistence layer. Additionally it is recommended to only use a custom response for non-cached
+ * actions, because otherwise the response result will get cached.
+ */
+final class BeforeActionAuthorizationDeniedEvent
+{
+    private ?ResponseInterface $response = null;
+
+    public function __construct(
+        private readonly ServerRequestInterface $request,
+        private readonly string $controllerClassName,
+        private readonly string $actionMethodName,
+        private readonly Authorize $authorize,
+        private readonly AuthorizationFailureReason $failureReason
+    ) {}
+
+    public function getRequest(): ServerRequestInterface
+    {
+        return $this->request;
+    }
+
+    public function getControllerClassName(): string
+    {
+        return $this->controllerClassName;
+    }
+
+    public function getActionMethodName(): string
+    {
+        return $this->actionMethodName;
+    }
+
+    public function getAuthorize(): Authorize
+    {
+        return $this->authorize;
+    }
+
+    public function getFailureReason(): AuthorizationFailureReason
+    {
+        return $this->failureReason;
+    }
+
+    public function getResponse(): ?ResponseInterface
+    {
+        return $this->response;
+    }
+
+    public function setResponse(ResponseInterface $response): void
+    {
+        $this->response = $response;
+    }
+}

Classes/Event/Mvc/BeforeActionCallEvent.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Mvc;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * Event that is triggered before any Extbase Action is called within the ActionController or one
+ * of its subclasses.
+ */
+final readonly class BeforeActionCallEvent
+{
+    public function __construct(
+        private string $controllerClassName,
+        private string $actionMethodName,
+        private array $preparedArguments,
+        private ServerRequestInterface $request,
+    ) {}
+
+    public function getControllerClassName(): string
+    {
+        return $this->controllerClassName;
+    }
+
+    public function getActionMethodName(): string
+    {
+        return $this->actionMethodName;
+    }
+
+    public function getPreparedArguments(): array
+    {
+        return $this->preparedArguments;
+    }
+
+    public function getRequest(): ServerRequestInterface
+    {
+        return $this->request;
+    }
+}

Classes/Event/Mvc/BeforeActionRateLimitResponseEvent.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Mvc;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use TYPO3\CMS\Extbase\Attribute\RateLimit;
+
+/**
+ * Event that is triggered, when an extbase action is rate limitied and before the rate limit response is sent.
+ * Extension developers can use this event to provide an alternative response or to implement a custom logic.
+ */
+final class BeforeActionRateLimitResponseEvent
+{
+    public function __construct(
+        private readonly ServerRequestInterface $request,
+        private readonly string $controllerClassName,
+        private readonly string $actionMethodName,
+        private readonly RateLimit $rateLimit,
+        private ResponseInterface $response
+    ) {}
+
+    public function getRequest(): ServerRequestInterface
+    {
+        return $this->request;
+    }
+
+    public function getControllerClassName(): string
+    {
+        return $this->controllerClassName;
+    }
+
+    public function getActionMethodName(): string
+    {
+        return $this->actionMethodName;
+    }
+
+    public function getRateLimit(): RateLimit
+    {
+        return $this->rateLimit;
+    }
+
+    public function getResponse(): ResponseInterface
+    {
+        return $this->response;
+    }
+
+    public function setResponse(ResponseInterface $response): void
+    {
+        $this->response = $response;
+    }
+}

Classes/Event/Persistence/AfterObjectThawedEvent.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
+
+/**
+ * Allows to modify values when creating domain objects.
+ */
+final readonly class AfterObjectThawedEvent
+{
+    public function __construct(private DomainObjectInterface $mappedObject, private array $record) {}
+
+    public function getObject(): DomainObjectInterface
+    {
+        return $this->mappedObject;
+    }
+
+    public function getRecord(): array
+    {
+        return $this->record;
+    }
+}

Classes/Event/Persistence/EntityAddedToPersistenceEvent.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
+
+/**
+ * Event which is fired after an object/entity was sent to persistence layer to be added,
+ * but before updating the reference index and current session.
+ */
+final readonly class EntityAddedToPersistenceEvent
+{
+    public function __construct(private DomainObjectInterface $persistedObject) {}
+
+    public function getObject(): DomainObjectInterface
+    {
+        return $this->persistedObject;
+    }
+}

Classes/Event/Persistence/EntityFinalizedAfterPersistenceEvent.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
+
+/**
+ * Event which is fired after an object/entity was sent to persistence layer to be added
+ * including update of reference index and current session.
+ */
+final readonly class EntityFinalizedAfterPersistenceEvent
+{
+    public function __construct(private DomainObjectInterface $persistedObject) {}
+
+    public function getObject(): DomainObjectInterface
+    {
+        return $this->persistedObject;
+    }
+}

Classes/Event/Persistence/EntityPersistedEvent.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
+
+/**
+ * Event which is fired after an object was pushed to the storage backend
+ */
+final readonly class EntityPersistedEvent
+{
+    public function __construct(private DomainObjectInterface $persistedObject) {}
+
+    public function getObject(): DomainObjectInterface
+    {
+        return $this->persistedObject;
+    }
+}

Classes/Event/Persistence/EntityRemovedFromPersistenceEvent.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
+
+/**
+ * Event which is fired after an object/entity was sent to persistence layer to be removed.
+ */
+final readonly class EntityRemovedFromPersistenceEvent
+{
+    public function __construct(private DomainObjectInterface $persistedObject) {}
+
+    public function getObject(): DomainObjectInterface
+    {
+        return $this->persistedObject;
+    }
+}

Classes/Event/Persistence/EntityUpdatedInPersistenceEvent.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
+
+/**
+ * Event which is fired after an object/entity was sent to persistence layer to be updated.
+ */
+final readonly class EntityUpdatedInPersistenceEvent
+{
+    public function __construct(private DomainObjectInterface $persistedObject) {}
+
+    public function getObject(): DomainObjectInterface
+    {
+        return $this->persistedObject;
+    }
+}

Classes/Event/Persistence/ModifyQueryBeforeFetchingObjectCountEvent.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+
+/**
+ * Event which is fired before the storage backend is asked for a result count from a given query.
+ */
+final class ModifyQueryBeforeFetchingObjectCountEvent
+{
+    public function __construct(private QueryInterface $query) {}
+
+    public function getQuery(): QueryInterface
+    {
+        return $this->query;
+    }
+
+    public function setQuery(QueryInterface $query): void
+    {
+        $this->query = $query;
+    }
+}

Classes/Event/Persistence/ModifyQueryBeforeFetchingObjectDataEvent.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+
+/**
+ * Event which is fired before the storage backend is asked for results from a given query.
+ */
+final class ModifyQueryBeforeFetchingObjectDataEvent
+{
+    public function __construct(private QueryInterface $query) {}
+
+    public function getQuery(): QueryInterface
+    {
+        return $this->query;
+    }
+
+    public function setQuery(QueryInterface $query): void
+    {
+        $this->query = $query;
+    }
+}

Classes/Event/Persistence/ModifyResultAfterFetchingObjectCountEvent.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+
+/**
+ * Event which is fired after the storage backend has counted the results of a given query.
+ */
+final class ModifyResultAfterFetchingObjectCountEvent
+{
+    public function __construct(private readonly QueryInterface $query, private int $result) {}
+
+    public function getQuery(): QueryInterface
+    {
+        return $this->query;
+    }
+
+    public function getResult(): int
+    {
+        return $this->result;
+    }
+
+    public function setResult(int $result): void
+    {
+        $this->result = $result;
+    }
+}

Classes/Event/Persistence/ModifyResultAfterFetchingObjectDataEvent.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Persistence;
+
+use TYPO3\CMS\Extbase\Persistence\QueryInterface;
+
+/**
+ * Event which is fired after the storage backend has pulled results from a given query.
+ */
+final class ModifyResultAfterFetchingObjectDataEvent
+{
+    public function __construct(private readonly QueryInterface $query, private array $result) {}
+
+    public function getQuery(): QueryInterface
+    {
+        return $this->query;
+    }
+
+    public function getResult(): array
+    {
+        return $this->result;
+    }
+
+    public function setResult(array $result): void
+    {
+        $this->result = $result;
+    }
+}

Classes/Event/Service/ModifyUploadedFileTargetFilenameEvent.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Extbase\Event\Service;
+
+use TYPO3\CMS\Extbase\Mvc\Controller\FileUploadConfiguration;
+
+/**
+ * Allows to modify the target filename of uploaded files when handled
+ * by the extbase fileupload service
+ */
+final class ModifyUploadedFileTargetFilenameEvent
+{
+    public function __construct(
+        private string $targetFilename,
+        private readonly FileUploadConfiguration $configuration
+    ) {}
+
+    public function getTargetFilename(): string
+    {
+        return $this->targetFilename;
+    }
+
+    public function setTargetFilename(string $targetFilename): void
+    {
+        $this->targetFilename = $targetFilename;
+    }
+
+    public function getConfiguration(): FileUploadConfiguration
+    {
+        return $this->configuration;
+    }
+}