Skip to content

Commit cc08c05

Browse files
ulrichmathesulrichmathes
committed
[FEATURE] generate placeholder images internal
1 parent a529e86 commit cc08c05

File tree

5 files changed

+213
-4
lines changed

5 files changed

+213
-4
lines changed

‎Classes/Domain/Model/PlaceholderImage.php

+10-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
use SMS\FluidComponents\Interfaces\ImageWithDimensions;
66
use SMS\FluidComponents\Interfaces\ProcessableImage;
7+
use SMS\FluidComponents\Service\PlaceholderImageService;
78
use TYPO3\CMS\Core\Imaging\ImageManipulation\Area;
9+
use TYPO3\CMS\Core\Utility\GeneralUtility;
810

911
/**
1012
* Data structure for a placeholder image to be passed to a component.
@@ -29,16 +31,16 @@ class PlaceholderImage extends Image implements ImageWithDimensions, Processable
2931
/**
3032
* Image format of the image
3133
*/
32-
protected string $format = 'gif';
34+
protected string $format = 'svg';
3335

3436
/**
3537
* Creates an image object for a placeholder image.
3638
*/
37-
public function __construct(int $width, int $height, string $format = 'gif')
39+
public function __construct(int $width, int $height, ?string $format = null)
3840
{
3941
$this->width = $width;
4042
$this->height = $height;
41-
$this->format = $format;
43+
$this->format = $format ?? $this->format;
4244
}
4345

4446
public function getWidth(): int
@@ -58,7 +60,11 @@ public function getFormat(): string
5860

5961
public function getPublicUrl(): string
6062
{
61-
return 'https://via.placeholder.com/' . $this->width . 'x' . $this->height . '.' . $this->format;
63+
return GeneralUtility::makeInstance(PlaceholderImageService::class)->generate(
64+
$this->width,
65+
$this->height,
66+
$this->format,
67+
);
6268
}
6369

6470
public function process(int $width, int $height, ?string $format, Area $cropArea): ProcessableImage

‎Classes/Service/PlaceholderImageService.php

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<?php declare(strict_types=1);
2+
3+
namespace SMS\FluidComponents\Service;
4+
5+
use TYPO3\CMS\Core\Information\Typo3Version;
6+
use TYPO3\CMS\Core\Utility\GeneralUtility;
7+
use TYPO3\CMS\Core\View\ViewFactoryData;
8+
use TYPO3\CMS\Core\View\ViewFactoryInterface;
9+
use TYPO3\CMS\Fluid\View\StandaloneView;
10+
use TYPO3\CMS\Frontend\Imaging\GifBuilder;
11+
12+
class PlaceholderImageService
13+
{
14+
const int STROKE_WIDTH = 18;
15+
const int STROKE_HEIGHT = 3;
16+
const string BACKGROUND_COLOR = '#C0C0C0';
17+
const string COLOR = '#0B0B13';
18+
19+
public function __construct(
20+
private readonly GifBuilder $gifBuilder,
21+
private readonly Typo3Version $typo3Version,
22+
private readonly ?ViewFactoryInterface $viewFactory = null,
23+
) {
24+
}
25+
26+
public function generate(int $width, int $height, string $format): string
27+
{
28+
$text = sprintf('%dx%d.%s', $width, $height, $format);
29+
if ($format !== 'svg') {
30+
return $this->generateBitmap($width, $height, $format, $text);
31+
}
32+
33+
if ($this->typo3Version->getMajorVersion() < 13) {
34+
$view = new StandaloneView();
35+
$view->setTemplatePathAndFilename('EXT:fluid_components/Resources/Private/Templates/Placeholder.svg');
36+
} else {
37+
$view = $this->viewFactory->create(new ViewFactoryData(
38+
templatePathAndFilename: 'EXT:fluid_components/Resources/Private/Templates/Placeholder.svg',
39+
));
40+
}
41+
42+
$view->assignMultiple([
43+
'width' => $width,
44+
'height' => $height,
45+
'backgroundColor' => self::BACKGROUND_COLOR,
46+
'color' => self::COLOR,
47+
'text' => $text,
48+
]);
49+
return 'data:image/svg+xml;base64,' . base64_encode($view->render());
50+
}
51+
52+
private function generateBitmap(int $width, int $height, string $format, string $text): string
53+
{
54+
$configuration = [
55+
'XY' => implode(',', [$width, $height]),
56+
'backColor' => self::BACKGROUND_COLOR,
57+
'format' => $format,
58+
'10' => 'TEXT',
59+
'10.' => [
60+
'text' => $text,
61+
'fontColor' => self::COLOR,
62+
'fontSize' => round($width / 9),
63+
'align' => 'center',
64+
'offset' => implode(',', [0, $height / 1.75]),
65+
],
66+
];
67+
68+
$strokes = [
69+
[0 ,0 , self::STROKE_WIDTH, self::STROKE_HEIGHT],
70+
[0 ,0 , self::STROKE_HEIGHT, self::STROKE_WIDTH],
71+
[($width - self::STROKE_WIDTH), 0, $width , self::STROKE_HEIGHT],
72+
[($width - self::STROKE_HEIGHT), 0, $width, self::STROKE_WIDTH],
73+
[0, ($height - self::STROKE_HEIGHT), self::STROKE_WIDTH, $height],
74+
[0, ($height - self::STROKE_WIDTH), self::STROKE_HEIGHT, $height],
75+
[($width - self::STROKE_WIDTH), ($height - self::STROKE_HEIGHT), $width, $height],
76+
[($width - self::STROKE_HEIGHT), ($height - self::STROKE_WIDTH), $width, $height],
77+
];
78+
79+
foreach ($strokes as $key => $dimensions) {
80+
$configuration[10 * ($key + 2)] = 'BOX';
81+
$configuration[10 * ($key + 2) . '.'] = [
82+
'dimensions' => implode(',', $dimensions),
83+
'color' => self::COLOR,
84+
];
85+
}
86+
87+
$this->gifBuilder->start($configuration, []);
88+
return (string) $this->gifBuilder->gifBuild()->getPublicUrl();
89+
}
90+
}

‎Configuration/Services.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ services:
88
resource: '../Classes/*'
99
exclude: '../Classes/Domain/Model/*'
1010

11+
SMS\FluidComponents\Service\PlaceholderImageService:
12+
public: true
13+
1114
SMS\FluidComponents\Command\GenerateXsdCommand:
1215
tags:
1316
- name: 'console.command'

‎Resources/Private/Templates/Placeholder.svg

+24
Loading

‎Tests/Unit/Service/PlaceholderImageServiceTest.php

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<?php declare(strict_types=1);
2+
3+
namespace SMS\FluidComponents\Tests\Unit\Service;
4+
5+
use PHPUnit\Framework\MockObject\MockObject;
6+
use SMS\FluidComponents\Service\PlaceholderImageService;
7+
use TYPO3\CMS\Core\Information\Typo3Version;
8+
use TYPO3\CMS\Core\View\ViewFactoryData;
9+
use TYPO3\CMS\Core\View\ViewFactoryInterface;
10+
use TYPO3\CMS\Core\View\ViewInterface;
11+
use TYPO3\CMS\Frontend\Imaging\GifBuilder;
12+
use TYPO3\CMS\Core\Imaging\ImageResource;
13+
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
14+
15+
class PlaceholderImageServiceTest extends UnitTestCase
16+
{
17+
private PlaceholderImageService $subject;
18+
private MockObject|GifBuilder $gifBuilderMock;
19+
private MockObject|ViewFactoryInterface $viewFactoryMock;
20+
private MockObject|Typo3Version $typo3VersionMock;
21+
22+
protected function setUp(): void
23+
{
24+
parent::setUp();
25+
$this->gifBuilderMock = $this->createMock(GifBuilder::class);
26+
$this->typo3VersionMock = $this->createMock(Typo3Version::class);
27+
$this->viewFactoryMock = $this->createMock(ViewFactoryInterface::class);
28+
$this->subject = new PlaceholderImageService($this->gifBuilderMock, $this->typo3VersionMock, $this->viewFactoryMock);
29+
}
30+
31+
public function testGenerateBitmap(): void
32+
{
33+
$width = 100;
34+
$height = 50;
35+
$format = 'png';
36+
37+
$this->gifBuilderMock->expects(self::once())
38+
->method('start')
39+
->with(self::isType('array'), self::isType('array'));
40+
41+
$imageResourceMock = $this->createMock(ImageResource::class);
42+
$imageResourceMock->expects(self::once())
43+
->method('getPublicUrl')
44+
->willReturn('http://example.com/image.png');
45+
46+
$this->gifBuilderMock->expects(self::once())
47+
->method('gifBuild')
48+
->willReturn($imageResourceMock);
49+
50+
$result = $this->subject->generate($width, $height, $format);
51+
self::assertSame('http://example.com/image.png', $result);
52+
}
53+
54+
public function testGenerateSvgForTypo3Version13(): void
55+
{
56+
$width = 100;
57+
$height = 50;
58+
$format = 'svg';
59+
$text = sprintf('%dx%d.%s', $width, $height, $format);
60+
61+
$this->typo3VersionMock->method('getMajorVersion')->willReturn(13);
62+
63+
$viewMock = $this->createMock(ViewInterface::class);
64+
$viewMock->expects(self::once())
65+
->method('assignMultiple')
66+
->with([
67+
'width' => $width,
68+
'height' => $height,
69+
'backgroundColor' => PlaceholderImageService::BACKGROUND_COLOR,
70+
'color' => PlaceholderImageService::COLOR,
71+
'text' => $text,
72+
]);
73+
74+
$viewMock->expects(self::once())
75+
->method('render')
76+
->willReturn('<svg></svg>');
77+
78+
$this->viewFactoryMock->expects(self::once())
79+
->method('create')
80+
->with(self::isInstanceOf(ViewFactoryData::class))
81+
->willReturn($viewMock);
82+
83+
$result = $this->subject->generate($width, $height, $format);
84+
self::assertSame('data:image/svg+xml;base64,' . base64_encode('<svg></svg>'), $result);
85+
}
86+
}

0 commit comments

Comments
 (0)