Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Classes/ContentObject/WebcomponentContentObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ public function __construct(
public function render($conf = []): string
{
$contentObjectRenderer = $this->getContentObjectRenderer();
$renderComponentClassName = '';
/** @var array<string, mixed> $record */
$record = $contentObjectRenderer->data;

Expand All @@ -47,6 +48,7 @@ public function render($conf = []): string
}
$componentClassName = $contentObjectRenderer->stdWrapValue('component', $conf, null);
if (is_string($componentClassName) && $componentClassName !== '') {
$renderComponentClassName = $componentClassName;
try {
$componentRenderingData = $this->componentRenderer->evaluateComponent($inputData, $componentClassName, $contentObjectRenderer);
} catch (AssertionFailedException $e) {
Expand All @@ -59,7 +61,7 @@ public function render($conf = []): string

$componentRenderingData = $this->evaluateTypoScriptConfiguration($componentRenderingData, $contentObjectRenderer, $conf);

$markup = $this->componentRenderer->renderComponent($componentRenderingData, $contentObjectRenderer);
$markup = $this->componentRenderer->renderComponent($componentRenderingData, $contentObjectRenderer, $renderComponentClassName);

// apply stdWrap
if (is_array($conf['stdWrap.'] ?? null)) {
Expand Down
2 changes: 1 addition & 1 deletion Classes/DataProviding/Helpers/ComponentRenderingHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,6 @@ public function evaluateAndRenderComponent(string $componentClassName, ?InputDat
$contentObjectRenderer = GeneralUtility::makeInstance(ContentObjectRenderer::class);
$contentObjectRenderer->start($inputData->record, $inputData->tableName);

return $this->componentRenderer->renderComponent($componentRenderingData, $contentObjectRenderer);
return $this->componentRenderer->renderComponent($componentRenderingData, $contentObjectRenderer, $componentClassName);
}
}
28 changes: 28 additions & 0 deletions Classes/Dto/Events/ComponentWasRendered.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

declare(strict_types=1);

namespace Sinso\Webcomponents\Dto\Events;

use Sinso\Webcomponents\Dto\ComponentRenderingData;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

final class ComponentWasRendered
{
public function __construct(
private string $markup,
public readonly ComponentRenderingData $componentRenderingData,
public readonly ContentObjectRenderer $contentObjectRenderer,
public readonly string $componentClassName,
) {}

public function getMarkup(): string
{
return $this->markup;
}

public function setMarkup(string $markup): void
{
$this->markup = $markup;
}
}
1 change: 1 addition & 0 deletions Classes/Dto/Events/ComponentWillBeRendered.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ final class ComponentWillBeRendered
public function __construct(
ComponentRenderingData $componentRenderingData,
public readonly ContentObjectRenderer $contentObjectRenderer,
public readonly string $componentClassName,
) {
$this->componentRenderingData = $componentRenderingData;
}
Expand Down
25 changes: 22 additions & 3 deletions Classes/Rendering/ComponentRenderer.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use Sinso\Webcomponents\DataProviding\Traits\Assert;
use Sinso\Webcomponents\Dto\ComponentRenderingData;
use Sinso\Webcomponents\Dto\Events\ComponentEvaluated;
use Sinso\Webcomponents\Dto\Events\ComponentWasRendered;
use Sinso\Webcomponents\Dto\Events\ComponentWillBeRendered;
use Sinso\Webcomponents\Dto\InputData;
use Psr\EventDispatcher\EventDispatcherInterface;
Expand All @@ -17,6 +18,10 @@
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder;

/**
* @internal Render content elements via \Sinso\Webcomponents\ContentObject\WebcomponentContentObject.
* For rendering from PHP context use \Sinso\Webcomponents\DataProviding\Helpers\ComponentRenderingHelper.
*/
class ComponentRenderer
{
use Assert;
Expand All @@ -25,11 +30,25 @@ public function __construct(
private readonly EventDispatcherInterface $eventDispatcher,
) {}

public function renderComponent(ComponentRenderingData $componentRenderingData, ContentObjectRenderer $contentObjectRenderer, ?TagBuilder $tagBuilder = null): string
public function renderComponent(
ComponentRenderingData $componentRenderingData,
ContentObjectRenderer $contentObjectRenderer,
string $componentClassName,
?TagBuilder $tagBuilder = null,
): string
{
$event = new ComponentWillBeRendered($componentRenderingData, $contentObjectRenderer);
$event = new ComponentWillBeRendered($componentRenderingData, $contentObjectRenderer, $componentClassName);
$this->eventDispatcher->dispatch($event);
return $this->renderMarkup($event->getComponentRenderingData(), $tagBuilder);

$markup = $this->renderMarkup($event->getComponentRenderingData(), $tagBuilder);
$componentWasRenderedEvent = new ComponentWasRendered(
$markup,
$event->getComponentRenderingData(),
$contentObjectRenderer,
$componentClassName,
);
$this->eventDispatcher->dispatch($componentWasRenderedEvent);
return $componentWasRenderedEvent->getMarkup();
}

public function evaluateComponent(InputData $inputData, string $componentClassName, ?ContentObjectRenderer $contentObjectRenderer = null): ComponentRenderingData
Expand Down
2 changes: 1 addition & 1 deletion Classes/ViewHelpers/RenderViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public function render(): string
return $e->getRenderingPlaceholder();
}

return $componentRenderer->renderComponent($componentRenderingData, $contentObjectRenderer, $this->tag);
return $componentRenderer->renderComponent($componentRenderingData, $contentObjectRenderer, $componentClassName, $this->tag);
}

protected function getContentObjectRenderer(): ContentObjectRenderer
Expand Down
67 changes: 58 additions & 9 deletions Tests/Unit/Rendering/ComponentRendererTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use PHPUnit\Framework\MockObject\MockObject;
use Psr\EventDispatcher\EventDispatcherInterface;
use Sinso\Webcomponents\Dto\ComponentRenderingData;
use Sinso\Webcomponents\Dto\Events\ComponentWasRendered;
use Sinso\Webcomponents\Dto\Events\ComponentWillBeRendered;
use Sinso\Webcomponents\Rendering\ComponentRenderer;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
Expand All @@ -35,7 +36,11 @@ public function rendersComponentAccordingToProvidedData(): void
->withTagName('my-element')
->withTagProperties(['class' => 'foo'])
->withTagContent('bar');
$result = $this->subject->renderComponent($componentRenderer, $this->createMock(ContentObjectRenderer::class));
$result = $this->subject->renderComponent(
$componentRenderer,
$this->createMock(ContentObjectRenderer::class),
'My\\Component\\ClassName',
);

// should roughly look like: <my-element class="foo">bar</my-element>, but don't care about whitespaces
self::assertMatchesRegularExpression(
Expand All @@ -47,26 +52,70 @@ public function rendersComponentAccordingToProvidedData(): void
#[Test]
public function inputFromComponentWillBeRenderedEventListenersIsConsidered(): void
{
$this->eventDispatcher->expects(self::once())->method('dispatch')->willReturnCallback(function ($event) {
/** @var ComponentWillBeRendered $event */
self::assertInstanceOf(ComponentWillBeRendered::class, $event);
$event->setComponentRenderingData(
$event->getComponentRenderingData()
->withTagProperty('class', 'baz')
);
$eventCallCount = 0;
$this->eventDispatcher->expects(self::exactly(2))->method('dispatch')->willReturnCallback(function ($event) use (&$eventCallCount) {
$eventCallCount++;
if ($eventCallCount === 1) {
/** @var ComponentWillBeRendered $event */
self::assertInstanceOf(ComponentWillBeRendered::class, $event);
self::assertSame('My\\Component\\ClassName', $event->componentClassName);
$event->setComponentRenderingData(
$event->getComponentRenderingData()
->withTagProperty('class', 'baz')
);
}

if ($eventCallCount === 2) {
self::assertInstanceOf(ComponentWasRendered::class, $event);
self::assertSame('My\\Component\\ClassName', $event->componentClassName);
}

return $event;
});

$componentRenderer = (new ComponentRenderingData())
->withTagName('my-element')
->withTagProperties(['class' => 'foo'])
->withTagContent('bar');
$result = $this->subject->renderComponent($componentRenderer, $this->createMock(ContentObjectRenderer::class));
$result = $this->subject->renderComponent(
$componentRenderer,
$this->createMock(ContentObjectRenderer::class),
'My\\Component\\ClassName',
);

// should roughly look like: <my-element class="baz">bar</my-element>, but don't care about whitespaces
self::assertMatchesRegularExpression(
'/<my-element\s+class="baz">\s*bar\s*<\/my-element>/',
$result,
);
}

#[Test]
public function inputFromComponentWasRenderedEventListenersIsConsidered(): void
{
$eventCallCount = 0;
$this->eventDispatcher->expects(self::exactly(2))->method('dispatch')->willReturnCallback(function ($event) use (&$eventCallCount) {
$eventCallCount++;
if ($eventCallCount === 2) {
/** @var ComponentWasRendered $event */
self::assertInstanceOf(ComponentWasRendered::class, $event);
self::assertMatchesRegularExpression('/<my-element\s+class="foo">\s*bar\s*<\/my-element>/', $event->getMarkup());
$event->setMarkup('<my-element class="after-event">from-event</my-element>');
}

return $event;
});

$componentRenderer = (new ComponentRenderingData())
->withTagName('my-element')
->withTagProperties(['class' => 'foo'])
->withTagContent('bar');
$result = $this->subject->renderComponent(
$componentRenderer,
$this->createMock(ContentObjectRenderer::class),
'My\\Component\\ClassName',
);

self::assertSame('<my-element class="after-event">from-event</my-element>', $result);
}
}