Changing and Extending

Events

The events are listed in order of execution.

class HttpRequestRouterHandleByEvent

Fully qualified name

\Pixelant\Interest\Router\Event\HttpRequestRouterHandleByEvent

Called in HttpRequestRouter::handleByMethod(). Can be used to modify the request and entry point parts before they are passed on to a RequestHandler.

EventHandlers for this event should implement \Pixelant\Interest\Router\Event\HttpRequestRouterHandleByEventHandlerInterface.

getEntryPointParts ( )

Returns an array of the entry point parts, i.e. the parts of the URL used to detect the correct entry point. Given the URL http://www.example.com/rest/tt_content/ContentRemoteId and the default entry point rest, the entry point parts will be ['tt_content', 'ContentRemoteId'].

returntype

array

setEntryPointParts ( $entryPointParts)

param array $entryPointParts

 

getRequest ( )

returntype

PsrHttpMessageServerRequestInterface

setRequest ( $request)

param Psr\Http\Message\ServerRequestInterface $request

 

class BeforeRecordOperationEvent

Fully qualified name

\Pixelant\Interest\DataHandling\Operation\Event\BeforeRecordOperationEvent

Called inside the AbstractRecordOperation::__construct() when a *RecordOperation object has been initialized, but before data validations.

EventHandlers for this event should implement \Pixelant\Interest\DataHandling\Operation\Event\BeforeRecordOperationEventHandlerInterface.

EventHandlers for this event can throw these exceptions:

\Pixelant\Interest\DataHandling\Operation\Event\Exception\StopRecordOperationException

To quietly stop the record operation. This exception is only logged as informational and the operation will be treated as successful. E.g. used when deferring an operation.

\Pixelant\Interest\DataHandling\Operation\Event\Exception\BeforeRecordOperationEventException

Will stop the record operation and log as an error. The operation will be treated as unsuccessful.

getRecordOperation ( )

returntype

PixelantInterestDataHandlingOperationAbstractRecordOperation

class AfterRecordOperationEvent

Fully qualified name

\Pixelant\Interest\DataHandling\Operation\Event\AfterRecordOperationEvent

Called as the last thing inside the AbstractRecordOperation::__invoke() method, after all data persistence and pending relations have been resolved.

EventHandlers for this event should implement \Pixelant\Interest\DataHandling\Operation\Event\AfterRecordOperationEventHandlerInterface.

getRecordOperation ( )

returntype

PixelantInterestDataHandlingOperationAbstractRecordOperation

class HttpResponseEvent

Fully qualified name

\Pixelant\Interest\Middleware\Event\HttpResponseEvent

Called in the middleware, just before control is handled back over to TYPO3 during an HTTP request. Allows modification of the response object.

EventHandlers for this event should implement \Pixelant\Interest\Middleware\Event\HttpResponseEventHandlerInterface.

getResponse ( )

returntype

PsrHttpMessageResponseInterface

setResponse ( $response)

param Psr\Http\Message\ResponseInterface $response

 

In TYPO3 version 9

TYPO3 version 9 doesn't support PSR-14 events, but it's using signals and slots instead. Luckily, PSR-14 Events and EventHandlers can be made to work with them as well. You can register an EventHandler as a SignalSlot using this convenience function:

\Pixelant\Interest\Utility\CompatibilityUtility::registerEventHandlerAsSignalSlot(
    string $eventClassName,
    string $eventHandlerClassName
);

It will map the class and methods correctly. The only difference is that you can't change the order of execution, as the slots are called in the order they are registered.

Here's how the function is used by the Interest extension itself:

\Pixelant\Interest\Utility\CompatibilityUtility::registerEventHandlerAsSignalSlot(
    \Pixelant\Interest\DataHandling\Operation\Event\BeforeRecordOperationEvent::class,
    \Pixelant\Interest\DataHandling\Operation\Event\Handler\StopIfRepeatingPreviousRecordOperation::class
);

Internal representation and identity

Inside the extension, a record's state and identity is maintained by two data transfer object classes:

• A record's unique identity from creation to deletion is represented by \Pixelant\Interest\Domain\Model\Dto\RecordInstanceIdentifier.
• A record's current state, including the data that should be written to the database is represented by \Pixelant\Interest\Domain\Model\Dto\RecordRepresentation.

When creating a RecordRepresentation, you must also supply a RecordInstanceIdentifier:

use Pixelant\Interest\Domain\Model\Dto\RecordInstanceIdentifier;
use Pixelant\Interest\Domain\Model\Dto\RecordRepresentation;

new RecordRepresentation(
    [
        'title' => 'My record title',
        'bodytext' => 'This is a story about ...',
    ],
    new RecordInstanceIdentifier(
        'tt_content',
        'ContentElementA',
        'en'
    )
);

Record operations

Record operations are the core of the Interest extension. Each represents one operation requested from the outside. One record operation is not the same as one database operation. Some record operations will not be executed (if it is a duplicate of the previous operation on the same remote ID) or deferred (if the record operation requires a condition to be fulfilled before it can be executed).

The record operations are invokable, and are executed as such:

Mapping table

The extension keeps track of the mapping between remote IDs and TYPO3 records in the table tx_interest_remote_id_mapping. In addition to mapping information, the table contains metadata about each record.

use Pixelant\Interest\Domain\Model\Dto\RecordInstanceIdentifier;
use Pixelant\Interest\Domain\Model\Dto\RecordRepresentation;
use Pixelant\Interest\Domain\Repository\RemoteIdMappingRepository;
use Pixelant\Interest\DataHandling\Operation\DeleteRecordOperation;
use TYPO3\CMS\Core\Utility\GeneralUtility;

$mappingRepository = GeneralUtility::makeInstance(RemoteIdMappingRepository::class);

foreach($mappingRepository->findAllUntouchedSince(time() - 86400) as $remoteId) {
    (new DeleteRecordOperation(
        new RecordRepresentation(
            [],
            new RecordInstanceIdentifier('table', $remoteId)
        );
    ))();
}

use GuzzleHttp\Client;
use Pixelant\Interest\Domain\Repository\RemoteIdMappingRepository;

$mappingRepository = GeneralUtility::makeInstance(RemoteIdMappingRepository::class);

$metaData = $mappingRepository->getMetaDataValue(
    $remoteId,
    self::class
) ?? [];

$headers = [
    'If-Modified-Since' => $metaData['date'],
    'If-None-Match'] => $metaData['etag'],
];

$response = GeneralUtility::makeInstance(Client::class)
    ->get($url, ['headers' => $headers]);

if ($response->getStatusCode() === 304) {
    return null;
}

$mappingRepository->setMetaDataValue(
    $remoteId,
    self::class,
    [
        'date' => $response->getHeader('Date'),
        'etag' => $response->getHeader('ETag'),
    ]
);

return $response->getBody()->getContents();