49 | // `
50 | //}
51 |
--------------------------------------------------------------------------------
/Classes/EelHelpers/ImageSourceHelperInterface.php:
--------------------------------------------------------------------------------
1 | hasMethod('set' . $methodNamePart)) {
33 | $methodName = 'set' . $methodNamePart;
34 | $target->$methodName($dependency);
35 | } elseif ($objectReflection->hasMethod('inject' . $methodNamePart)) {
36 | $methodName = 'inject' . $methodNamePart;
37 | $target->$methodName($dependency);
38 | } elseif ($objectReflection->hasProperty($name)) {
39 | $property = $objectReflection->getProperty($name);
40 | $property->setAccessible(true);
41 | $property->setValue($target, $dependency);
42 | } else {
43 | throw new \RuntimeException('Could not inject ' . $name . ' into object of type ' . get_class($target));
44 | }
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/Classes/FusionObjects/DummyImageSourceImplementation.php:
--------------------------------------------------------------------------------
1 | fusionValue('baseWidth');
19 | }
20 |
21 | /**
22 | * @return int|null
23 | */
24 | public function getBaseHeight(): ?int
25 | {
26 | return $this->fusionValue('baseHeight');
27 | }
28 |
29 | /**
30 | * @return string|null
31 | */
32 | public function getBackgroundColor(): ?string
33 | {
34 | return $this->fusionValue('backgroundColor');
35 | }
36 |
37 | /**
38 | * @return string|null
39 | */
40 | public function getForegroundColor(): ?string
41 | {
42 | return $this->fusionValue('foregroundColor');
43 | }
44 |
45 | /**
46 | * @return string|null
47 | */
48 | public function getText(): ?string
49 | {
50 | return $this->fusionValue('text');
51 | }
52 |
53 | /**
54 | * Create helper and initialize with the default values.
55 | *
56 | * @throws MissingActionNameException
57 | *
58 | * @return ImageSourceInterface|null
59 | */
60 | public function createHelper(): ?ImageSourceInterface
61 | {
62 | return new DummyImageSource(
63 | null,
64 | $this->getTitle(),
65 | $this->getAlt(),
66 | $this->getBaseWidth(),
67 | $this->getBaseHeight(),
68 | $this->getBackgroundColor(),
69 | $this->getForegroundColor(),
70 | $this->getText()
71 | );
72 | }
73 | }
74 |
--------------------------------------------------------------------------------
/Classes/EelHelpers/DummyImageSourceHelper.php:
--------------------------------------------------------------------------------
1 | baseUri = $baseUri,
21 | null,
22 | null,
23 | 600,
24 | 400
25 | );
26 | }
27 |
28 | /**
29 | * @param int $baseWidth
30 | *
31 | * @deprecated use DummyImageSource->__construct
32 | */
33 | public function setBaseWidth(int $baseWidth): void
34 | {
35 | $this->baseWidth = $baseWidth;
36 | }
37 |
38 | /**
39 | * @param int $baseHeight
40 | *
41 | * @deprecated use DummyImageSource->__construct
42 | */
43 | public function setBaseHeight(int $baseHeight): void
44 | {
45 | $this->baseHeight = $baseHeight;
46 | }
47 |
48 | /**
49 | * @param string $backgroundColor
50 | *
51 | * @deprecated use DummyImageSource->__construct
52 | */
53 | public function setBackgroundColor(string $backgroundColor): void
54 | {
55 | $this->backgroundColor = $backgroundColor;
56 | }
57 |
58 | /**
59 | * @param string $foregroundColor
60 | *
61 | * @deprecated use DummyImageSource->__construct
62 | */
63 | public function setForegroundColor(string $foregroundColor): void
64 | {
65 | $this->foregroundColor = $foregroundColor;
66 | }
67 |
68 | /**
69 | * @param string $text
70 | *
71 | * @deprecated use DummyImageSource->__construct
72 | */
73 | public function setText($text): void
74 | {
75 | $this->text = $text;
76 | }
77 | }
78 |
--------------------------------------------------------------------------------
/Classes/FusionObjects/AssetImageSourceImplementation.php:
--------------------------------------------------------------------------------
1 | fusionValue('asset');
36 | }
37 |
38 | /**
39 | * @return bool
40 | */
41 | public function getAsync(): bool
42 | {
43 | return (bool) $this->fusionValue('async');
44 | }
45 |
46 | /**
47 | * Create helper and initialize with the default values.
48 | *
49 | * @return ImageSourceInterface|null
50 | */
51 | public function createHelper(): ?ImageSourceInterface
52 | {
53 | $asset = $this->getAsset();
54 | if ($asset === null) {
55 | return null;
56 | }
57 |
58 | if (in_array($asset->getResource()->getMediaType(), $this->nonScalableMediaTypes, true)) {
59 | $uri = $this->resourceManager->getPublicPersistentResourceUri($asset->getResource());
60 | if (is_string($uri)) {
61 | return new UriImageSource(
62 | $uri,
63 | $this->getTitle(),
64 | $this->getAlt()
65 | );
66 | } else {
67 | return null;
68 | }
69 | }
70 |
71 | $helper = new AssetImageSource(
72 | $asset,
73 | $this->getTitle(),
74 | $this->getAlt(),
75 | $this->getAsync(),
76 | null
77 | );
78 |
79 | return $helper;
80 | }
81 | }
82 |
--------------------------------------------------------------------------------
/Resources/Private/Fusion/Prototypes/Source.fusion:
--------------------------------------------------------------------------------
1 | prototype(Sitegeist.Kaleidoscope:Source) < prototype(Neos.Fusion:Component) {
2 |
3 | @propTypes {
4 | imageSource = ${PropTypes.instanceOf('\\Sitegeist\\Kaleidoscope\\Domain\\ImageSourceInterface')}
5 | }
6 |
7 | imageSource = null
8 | imageSource.@process.contextFallback = ${value || __imageSource}
9 |
10 | srcset = null
11 | srcset.@process.contextFallback = ${value || __srcset}
12 |
13 | sizes = null
14 | sizes.@process.contextFallback = ${value || __sizes}
15 |
16 | width = null
17 | width.@process.contextFallback = ${value || __width}
18 |
19 | height = null
20 | height.@process.contextFallback = ${value || __height}
21 |
22 | format = null
23 | format.@process.contextFallback = ${value || __format}
24 |
25 | quality = null
26 | quality.@process.contextFallback = ${value || __quality}
27 |
28 | type = null
29 | media = null
30 | renderDimensionAttributes = true
31 |
32 | @private {
33 | isScalableSource = ${props.imageSource && Type.instance(props.imageSource, '\\Sitegeist\\Kaleidoscope\\Domain\\ScalableImageSourceInterface')}
34 |
35 | imageSource = ${props.imageSource}
36 | imageSource.@if.hasImageSource = ${props.imageSource && Type.instance(props.imageSource, '\\Sitegeist\\Kaleidoscope\\Domain\\ImageSourceInterface')}
37 | imageSource.@process.applyDimensions = ${(props.width && props.height) ? value.withDimensions(props.width, props.height) : value}
38 | imageSource.@process.applyWidth = ${(props.width && !props.height) ? value.withWidth(props.width) : value}
39 | imageSource.@process.applyHeight = ${(props.height && !props.width) ? value.withHeight(props.height) : value}
40 | imageSource.@process.applyFormat = ${props.format ? value.withFormat(props.format) : value}
41 | imageSource.@process.applyQuality = ${props.quality ? value.withQuality(props.quality) : value}
42 |
43 | type = ${props.format ? 'image/' + props.format : props.type}
44 | }
45 |
46 | renderer = afx`
47 |
57 | `
58 | }
59 |
--------------------------------------------------------------------------------
/Classes/FusionObjects/AbstractImageSourceImplementation.php:
--------------------------------------------------------------------------------
1 | fusionValue('width');
18 | }
19 |
20 | /**
21 | * @return int|null
22 | */
23 | public function getHeight(): ?int
24 | {
25 | return $this->fusionValue('height');
26 | }
27 |
28 | /**
29 | * @return int|null
30 | */
31 | public function getQuality(): ?int
32 | {
33 | return $this->fusionValue('quality');
34 | }
35 |
36 | /**
37 | * @return string|null
38 | */
39 | public function getFormat(): ?string
40 | {
41 | return $this->fusionValue('format');
42 | }
43 |
44 | /**
45 | * @return string|null
46 | */
47 | public function getThumbnailPreset(): ?string
48 | {
49 | return $this->fusionValue('thumbnailPreset') ?? $this->fusionValue('preset');
50 | }
51 |
52 | /**
53 | * @return string|null
54 | */
55 | public function getVariantPreset(): ?string
56 | {
57 | return $this->fusionValue('variantPreset');
58 | }
59 |
60 | /**
61 | * @return string|null
62 | */
63 | public function getTitle(): ?string
64 | {
65 | return $this->fusionValue('title');
66 | }
67 |
68 | /**
69 | * @return string|null
70 | */
71 | public function getAlt(): ?string
72 | {
73 | return $this->fusionValue('alt');
74 | }
75 |
76 | /**
77 | * Create helper and initialize width and height.
78 | *
79 | * @return ImageSourceInterface|null
80 | */
81 | public function evaluate(): ?ImageSourceInterface
82 | {
83 | $helper = $this->createHelper();
84 | if ($helper === null) {
85 | return $helper;
86 | }
87 |
88 | if ($thumbnailPreset = $this->getThumbnailPreset()) {
89 | $helper = $helper->withThumbnailPreset($thumbnailPreset);
90 | }
91 |
92 | if (($variantPreset = $this->getVariantPreset()) && (strpos($variantPreset, '::') !== false)) {
93 | [$presetIdentifier, $presetVariantName] = explode('::', $variantPreset, 2);
94 | $helper = $helper->withVariantPreset($presetIdentifier, $presetVariantName);
95 | }
96 |
97 | if ($width = $this->getWidth()) {
98 | $helper = $helper->withWidth($width);
99 | }
100 |
101 | if ($height = $this->getHeight()) {
102 | $helper = $helper->withHeight($height);
103 | }
104 |
105 | if ($quality = $this->getQuality()) {
106 | $helper = $helper->withQuality($quality);
107 | }
108 |
109 | if ($format = $this->getFormat()) {
110 | $helper = $helper->withFormat($format);
111 | }
112 |
113 | if ($title = $this->getTitle()) {
114 | $helper = $helper->withTitle($title);
115 | }
116 |
117 | if ($alt = $this->getAlt()) {
118 | $helper = $helper->withAlt($alt);
119 | }
120 |
121 | return $helper;
122 | }
123 |
124 | /**
125 | * Create helper.
126 | *
127 | * @return ImageSourceInterface|null
128 | */
129 | abstract protected function createHelper(): ?ImageSourceInterface;
130 | }
131 |
--------------------------------------------------------------------------------
/Classes/Controller/DummyImageController.php:
--------------------------------------------------------------------------------
1 | dummyImageService->createDummyImage($w, $h, $bg, $fg, $t, $f);
69 |
70 | if ($dummyImage instanceof ImageInterface) {
71 | // render image
72 | try {
73 | $result = $dummyImage->get($f);
74 | } catch (\RuntimeException $e) {
75 | // Render image as png if get() method fails
76 | $result = $dummyImage->get($this->settings['dummyImage']['fallbackFormat']);
77 | }
78 | if (!$result) {
79 | throw new \RuntimeException('Something went wrong without throwing an exception');
80 | }
81 |
82 | // build result
83 | /** @phpstan-ignore-next-line */
84 | if (method_exists($this->response, 'setHttpHeader')) {
85 | $this->response->setHttpHeader('Cache-Control', 'max-age=883000000');
86 | } elseif (method_exists($this->response, 'setComponentParameter') && class_exists('\Neos\Flow\Http\Component\SetHeaderComponent')) {
87 | $this->response->setComponentParameter(\Neos\Flow\Http\Component\SetHeaderComponent::class, 'Cache-Control', 'max-age=883000000');
88 | }
89 | $this->response->setContentType('image/' . $f);
90 |
91 | return $result;
92 | } else {
93 | $this->response->setStatusCode(500);
94 | $this->response->setContentType('image/png');
95 |
96 | return file_get_contents('resource://Sitegeist.Kaleidoscope/Public/Images/imageError.png') ?: '';
97 | }
98 | } catch (\Exception $exception) {
99 | $this->logger->error($exception->getMessage(), LogEnvironment::fromMethodName(__METHOD__));
100 |
101 | // something went wrong we return the error image png
102 | $this->response->setStatusCode(500);
103 | $this->response->setContentType('image/png');
104 |
105 | return file_get_contents('resource://Sitegeist.Kaleidoscope/Public/Images/imageError.png') ?: '';
106 | }
107 | }
108 | }
109 |
--------------------------------------------------------------------------------
/Tests/Unit/Domain/AbstractScalableImageSourceTest.php:
--------------------------------------------------------------------------------
1 | logger = $this->createMock(\Psr\Log\LoggerInterface::class);
17 | }
18 |
19 | /**
20 | * @test
21 | */
22 | public function aspectRatioIsHonored()
23 | {
24 | $dummy = $this->getDummyImageSource(400, 400);
25 | $copy = $dummy->withWidth(200, true);
26 | $this->assertEquals(200, $copy->height());
27 | }
28 |
29 | /**
30 | * @test
31 | */
32 | public function srcsetIsGenerated()
33 | {
34 | $dummy = $this->getDummyImageSource(400, 400);
35 | $this->assertEquals(
36 | 'https://example.com?w=200&h=200&bg=999&fg=fff&t=Test 200w, https://example.com?w=400&h=400&bg=999&fg=fff&t=Test 400w',
37 | $dummy->srcset('200w, 400w')
38 | );
39 | }
40 |
41 | /**
42 | * @test
43 | */
44 | public function srcsetWithWidthAdheresToDefinition()
45 | {
46 | $dummy = $this->getDummyImageSource(400, 400, true);
47 | $this->assertEquals(
48 | 'https://example.com?w=200&h=200&bg=999&fg=fff&t=Test 200w, https://example.com?w=400&h=400&bg=999&fg=fff&t=Test 400w, https://example.com?w=600&h=600&bg=999&fg=fff&t=Test 600w',
49 | $dummy->srcset('200w, 400w, 600w')
50 | );
51 | }
52 |
53 | /**
54 | * If the actual image is smaller than the requested size, then the image should be returned in its original size.
55 | * @test
56 | */
57 | public function srcsetWithWidthShouldOutputOnlyAvailableSources()
58 | {
59 | $dummy = $this->getDummyImageSource(500, 500);
60 | $this->assertEquals(
61 | 'https://example.com?w=200&h=200&bg=999&fg=fff&t=Test 200w, https://example.com?w=400&h=400&bg=999&fg=fff&t=Test 400w, https://example.com?w=500&h=500&bg=999&fg=fff&t=Test 500w',
62 | $dummy->srcset('200w, 400w, 600w')
63 | );
64 | }
65 |
66 | /**
67 | * @test
68 | */
69 | public function srcsetWithRatioAdheresToDefinition()
70 | {
71 | $dummy = $this->getDummyImageSource(400, 200);
72 | $copy = $dummy->withHeight(50, true);
73 | $this->assertEquals(
74 | 'https://example.com?w=100&h=50&bg=999&fg=fff&t=Test 1x, https://example.com?w=200&h=100&bg=999&fg=fff&t=Test 2x, https://example.com?w=300&h=150&bg=999&fg=fff&t=Test 3x',
75 | $copy->srcset('1x, 2x, 3x')
76 | );
77 | }
78 |
79 | /**
80 | * If the actual image is smaller than the requested size, then the image should be returned in its original size.
81 | * @test
82 | */
83 | public function srcsetWithRatioShouldOutputOnlyAvailableSources()
84 | {
85 | $dummy = $this->getDummyImageSource(30, 12);
86 | $copy = $dummy->withWidth(20, true);
87 | $this->assertEquals(
88 | 'https://example.com?w=20&h=8&bg=999&fg=fff&t=Test 1x, https://example.com?w=30&h=12&bg=999&fg=fff&t=Test 1.5x',
89 | $copy->srcset('1x, 2x')
90 | );
91 | }
92 |
93 | /**
94 | * Log a warning if the descriptors are mixed between width and factor
95 | * @test
96 | */
97 | public function srcsetShouldWarnIfMixedDescriptors()
98 | {
99 | $dummy = $this->getDummyImageSource(650, 320);
100 | $this->logger->expects($this->once())->method('warning')->with($this->equalTo('Mixed media descriptors are not valid: [1x, 100w]'));
101 |
102 | $dummy->srcset('1x, 100w');
103 | }
104 |
105 | /**
106 | * Skip srcset descriptor if it does not match the first matched descriptor
107 | * @test
108 | */
109 | public function srcsetShouldSkipMixedDescriptors()
110 | {
111 | $dummy = $this->getDummyImageSource(500, 300);
112 | $this->assertEquals(
113 | 'https://example.com?w=200&h=120&bg=999&fg=fff&t=Test 200w, https://example.com?w=440&h=264&bg=999&fg=fff&t=Test 440w',
114 | $dummy->srcset('200w, 1x, 440w')
115 | );
116 | }
117 |
118 | /**
119 | * Log a warning if the descriptor is invalid
120 | * @test
121 | */
122 | public function srcsetShouldWarnIfMissingDescriptor()
123 | {
124 | $dummy = $this->getDummyImageSource(30, 12);
125 | $this->logger->expects($this->once())->method('warning')->with($this->equalTo('Invalid media descriptor "1a". Missing type "x" or "w"'));
126 |
127 | $dummy->srcset('1a, 10w');
128 | }
129 |
130 | /**
131 | * Should skip srcset descriptor if either width w or factor x is missing
132 | * @test
133 | */
134 | public function srcsetShouldSkipMissingDescriptors()
135 | {
136 | $dummy = $this->getDummyImageSource(200, 400);
137 | $this->assertEquals(
138 | 'https://example.com?w=100&h=200&bg=999&fg=fff&t=Test 100w, https://example.com?w=200&h=400&bg=999&fg=fff&t=Test 200w',
139 | $dummy->srcset('100w, 150, 200w')
140 | );
141 | }
142 |
143 | protected function getDummyImageSource($width, $height, $allowUpScaling = false)
144 | {
145 | $dummy = new DummyImageSource('https://example.com', 'Test', 'Test', $width, $height, '999', 'fff', 'Test', $allowUpScaling);
146 | $this->inject($dummy, 'logger', $this->logger);
147 | return $dummy;
148 | }
149 | }
--------------------------------------------------------------------------------
/Resources/Private/Fusion/Prototypes/Picture.fusion:
--------------------------------------------------------------------------------
1 | prototype(Sitegeist.Kaleidoscope:Picture) < prototype(Neos.Fusion:Component) {
2 |
3 | @styleguide {
4 | props {
5 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
6 | sources = Neos.Fusion:DataStructure {
7 | 1 = Neos.Fusion:DataStructure {
8 | srcset = '1x, 1.5x, 2x'
9 | media = 'screen and (min-width: 1600px)'
10 | }
11 | 2 = Neos.Fusion:DataStructure {
12 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
13 | text = "im am in webp format"
14 | format = 'webp'
15 | }
16 | srcset = '320w, 480w, 800w, 1000w'
17 | sizes = '(max-width: 320px) 280px, (max-width: 480px) 440px, 800px'
18 | type = 'image/webp'
19 | media = 'screen and (max-width: 1599px)'
20 | }
21 | 3 = Neos.Fusion:DataStructure {
22 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
23 | text = "im am here for printing"
24 | }
25 | media = 'print'
26 | }
27 | 4 = Neos.Fusion:DataStructure {
28 | srcset = '400w, 800w, 1600w'
29 | media = 'screen and (min-width: 2600px)'
30 | width = 800
31 | height = 300
32 | }
33 | }
34 | alt = 'Elva dressed as a fairy'
35 | }
36 |
37 | propSets {
38 | withAttributes {
39 | attributes = Neos.Fusion:DataStructure {
40 | data-foo="bar"
41 | style="border: 5px solid green;"
42 | }
43 | imgAttributes = Neos.Fusion:DataStructure {
44 | data-foo="baz"
45 | style="border: 5px solid pink;"
46 | }
47 | }
48 | }
49 | }
50 |
51 | imageSource = null
52 | srcset = null
53 | sizes = null
54 | loading = 'lazy'
55 | sources = null
56 | formats = null
57 | quality = null
58 | width = null
59 | height = null
60 | alt = ''
61 | title = null
62 | // class is deprecated in favor of attributes.class
63 | class = null
64 | attributes = Neos.Fusion:DataStructure
65 | imgAttributes = Neos.Fusion:DataStructure
66 | content = ''
67 | renderDimensionAttributes = true
68 |
69 | #
70 | # put the values that shall be applied to sources automatically to the context
71 | # to make them available to all props during evaluation
72 | #
73 | @context {
74 | __imageSource = ${this.imageSource}
75 | __srcset = ${this.srcset}
76 | __sizes = ${this.sizes}
77 | __width = ${this.width}
78 | __height = ${this.height}
79 | __format = ${this.format}
80 | __quality = ${this.quality}
81 | }
82 |
83 | @private {
84 | # apply format, width and height to the imageSource
85 | imageSource = ${props.imageSource}
86 | imageSource.@if.has = ${props.imageSource && Type.instance(props.imageSource, '\\Sitegeist\\Kaleidoscope\\Domain\\ImageSourceInterface')}
87 | imageSource.@process.applyDimensions = ${(props.width && props.height) ? value.withDimensions(props.width, props.height) : value}
88 | imageSource.@process.applyWidth = ${(props.width && !props.height) ? value.withWidth(props.width) : value}
89 | imageSource.@process.applyHeight = ${(props.height && !props.width) ? value.withHeight(props.height) : value}
90 | imageSource.@process.applyFormat = ${props.format ? value.withFormat(props.format) : value}
91 | imageSource.@process.applyQuality = ${props.quality ? value.withQuality(props.quality) : value}
92 | }
93 |
94 | renderer = afx`
95 |
96 | {props.content}
97 |
98 |
109 |
110 |
115 |
119 |
120 |
130 |
131 | `
132 | }
133 |
--------------------------------------------------------------------------------
/Classes/Domain/DummyImageSource.php:
--------------------------------------------------------------------------------
1 | baseUri = $baseUri;
82 | $this->baseWidth = $baseWidth ?? 600;
83 | $this->baseHeight = $baseHeight ?? 400;
84 | $this->backgroundColor = $backgroundColor ?? '999';
85 | $this->foregroundColor = $foregroundColor ?? 'fff';
86 | $this->text = $text ?? '';
87 | $this->allowUpScaling = $allowUpScaling;
88 | }
89 |
90 | public function supportsUpscaling(): bool
91 | {
92 | return $this->allowUpScaling;
93 | }
94 |
95 | /**
96 | * Use the variant generated from the given variant preset in this image source.
97 | *
98 | * @param string $presetIdentifier
99 | * @param string $presetVariantName
100 | *
101 | * @return ImageSourceInterface
102 | */
103 | public function withVariantPreset(string $presetIdentifier, string $presetVariantName): ImageSourceInterface
104 | {
105 | /** @var DummyImageSource $newSource */
106 | $newSource = parent::withVariantPreset($presetIdentifier, $presetVariantName);
107 |
108 | if ($newSource->targetImageVariant !== []) {
109 | $targetBox = $this->estimateDimensionsFromVariantPresetAdjustments($presetIdentifier, $presetVariantName);
110 | $newSource->baseWidth = $targetBox->getWidth();
111 | $newSource->baseHeight = $targetBox->getHeight();
112 | }
113 |
114 | return $newSource;
115 | }
116 |
117 | /**
118 | * @return string
119 | */
120 | public function src(): string
121 | {
122 | if (is_string($this->baseUri)) {
123 | $baseUri = $this->baseUri;
124 | } else {
125 | $uri = $this->uriFactory->createUri('http://localhost');
126 |
127 | $httpRequest = $this->serverRequestFactory->createServerRequest('GET', $uri)
128 | ->withAttribute(
129 | ServerRequestAttributes::ROUTING_PARAMETERS,
130 | RouteParameters::createEmpty()->withParameter('requestUriHost', $uri->getHost())
131 | );
132 |
133 | $uriBuilder = new UriBuilder();
134 | $uriBuilder->setRequest($this->actionRequestFactory->createActionRequest($httpRequest));
135 | $uriBuilder->setCreateAbsoluteUri(false);
136 |
137 | $baseUri = $uriBuilder->uriFor('image', [], 'DummyImage', 'Sitegeist.Kaleidoscope');
138 | }
139 |
140 | $arguments = [
141 | 'w' => $this->getCurrentWidth(),
142 | 'h' => $this->getCurrentHeight(),
143 | ];
144 |
145 | if ($this->backgroundColor) {
146 | $arguments['bg'] = $this->backgroundColor;
147 | }
148 |
149 | if ($this->foregroundColor) {
150 | $arguments['fg'] = $this->foregroundColor;
151 | }
152 |
153 | if ($this->text) {
154 | $arguments['t'] = $this->text;
155 | }
156 |
157 | if ($this->targetFormat) {
158 | $arguments['f'] = $this->targetFormat;
159 | }
160 |
161 | return $baseUri . '?' . http_build_query($arguments);
162 | }
163 |
164 | public function dataSrc(): string
165 | {
166 | $w = $this->getCurrentWidth() ?: 600;
167 | $h = $this->getCurrentHeight() ?: 400;
168 |
169 | $bg = $this->backgroundColor ?: '#000';
170 | $fg = $this->foregroundColor ?: '#fff';
171 | $t = $this->text ?: null;
172 | $f = $this->targetFormat ?: 'png';
173 |
174 | $dummyImage = $this->dummyImageGenerator->createDummyImage($w, $h, $bg, $fg, $t, $f);
175 | if ($dummyImage) {
176 | return 'data:image/' . $f . ';base64,' . base64_encode($dummyImage->get($f));
177 | }
178 |
179 | return '';
180 | }
181 | }
182 |
--------------------------------------------------------------------------------
/Resources/Private/Fusion/Prototypes/Image.fusion:
--------------------------------------------------------------------------------
1 | prototype(Sitegeist.Kaleidoscope:Image) < prototype(Neos.Fusion:Component) {
2 |
3 | @styleguide {
4 | props {
5 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
6 | }
7 |
8 | propSets {
9 | altAndTitleFromSource {
10 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
11 | alt = 'Alternate assigned to source'
12 | title = 'Title assigned to source'
13 | }
14 | }
15 |
16 | imageSourceWithWidth {
17 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
18 | @process.adjust = ${value.withWidth(400)}
19 | }
20 | }
21 |
22 | imageSourceWithHeight {
23 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
24 | @process.adjust = ${value.withHeight(400)}
25 | }
26 | }
27 |
28 | imageSourceWithDimensions {
29 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
30 | @process.adjust = ${value.withDimensions(400, 400)}
31 | }
32 | }
33 |
34 | imageSourceWithTitleAndAlt {
35 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
36 | @process.adjust = ${value.withAlt("Alternate assigned by eel").withTitle("Title assigned by eel")}
37 | }
38 | }
39 |
40 | imageSourceWithFormat {
41 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
42 | @process.adjust = ${value.withFormat("png")}
43 | }
44 | }
45 |
46 | overrideAltAndTitleFromProp {
47 | alt = 'Alternate assigned as prop'
48 | title = 'Title assigned as prop'
49 | }
50 |
51 | withResourceImageSource {
52 | imageSource = Sitegeist.Kaleidoscope:ResourceImageSource {
53 | path = "resource://Sitegeist.Kaleidoscope/Public/Images/imageError.png"
54 | alt = 'Alternate assigned to source'
55 | title = 'Title assigned to source'
56 | }
57 | }
58 |
59 | withUriImageSource {
60 | imageSource = Sitegeist.Kaleidoscope:UriImageSource {
61 | uri = "https://dummyimage.com/600x400/000/fff"
62 | alt = 'Alternate assigned to source'
63 | title = 'Title assigned to source'
64 | }
65 | }
66 |
67 | withAttributes {
68 | attributes = Neos.Fusion:DataStructure {
69 | data-foo="bar"
70 | style="border: 5px solid pink;"
71 | }
72 | }
73 |
74 | multires_array {
75 | srcset = ${['1x', '1.5x', '2x']}
76 | }
77 |
78 | multires_string {
79 | srcset = '1x, 1.5x, 2x'
80 | }
81 |
82 | multisize_array {
83 | srcset = ${['320w', '400w', '600w', '800w', '1000w', '1200w', '1600']}
84 | }
85 |
86 | multisize_string {
87 | srcset = '320w, 400ww, 600w, 800w, 1000w, 1200w, 1600'
88 | }
89 |
90 | sizes_array {
91 | srcset = ${['320w', '400w', '600w', '800w', '1000w', '1200w', '1600']}
92 | sizes = ${['(max-width: 320px) 280px', '(max-width: 480px) 440px', '800px']}
93 | }
94 |
95 | sizes_string {
96 | srcset = '320w, 400ww, 600w, 800w, 1000w, 1200w, 1600'
97 | sizes = '(max-width: 320px) 280px, (max-width: 480px) 440px, 800px'
98 | }
99 |
100 | nonScalabelSource {
101 | imageSource = Sitegeist.Kaleidoscope:UriImageSource {
102 | uri = "https://dummyimage.com/600x400/000/fff"
103 | alt = 'Alternate assigned to source'
104 | title = 'Title assigned to source'
105 | }
106 | srcset = '320w, 400ww, 600w, 800w, 1000w, 1200w, 1600'
107 | sizes = '(max-width: 320px) 280px, (max-width: 480px) 440px, 800px'
108 | }
109 | }
110 | }
111 |
112 | @propTypes {
113 | imageSource = ${PropTypes.instanceOf('\\Sitegeist\\Kaleidoscope\\Domain\\ImageSourceInterface')}
114 | }
115 |
116 | imageSource = null
117 | srcset = null
118 | sizes = null
119 | alt = null
120 | title = null
121 | // class is deprecated in favor of attributes.class
122 | class = null
123 | loading = 'lazy'
124 | width = null
125 | height = null
126 | format = null
127 | quality = null
128 | attributes = Neos.Fusion:DataStructure
129 | renderDimensionAttributes = true
130 |
131 | @private {
132 | # detect scalable sources
133 | isScalableSource = ${props.imageSource && Type.instance(props.imageSource, '\\Sitegeist\\Kaleidoscope\\Domain\\ScalableImageSourceInterface')}
134 |
135 | # apply format, width and height to the imageSource
136 | imageSource = ${props.imageSource}
137 | imageSource.@if.hasImageSource = ${props.imageSource && Type.instance(props.imageSource, '\\Sitegeist\\Kaleidoscope\\Domain\\ImageSourceInterface')}
138 | imageSource.@process.applyDimensions = ${(props.width && props.height) ? value.withDimensions(props.width, props.height) : value}
139 | imageSource.@process.applyWidth = ${(props.width && !props.height) ? value.withWidth(props.width) : value}
140 | imageSource.@process.applyHeight = ${(props.height && !props.width) ? value.withHeight(props.height) : value}
141 | imageSource.@process.applyFormat = ${props.format ? value.withFormat(props.format) : value}
142 | imageSource.@process.applyQuality = ${props.quality ? value.withQuality(props.quality) : value}
143 | }
144 |
145 | renderer = afx`
146 |
162 | `
163 | }
164 |
--------------------------------------------------------------------------------
/Classes/Domain/AssetImageSource.php:
--------------------------------------------------------------------------------
1 | asset = $asset;
90 | $this->request = $request;
91 | $this->async = $async;
92 | $this->baseWidth = $this->asset->getWidth();
93 | $this->baseHeight = $this->asset->getHeight();
94 | }
95 |
96 | public function supportsUpscaling(): bool
97 | {
98 | return false;
99 | }
100 |
101 | /**
102 | * Use the variant generated from the given variant preset in this image source.
103 | *
104 | * @param string $presetIdentifier
105 | * @param string $presetVariantName
106 | *
107 | * @return ImageSourceInterface
108 | */
109 | public function withVariantPreset(string $presetIdentifier, string $presetVariantName): ImageSourceInterface
110 | {
111 | /**
112 | * @var AssetImageSource $newSource
113 | */
114 | $newSource = parent::withVariantPreset($presetIdentifier, $presetVariantName);
115 |
116 | if ($newSource->targetImageVariant !== []) {
117 | $asset = ($newSource->asset instanceof AssetVariantInterface && $newSource->asset instanceof ImageInterface) ? $newSource->asset->getOriginalAsset() : $newSource->asset;
118 | if ($asset instanceof VariantSupportInterface) {
119 | $assetVariant = $asset->getVariant($newSource->targetImageVariant['presetIdentifier'], $newSource->targetImageVariant['presetVariantName']);
120 | } else {
121 | $assetVariant = null;
122 | }
123 | if ($assetVariant instanceof AssetVariantInterface && $assetVariant instanceof ImageInterface) {
124 | $newSource->asset = $assetVariant;
125 | $newSource->baseWidth = $assetVariant->getWidth();
126 | $newSource->baseHeight = $assetVariant->getHeight();
127 | } else {
128 | // if no alternate variant is found we estimate the target dimensions
129 | $targetDimensions = $this->estimateDimensionsFromVariantPresetAdjustments($presetIdentifier, $presetVariantName);
130 | $newSource->baseWidth = $targetDimensions->getWidth();
131 | $newSource->baseHeight = $targetDimensions->getHeight();
132 | }
133 | }
134 |
135 | return $newSource;
136 | }
137 |
138 | /**
139 | * @throws \Neos\Flow\Mvc\Routing\Exception\MissingActionNameException
140 | * @throws \Neos\Media\Exception\AssetServiceException
141 | * @throws \Neos\Media\Exception\ThumbnailServiceException
142 | *
143 | * @return string
144 | */
145 | public function src(): string
146 | {
147 | if (!$this->asset instanceof AssetInterface) {
148 | return '';
149 | }
150 |
151 | if ($this->srcCache !== null) {
152 | return $this->srcCache;
153 | }
154 |
155 | $width = $this->getCurrentWidth();
156 | $height = $this->getCurrentHeight();
157 |
158 | $allowCropping = true;
159 | $allowUpScaling = $this->supportsUpscaling();
160 | $thumbnailConfiguration = new ThumbnailConfiguration(
161 | $width,
162 | $width,
163 | $height,
164 | $height,
165 | $allowCropping,
166 | $allowUpScaling,
167 | $this->async,
168 | $this->targetQuality,
169 | $this->targetFormat
170 | );
171 |
172 | if ($this->request instanceof ActionRequest) {
173 | $request = $this->request;
174 | } else {
175 | $uri = $this->uriFactory->createUri('http://localhost');
176 | $httpRequest = $this->serverRequestFactory->createServerRequest('GET', $uri)
177 | ->withAttribute(
178 | ServerRequestAttributes::ROUTING_PARAMETERS,
179 | RouteParameters::createEmpty()->withParameter('requestUriHost', $uri->getHost())
180 | );
181 | $request = $this->actionRequestFactory->createActionRequest($httpRequest);
182 | }
183 |
184 | $thumbnailData = $this->assetService->getThumbnailUriAndSizeForAsset(
185 | $this->asset,
186 | $thumbnailConfiguration,
187 | $request
188 | );
189 |
190 | $this->srcCache = ($thumbnailData === null) ? '' : $thumbnailData['src'];
191 |
192 | return $this->srcCache;
193 | }
194 |
195 | public function __clone(): void
196 | {
197 | $this->srcCache = null;
198 | }
199 |
200 | public function dataSrc(): string
201 | {
202 | if (!$this->asset instanceof AssetInterface) {
203 | return '';
204 | }
205 |
206 | $width = $this->getCurrentWidth();
207 | $height = $this->getCurrentHeight();
208 |
209 | $allowCropping = true;
210 | $allowUpScaling = $this->supportsUpscaling();
211 | $thumbnailConfiguration = new ThumbnailConfiguration(
212 | $width,
213 | $width,
214 | $height,
215 | $height,
216 | $allowCropping,
217 | $allowUpScaling,
218 | false,
219 | $this->targetQuality,
220 | $this->targetFormat
221 | );
222 |
223 | $thumbnailImage = $this->thumbnailService->getThumbnail($this->asset, $thumbnailConfiguration);
224 |
225 | if ($thumbnailImage instanceof ImageInterface) {
226 | if ($stream = $thumbnailImage->getResource()->getStream()) {
227 | if (is_resource($stream)) {
228 | if ($content = stream_get_contents($stream)) {
229 | $mediaType = $thumbnailImage->getResource()->getMediaType();
230 | if (is_string($content)) {
231 | return 'data:' . $mediaType . ';base64,' . base64_encode($content);
232 | }
233 | }
234 | }
235 | }
236 | }
237 |
238 | return '';
239 | }
240 | }
241 |
--------------------------------------------------------------------------------
/Classes/Domain/AbstractImageSource.php:
--------------------------------------------------------------------------------
1 | title = $title;
77 | $this->alt = $alt;
78 | }
79 |
80 | /**
81 | * @deprecated
82 | */
83 | public function setWidth(int $targetWidth, bool $preserveAspect = false): ImageSourceInterface
84 | {
85 | $this->logger->warning('Deprecated method "ImageSource->setWidth" is used that will be removed with kaleidoscope 8. Use "withWidth" instead!', LogEnvironment::fromMethodName(__METHOD__));
86 | return $this->withWidth($targetWidth, $preserveAspect);
87 | }
88 |
89 | public function withWidth(int $targetWidth, bool $preserveAspect = false): ImageSourceInterface
90 | {
91 | $newSource = clone $this;
92 | $newSource->targetWidth = $targetWidth;
93 |
94 | return $newSource;
95 | }
96 |
97 | /**
98 | * @deprecated
99 | */
100 | public function setHeight(int $targetHeight, bool $preserveAspect = false): ImageSourceInterface
101 | {
102 | $this->logger->warning('Deprecated method "ImageSource->setHeight" is used that will be removed with kaleidoscope 8. Use "withHeight" instead!', LogEnvironment::fromMethodName(__METHOD__));
103 | return $this->withHeight($targetHeight, $preserveAspect);
104 | }
105 |
106 | public function withHeight(int $targetHeight, bool $preserveAspect = false): ImageSourceInterface
107 | {
108 | $newSource = clone $this;
109 | $newSource->targetHeight = $targetHeight;
110 |
111 | return $newSource;
112 | }
113 |
114 | /**
115 | * @deprecated
116 | */
117 | public function setQuality(int $quality): ImageSourceInterface
118 | {
119 | $this->logger->warning('Deprecated method "ImageSource->setQuality" is used that will be removed with kaleidoscope 8. Use "withQuality" instead!', LogEnvironment::fromMethodName(__METHOD__));
120 | return $this->withQuality($quality);
121 | }
122 |
123 | public function withQuality(int $quality): ImageSourceInterface
124 | {
125 | $newSource = clone $this;
126 | $newSource->targetQuality = $quality;
127 |
128 | return $newSource;
129 | }
130 |
131 | /**
132 | * @deprecated
133 | */
134 | public function setFormat(string $format): ImageSourceInterface
135 | {
136 | $this->logger->warning('Deprecated method "ImageSource->setFormat" is used that will be removed with kaleidoscope 8. Use "withFormat" instead!', LogEnvironment::fromMethodName(__METHOD__));
137 | return $this->withFormat($format);
138 | }
139 |
140 | public function withFormat(string $format): ImageSourceInterface
141 | {
142 | $newSource = clone $this;
143 | $newSource->targetFormat = $format;
144 |
145 | return $newSource;
146 | }
147 |
148 | /**
149 | * @deprecated
150 | */
151 | public function setDimensions(int $targetWidth, int $targetHeight): ImageSourceInterface
152 | {
153 | $this->logger->warning('Deprecated method "ImageSource->setDimensions" is used that will be removed with kaleidoscope 8. Use "withDimensions" instead!', LogEnvironment::fromMethodName(__METHOD__));
154 | return $this->withDimensions($targetWidth, $targetHeight);
155 | }
156 |
157 | public function withDimensions(int $targetWidth, int $targetHeight): ImageSourceInterface
158 | {
159 | $newSource = clone $this;
160 | $newSource->targetWidth = $targetWidth;
161 | $newSource->targetHeight = $targetHeight;
162 |
163 | return $newSource;
164 | }
165 |
166 | /**
167 | * @deprecated use applyThumbnailPreset
168 | */
169 | public function applyPreset(string $name): ImageSourceInterface
170 | {
171 | $this->logger->warning('Deprecated method "ImageSource->applyPreset" is used that will be removed with kaleidoscope 8. Use "withThumbnailPreset" instead!', LogEnvironment::fromMethodName(__METHOD__));
172 | return $this->withThumbnailPreset($name);
173 | }
174 |
175 | /**
176 | * @deprecated
177 | */
178 | public function applyThumbnailPreset(string $name): ImageSourceInterface
179 | {
180 | $this->logger->warning('Deprecated method "ImageSource->applyThumbnailPreset" is used that will be removed with kaleidoscope 8. Use "withThumbnailPreset" instead!', LogEnvironment::fromMethodName(__METHOD__));
181 | return $this->withThumbnailPreset($name);
182 | }
183 |
184 | public function withThumbnailPreset(string $name): ImageSourceInterface
185 | {
186 | $newSource = clone $this;
187 | if (isset($this->thumbnailPresets[$name])) {
188 | $preset = $this->thumbnailPresets[$name];
189 | if ($width = $preset['width'] ?? null) {
190 | $newSource = $newSource->withWidth($width);
191 | } elseif ($width = $preset['maximumWidth'] ?? null) {
192 | $newSource = $newSource->withWidth($width);
193 | }
194 | if ($height = $preset['height'] ?? null) {
195 | $newSource = $newSource->withHeight($height);
196 | } elseif ($height = $preset['maximumHeight'] ?? null) {
197 | $newSource = $newSource->withHeight($height);
198 | }
199 | } else {
200 | $this->logger->warning(sprintf('Thumbnail preset "%s" is not configured', $name), LogEnvironment::fromMethodName(__METHOD__));
201 | }
202 |
203 | return $newSource;
204 | }
205 |
206 | /**
207 | * @deprecated
208 | */
209 | public function useVariantPreset(string $presetIdentifier, string $presetVariantName): ImageSourceInterface
210 | {
211 | $this->logger->warning('Deprecated method "ImageSource->useVariantPreset" is used that will be removed with kaleidoscope 8. Use "withVariantPreset" instead!', LogEnvironment::fromMethodName(__METHOD__));
212 | return $this->withVariantPreset($presetIdentifier, $presetVariantName);
213 | }
214 |
215 | public function withVariantPreset(string $presetIdentifier, string $presetVariantName): ImageSourceInterface
216 | {
217 | if (!isset($this->variantPresets[$presetIdentifier]['variants'][$presetVariantName])) {
218 | $this->logger->warning(sprintf('Variant "%s" of preset "%s" is not configured', $presetVariantName, $presetIdentifier), LogEnvironment::fromMethodName(__METHOD__));
219 | }
220 |
221 | $newSource = clone $this;
222 | $newSource->targetImageVariant = ['presetIdentifier' => $presetIdentifier, 'presetVariantName' => $presetVariantName];
223 |
224 | return $newSource;
225 | }
226 |
227 | /**
228 | * Render sourceset Attribute non-scalable media.
229 | *
230 | * @param mixed $mediaDescriptors
231 | *
232 | * @return string
233 | */
234 | public function srcset($mediaDescriptors): string
235 | {
236 | return $this->src();
237 | }
238 |
239 | /**
240 | * @deprecated use withTitle
241 | */
242 | public function setTitle(?string $title): void
243 | {
244 | $this->logger->warning('Deprecated method "ImageSource->setTitle" is used that will be removed with kaleidoscope 8. Use "withTitle" instead!', LogEnvironment::fromMethodName(__METHOD__));
245 | $this->title = $title;
246 | }
247 |
248 | public function withTitle(?string $title): ImageSourceInterface
249 | {
250 | $newSource = clone $this;
251 | $newSource->title = $title;
252 |
253 | return $newSource;
254 | }
255 |
256 | /**
257 | * @deprecated use withAlt
258 | */
259 | public function setAlt(?string $alt): void
260 | {
261 | $this->logger->warning('Deprecated method "ImageSource->setAlt" is used that will be removed with kaleidoscope 8. Use "withAlt" instead!', LogEnvironment::fromMethodName(__METHOD__));
262 | $this->alt = $alt;
263 | }
264 |
265 | public function withAlt(?string $alt): ImageSourceInterface
266 | {
267 | $newSource = clone $this;
268 | $newSource->alt = $alt;
269 |
270 | return $newSource;
271 | }
272 |
273 | public function title(): ?string
274 | {
275 | return $this->title;
276 | }
277 |
278 | public function alt(): ?string
279 | {
280 | return $this->alt;
281 | }
282 |
283 | public function width(): ?int
284 | {
285 | return null;
286 | }
287 |
288 | public function height(): ?int
289 | {
290 | return null;
291 | }
292 |
293 | /**
294 | * Define which methods are available in the Eel context.
295 | *
296 | * @param string $methodName
297 | *
298 | * @return bool
299 | */
300 | public function allowsCallOfMethod($methodName)
301 | {
302 | if (
303 | in_array(
304 | $methodName,
305 | [
306 | 'withAlt',
307 | 'withTitle',
308 | 'withDimensions',
309 | 'withFormat',
310 | 'withQuality',
311 | 'withWidth',
312 | 'withHeight',
313 | 'withThumbnailPreset',
314 | 'withVariantPreset',
315 |
316 | 'setWidth',
317 | 'setHeight',
318 | 'setDimensions',
319 | 'setFormat',
320 | 'setQuality',
321 | 'applyPreset',
322 | 'applyThumbnailPreset',
323 | 'useVariantPreset',
324 |
325 | 'src',
326 | 'dataSrc',
327 | 'srcset',
328 | 'title',
329 | 'alt',
330 | 'width',
331 | 'height',
332 | ]
333 | )
334 | ) {
335 | return true;
336 | }
337 |
338 | return false;
339 | }
340 |
341 | /**
342 | * If the source is cast to string the default source is returned.
343 | *
344 | * @return string
345 | */
346 | public function __toString(): string
347 | {
348 | try {
349 | return $this->src();
350 | } catch (\Exception $e) {
351 | return $e->getMessage();
352 | }
353 | }
354 | }
355 |
--------------------------------------------------------------------------------
/Classes/Domain/AbstractScalableImageSource.php:
--------------------------------------------------------------------------------
1 | targetWidth = $targetWidth;
49 | if ($preserveAspect === true) {
50 | if ($this->targetWidth && $this->targetHeight) {
51 | $aspect = $this->targetWidth / $this->targetHeight;
52 | } else {
53 | $aspect = $this->baseWidth / $this->baseHeight;
54 | }
55 | $newSource->targetHeight = (int) round($targetWidth / $aspect);
56 | }
57 |
58 | return $newSource;
59 | }
60 |
61 | /**
62 | * @param int|null $targetHeight
63 | * @param bool $preserveAspect
64 | *
65 | * @return ScalableImageSourceInterface
66 | */
67 | public function withHeight(?int $targetHeight = null, bool $preserveAspect = false): ScalableImageSourceInterface
68 | {
69 | $newSource = clone $this;
70 | $newSource->targetHeight = $targetHeight;
71 | if ($preserveAspect === true) {
72 | if ($this->targetWidth && $this->targetHeight) {
73 | $aspect = $this->targetWidth / $this->targetHeight;
74 | } else {
75 | $aspect = $this->baseWidth / $this->baseHeight;
76 | }
77 | $newSource->targetWidth = (int) round($targetHeight * $aspect);
78 | }
79 |
80 | return $newSource;
81 | }
82 |
83 | /**
84 | * @param int $targetWidth
85 | * @param int $targetHeight
86 | *
87 | * @return ScalableImageSourceInterface
88 | */
89 | public function withDimensions(int $targetWidth, int $targetHeight): ScalableImageSourceInterface
90 | {
91 | $newSource = clone $this;
92 | $newSource->targetWidth = $targetWidth;
93 | $newSource->targetHeight = $targetHeight;
94 |
95 | return $newSource;
96 | }
97 |
98 |
99 | /**
100 | * @param float $factor
101 | *
102 | * @return ScalableImageSourceInterface
103 | */
104 | public function scale(float $factor): ScalableImageSourceInterface
105 | {
106 | $scaledHelper = clone $this;
107 |
108 | if ($this->targetWidth && $this->targetHeight) {
109 | $scaledHelper = $scaledHelper->withDimensions((int) round($factor * $this->targetWidth), (int) round($factor * $this->targetHeight));
110 | } elseif ($this->targetWidth) {
111 | $scaledHelper = $scaledHelper->withWidth((int) round($factor * $this->targetWidth));
112 | } elseif ($this->targetHeight) {
113 | $scaledHelper = $scaledHelper->withHeight((int) round($factor * $this->targetHeight));
114 | } else {
115 | $scaledHelper = $scaledHelper->withWidth((int) round($factor * $this->baseWidth));
116 | }
117 |
118 | return $scaledHelper;
119 | }
120 |
121 | /**
122 | * @deprecated use width()
123 | */
124 | public function getCurrentWidth(): ?int
125 | {
126 | return $this->width();
127 | }
128 |
129 | public function width(): ?int
130 | {
131 | if ($this->targetWidth) {
132 | return $this->targetWidth;
133 | }
134 |
135 | if ($this->targetHeight) {
136 | return (int) round($this->targetHeight * $this->baseWidth / $this->baseHeight);
137 | }
138 |
139 | return $this->baseWidth;
140 | }
141 |
142 | /**
143 | * @deprecated use height()
144 | */
145 | public function getCurrentHeight(): ?int
146 | {
147 | return $this->height();
148 | }
149 |
150 | public function height(): ?int
151 | {
152 | if ($this->targetHeight) {
153 | return $this->targetHeight;
154 | }
155 |
156 | if ($this->targetWidth) {
157 | return (int) round($this->targetWidth * $this->baseHeight / $this->baseWidth);
158 | }
159 |
160 | return $this->baseHeight;
161 | }
162 |
163 | /**
164 | * @param string $presetIdentifier
165 | * @param string $presetVariantName
166 | *
167 | * @return Box
168 | */
169 | protected function estimateDimensionsFromVariantPresetAdjustments(string $presetIdentifier, string $presetVariantName): Box
170 | {
171 | $imageBox = new Box(
172 | $this->baseWidth,
173 | $this->baseHeight
174 | );
175 |
176 | $assetVariantPreset = VariantPreset::fromConfiguration($this->variantPresets[$presetIdentifier]);
177 | foreach ($assetVariantPreset->variants()[$presetVariantName]->adjustments() as $adjustmentConfiguration) {
178 | $adjustment = $this->createAdjustment($adjustmentConfiguration);
179 |
180 | switch (true) {
181 | case $adjustment instanceof ResizeImageAdjustment:
182 | $image = $this->imagineService->create($imageBox);
183 | if ($adjustment->canBeApplied($image)) {
184 | $image = $adjustment->applyToImage($image);
185 |
186 | /** @phpstan-ignore-next-line */
187 | return new Box((int) round($image->getSize()->getWidth()), (int) round($image->getSize()->getHeight()));
188 | }
189 | break;
190 | case $adjustment instanceof CropImageAdjustment:
191 | $desiredAspectRatio = $adjustment->getAspectRatio();
192 | if ($desiredAspectRatio !== null) {
193 | [, , $newWidth, $newHeight] = CropImageAdjustment::calculateDimensionsByAspectRatio($this->baseWidth, $this->baseHeight, $desiredAspectRatio);
194 | } else {
195 | $newWidth = $adjustment->getWidth();
196 | $newHeight = $adjustment->getHeight();
197 | }
198 |
199 | return new Box(
200 | (int) round($newWidth),
201 | (int) round($newHeight)
202 | );
203 | }
204 | }
205 |
206 | return $imageBox;
207 | }
208 |
209 | /**
210 | * @param Adjustment $adjustmentConfiguration
211 | *
212 | * @return ImageAdjustmentInterface
213 | */
214 | protected function createAdjustment(Adjustment $adjustmentConfiguration): ImageAdjustmentInterface
215 | {
216 | $adjustmentClassName = $adjustmentConfiguration->type();
217 | if (!class_exists($adjustmentClassName)) {
218 | throw new \RuntimeException(sprintf('Unknown image variant adjustment type "%s".', $adjustmentClassName), 1568213194);
219 | }
220 | $adjustment = new $adjustmentClassName();
221 | if (!$adjustment instanceof ImageAdjustmentInterface) {
222 | throw new \RuntimeException(sprintf('Image variant adjustment "%s" does not implement "%s".', $adjustmentClassName, ImageAdjustmentInterface::class), 1568213198);
223 | }
224 | foreach ($adjustmentConfiguration->options() as $key => $value) {
225 | ObjectAccess::setProperty($adjustment, $key, $value);
226 | }
227 |
228 | if (!$adjustment instanceof ImageAdjustmentInterface) {
229 | throw new \RuntimeException(sprintf('Could not apply the %s adjustment to image because it does not implement the ImageAdjustmentInterface.', get_class($adjustment)), 1381400362);
230 | }
231 |
232 | return $adjustment;
233 | }
234 |
235 | /**
236 | * Render srcset Attribute for various media descriptors.
237 | *
238 | * If upscaling is not allowed and the width is greater than the base width,
239 | * use the base width.
240 | *
241 | * @param $mediaDescriptors
242 | *
243 | * @return string
244 | */
245 | public function srcset($mediaDescriptors): string
246 | {
247 | $srcsetArray = [];
248 |
249 | if (is_array($mediaDescriptors) || $mediaDescriptors instanceof \Traversable) {
250 | $descriptors = $mediaDescriptors;
251 | } else {
252 | $descriptors = Arrays::trimExplode(',', (string)$mediaDescriptors);
253 | }
254 |
255 | $srcsetType = null;
256 | $maxScaleFactor = min($this->baseWidth / $this->width(), $this->baseHeight / $this->height());
257 |
258 | foreach ($descriptors as $descriptor) {
259 | $hasDescriptor = preg_match('/^(?[0-9]+)w$|^(?[0-9\\.]+)x$/u', $descriptor, $matches, PREG_UNMATCHED_AS_NULL);
260 |
261 | if (!$hasDescriptor) {
262 | $this->logger->warning(sprintf('Invalid media descriptor "%s". Missing type "x" or "w"', $descriptor), LogEnvironment::fromMethodName(__METHOD__));
263 | continue;
264 | }
265 |
266 | if (!$srcsetType) {
267 | $srcsetType = isset($matches['width']) ? 'width' : 'factor';
268 | } elseif (($srcsetType === 'width' && isset($matches['factor'])) || ($srcsetType === 'factor' && isset($matches['width']))) {
269 | $this->logger->warning(sprintf('Mixed media descriptors are not valid: [%s]', implode(', ', is_array($descriptors) ? $descriptors : iterator_to_array($descriptors))), LogEnvironment::fromMethodName(__METHOD__));
270 | continue;
271 | }
272 |
273 | if ($srcsetType === 'width') {
274 | $width = (int)$matches['width'];
275 | $scaleFactor = $width / $this->width();
276 | if (!$this->supportsUpscaling() && ($width / $this->baseWidth > 1)) {
277 | $srcsetArray[] = $this->src() . ' ' . $this->baseWidth . 'w';
278 | } else {
279 | $scaled = $this->scale($scaleFactor);
280 | $srcsetArray[] = $scaled->src() . ' ' . $width . 'w';
281 | }
282 | } elseif ($srcsetType === 'factor') {
283 | $factor = (float)$matches['factor'];
284 | if (
285 | !$this->supportsUpscaling() && (
286 | ($this->targetHeight && ($maxScaleFactor < $factor)) ||
287 | ($this->targetWidth && ($maxScaleFactor < $factor))
288 | )
289 | ) {
290 | $scaled = $this->scale($maxScaleFactor);
291 | $srcsetArray[] = $scaled->src() . ' ' . $maxScaleFactor . 'x';
292 | } else {
293 | $scaled = $this->scale($factor);
294 | $srcsetArray[] = $scaled->src() . ' ' . $factor . 'x';
295 | }
296 | }
297 | }
298 |
299 | return implode(', ', array_unique($srcsetArray));
300 | }
301 | }
302 |
--------------------------------------------------------------------------------
/Classes/Domain/DummyImageGenerator.php:
--------------------------------------------------------------------------------
1 | settings['dummyImage']['overrideImagineDriver']) && $this->settings['dummyImage']['overrideImagineDriver'] !== false) {
48 | $className = 'Imagine\\' . $this->settings['dummyImage']['overrideImagineDriver'] . '\\Imagine';
49 | if (is_a($className, ImagineInterface::class, true)) {
50 | $this->imagineService = new $className();
51 | } else {
52 | throw new \Exception($className . ' does not implement the ImagineInterface');
53 | }
54 | }
55 | }
56 |
57 | /**
58 | * Get a dummy-image.
59 | *
60 | * @param int $w
61 | * @param int $h
62 | * @param string $bg
63 | * @param string $fg
64 | * @param string|null $t
65 | * @param string $f
66 | *
67 | * @return ?ImageInterface
68 | */
69 | public function createDummyImage(int $w = 600, int $h = 400, string $bg = '#000', string $fg = '#fff', ?string $t = null, string $f = 'png'): ?ImageInterface
70 | {
71 | // limit input arguments
72 | if ($w > 9999) {
73 | $w = 9999;
74 | } elseif ($w < 10) {
75 | $w = 10;
76 | }
77 |
78 | if ($h > 9999) {
79 | $h = 9999;
80 | } elseif ($h < 10) {
81 | $h = 10;
82 | }
83 |
84 | $width = $w;
85 | $height = $h;
86 |
87 | try {
88 | $palette = new Palette\RGB();
89 | $backgroundColor = $palette->color($bg);
90 | $foregroundColor = $palette->color($fg);
91 |
92 | // create image
93 | $imageBox = new Box($width, $height);
94 | $image = $this->imagineService->create($imageBox);
95 | $image->usePalette($palette);
96 |
97 | $renderBorder = ($width >= 70 && $height >= 70);
98 | $renderShape = ($width >= 200 && $height >= 100);
99 | $renderText = ($width >= 50 && $height >= 30);
100 | $renderPattern = ($width >= 20 && $height >= 20);
101 |
102 | $this->renderBackground($image, $foregroundColor, $backgroundColor, $width, $height);
103 |
104 | if ($renderShape) {
105 | $this->renderShape($image, $foregroundColor, $backgroundColor, $width, $height);
106 | }
107 |
108 | if ($renderBorder) {
109 | $this->renderBorder($image, $foregroundColor, $backgroundColor, $width, $height);
110 | }
111 |
112 | if ($renderText) {
113 | $text = trim((string) $t) ?: sprintf('%s×%s', $width, $height);
114 | $this->renderText($image, $foregroundColor, $width, $height, $text, $renderShape ? false : true);
115 | }
116 |
117 | if ($renderPattern) {
118 | $this->renderPattern($image, $renderShape ? $backgroundColor : $foregroundColor, $width, $height);
119 | }
120 |
121 | return $image;
122 | } catch (\Exception $exception) {
123 | return null;
124 | }
125 | }
126 |
127 | /**
128 | * @param ImageInterface $image
129 | * @param ColorInterface $foregroundColor
130 | * @param ColorInterface $backgroundColor
131 | * @param int $width
132 | * @param int $height
133 | */
134 | protected function renderBackground(ImageInterface $image, ColorInterface $foregroundColor, ColorInterface $backgroundColor, int $width, int $height): void
135 | {
136 | $image->draw()->polygon(
137 | [
138 | new Point(0, 0),
139 | new Point($width, 0),
140 | new Point($width, $height),
141 | new Point(0, $height),
142 | ],
143 | $backgroundColor,
144 | true,
145 | 1
146 | );
147 | }
148 |
149 | /**
150 | * @param ImageInterface $image
151 | * @param ColorInterface $foregroundColor
152 | * @param ColorInterface $backgroundColor
153 | * @param int $width
154 | * @param int $height
155 | */
156 | protected function renderShape(ImageInterface $image, ColorInterface $foregroundColor, ColorInterface $backgroundColor, int $width, int $height): void
157 | {
158 | $imageAspectRatio = $width / $height;
159 | $baseShapeWidth = 600;
160 | $baseShapeHeight = 400;
161 | $baseShapeAspectRatio = $baseShapeWidth / $baseShapeHeight;
162 |
163 | /**
164 | * @var Point[] $baseShape
165 | */
166 | $baseShape = [
167 | new Point(0, 250), // left ground
168 | new Point(0, 0), // left top
169 | new Point(600, 0), // right top
170 | new Point(600, 250), // right ground
171 | new Point(580, 250),
172 |
173 | new Point(440, 110), // small mountain
174 | new Point(360, 190), // saddle
175 | new Point(220, 50), // big mountain
176 |
177 | new Point(20, 250),
178 | ];
179 |
180 | // transform shape to center of the image
181 | $factor = ($imageAspectRatio > $baseShapeAspectRatio) ? (float) $height / (float) $baseShapeHeight : (float) $width / (float) $baseShapeWidth;
182 | $xOffset = ($imageAspectRatio > $baseShapeAspectRatio) ? ($width - ($baseShapeWidth * $factor)) / 2.0 : 0.0;
183 | $yOffset = ($imageAspectRatio < $baseShapeAspectRatio) ? ($height - ($baseShapeHeight * $factor)) / 2.0 : 0.0;
184 |
185 | /**
186 | * @var Point[] $transformedShape
187 | */
188 | $transformedShape = array_map(
189 | static function (Point $point) use ($factor, $xOffset, $yOffset) {
190 | return new Point((int) ($point->getX() * $factor + $xOffset), (int) ($point->getY() * $factor + $yOffset));
191 | },
192 | $baseShape
193 | );
194 |
195 | // adjust some points based on aspect ratio
196 | $transformedShape[0] = new Point(0, $transformedShape[0]->getY());
197 | $transformedShape[1] = new Point(0, 0);
198 | $transformedShape[2] = new Point($width, 0);
199 | $transformedShape[3] = new Point($width, $transformedShape[3]->getY());
200 |
201 | // draw shape
202 | $image->draw()->polygon(
203 | $transformedShape,
204 | $foregroundColor,
205 | true,
206 | 1
207 | );
208 | }
209 |
210 | /**
211 | * @param ImageInterface $image
212 | * @param ColorInterface $foregroundColor
213 | * @param ColorInterface $backgroundColor
214 | * @param int $width
215 | * @param int $height
216 | */
217 | protected function renderBorder(ImageInterface $image, ColorInterface $foregroundColor, ColorInterface $backgroundColor, int $width, int $height): void
218 | {
219 | $borderWidth = 10;
220 |
221 | for ($i = 0; $i <= $borderWidth; $i++) {
222 | $x1 = $i;
223 | $x2 = $width - $i;
224 | $y1 = $i;
225 | $y2 = $height - $i;
226 | $image->draw()->polygon(
227 | [
228 | new Point($x1, $y1),
229 | new Point($x2, $y1),
230 | new Point($x2, $y2),
231 | new Point($x1, $y2),
232 | ],
233 | $i > $borderWidth / 2 ? $foregroundColor : $backgroundColor,
234 | false,
235 | 1
236 | );
237 | }
238 | }
239 |
240 | /**
241 | * @param ImageInterface $image
242 | * @param ColorInterface $textColor
243 | * @param int $width
244 | * @param int $height
245 | * @param string $text
246 | * @param bool $center
247 | *
248 | * @throws UnknownPackageException
249 | */
250 | protected function renderText(ImageInterface $image, ColorInterface $textColor, int $width, int $height, string $text, bool $center = false): void
251 | {
252 | $initialFontSize = 10;
253 | $fontFile = $this->packageManager->getPackage('Sitegeist.Kaleidoscope')->getPackagePath() . 'Resources/Private/Font/NotoSans-Regular.ttf';
254 | $initialFont = $this->imagineService->font($fontFile, $initialFontSize, $textColor);
255 |
256 | // scale text to fit the image
257 | $initialFontBox = $initialFont->box($text);
258 | $targetFontWidth = $width * .5;
259 | $targetFontHeight = $center ? $height * .5 : $height * .20;
260 | $correctedFontSizeByWidth = $targetFontWidth * $initialFontSize / $initialFontBox->getWidth();
261 | $correctedFontSizeByHeight = $targetFontHeight * $initialFontSize / $initialFontBox->getHeight();
262 |
263 | // render actual text
264 | $actualFont = $this->imagineService->font($fontFile, (int) min([$correctedFontSizeByWidth, $correctedFontSizeByHeight]), $textColor);
265 | $actualFontBox = $actualFont->box($text);
266 | $imageCenterPosition = new Point($width / 2, $height / 2);
267 | $textCenterPosition = new Point\Center($actualFontBox);
268 | if ($center) {
269 | $centeredTextPosition = new Point($imageCenterPosition->getX() - $textCenterPosition->getX(), (int) ($height * .5 - $actualFontBox->getHeight() * .5));
270 | } else {
271 | $centeredTextPosition = new Point($imageCenterPosition->getX() - $textCenterPosition->getX(), (int) ($height * .78 - $actualFontBox->getHeight() * .5));
272 | }
273 | /** @phpstan-ignore-next-line */
274 | $image->draw()->text($text, $actualFont, $centeredTextPosition);
275 | }
276 |
277 | /**
278 | * @param ImageInterface $image
279 | * @param ColorInterface $patternColor
280 | * @param int $width
281 | * @param int $height
282 | *
283 | * @return void
284 | */
285 | protected function renderPattern(ImageInterface $image, ColorInterface $patternColor, int $width, int $height): void
286 | {
287 | $borderWidth = 5;
288 | $patternSize = 50;
289 |
290 | $limitingDimension = $width > $height ? $height : $width;
291 |
292 | if ($limitingDimension < ($patternSize + $borderWidth + $borderWidth)) {
293 | $patternSize = $limitingDimension - $borderWidth - $borderWidth;
294 | }
295 |
296 | for ($i = 0; $i < $patternSize; $i++) {
297 | for ($k = 0; $k < $patternSize; $k++) {
298 | if ($k > $patternSize - $i || $i > $patternSize - $k) {
299 | continue;
300 | }
301 |
302 | if (
303 | $i === $k ||
304 | ($i % 2 && $k % 2)
305 | ) {
306 | $image->draw()->dot(new Point($borderWidth + $i, $borderWidth + $k), $patternColor);
307 | }
308 | }
309 | }
310 | }
311 | }
312 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Sitegeist.Kaleidoscope
2 |
3 |
4 |
5 | ## Responsive Images for Neos - with Atomic.Fusion & Monocle in mind
6 |
7 | This package implements responsive-images for Neos for being used via Fusion.
8 |
9 | ```
10 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
11 |
12 | renderer = afx`
13 |
20 | `
21 | ```
22 |
23 | By separating the aspects of image-definition, size-constraining and rendering
24 | we enable the separation of those aspects into different fusion-components.
25 |
26 | We want to help implementing responsive-images in the context of atomic-fusion
27 | and enable previewing fusion-components and their full responsive behavior in the
28 | Sitegeist.Monocle living styleguide.
29 |
30 | Sitegeist.Kaleidoscope comes with four Fusion-ImageSources:
31 |
32 | - Sitegeist.Kaleidoscope:AssetImageSource: Images uploaded by Editors
33 | - Sitegeist.Kaleidoscope:DummyImageSource: Dummy images created by a local service
34 | - Sitegeist.Kaleidoscope:ResourceImageSource: Static resources from Packages
35 | - Sitegeist.Kaleidoscope:UriImageSource: any Url
36 |
37 | ### Authors & Sponsors
38 |
39 | * Martin Ficzel - ficzel@sitegeist.de
40 | * Wilhelm Behncke - behncke@sitegeist.de
41 |
42 | *The development and the public-releases of this package is generously sponsored
43 | by our employer http://www.sitegeist.de.*
44 |
45 | ## Installation
46 |
47 | Sitegeist.Kaleidoscope is available via packagist run `composer require sitegeist/kaleidoscope`.
48 | We use semantic versioning so every breaking change will increase the major-version number.
49 |
50 | ## Configuration
51 |
52 | Some image libraries have problems with WebP image formats. To avoid problems, a fallback image
53 | format can be configured, which will be used for rendering if the requested format fails. The default value is `png`.
54 |
55 | ```yaml
56 | Sitegeist:
57 | Kaleidoscope:
58 | dummyImage:
59 | fallbackFormat: 'png'
60 | ```
61 |
62 | Moreover, as some image libraries (like Vips) also have problems with the generation of the dummy image, the driver can be overriden.
63 | By default, this value is `false` and the default driver as configured in `Neos.Imagine` is used.
64 | Possible values are `Gd`, `Imagick`, `Gmagick` or `Vips`.
65 |
66 | ```yaml
67 | Sitegeist:
68 | Kaleidoscope:
69 | dummyImage:
70 | overrideImagineDriver: 'Imagick'
71 | ```
72 |
73 | ## Usage
74 |
75 | ## Image/Picture FusionObjects
76 |
77 | The Kaleidoscope package integrates two main fusion-objects that an render
78 | the given ImageSource as `img`- or `picture`-tag.
79 |
80 | ### `Sitegeist.Kaleidoscope:Image`
81 |
82 | Render an `img`-tag with optional `srcset` based on `sizes` or `resolutions`.
83 |
84 | Props:
85 |
86 | - `imageSource`: the imageSource to render
87 | - `srcset`: media descriptors like '1.5x' or '600w' of the default image (string ot array)
88 | - `sizes`: sizes attribute of the default image (string ot array)
89 | - `loading`: (optional, default "lazy") loading attribute for the img tag
90 | - `format`: (optional) the image-format like `webp` or `png`, will be applied to the `imageSource`
91 | - `quality`: (optional) the image quality from 0 to 100, will be applied to the `imageSource`
92 | - `width`: (optional) the base width, will be applied to the `imageSource`
93 | - `height`: (optional) the base height, will be applied to the `imageSource`
94 | - `alt`: alt-attribute for the img tag (default "")
95 | - `title`: title attribute for the img tag
96 | - `class`: class attribute for the img tag (deprecated in favor of attributes.class)
97 | - `attributes`: tag-attributes, will override any automatically rendered ones
98 | - `renderDimensionAttributes`: render dimension attributes (width/height) when the data is available from the imageSource. Enabled by default
99 |
100 | #### Image with srcset in multiple resolutions:
101 |
102 | ```
103 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
104 |
105 | renderer = afx`
106 |
110 | `
111 | ```
112 |
113 | #### Image with srcset in multiple sizes:
114 |
115 | ```
116 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
117 |
118 | renderer = afx`
119 |
124 | `
125 | ```
126 |
127 | ### `Sitegeist.Kaleidoscope:Picture`
128 |
129 | Render a `picture`-tag with various sources.
130 |
131 | Props:
132 | - `imageSource`: the imageSource to render
133 | - `sources`: an array of source definitions that supports the following keys
134 | - `imageSource`: alternate image-source for art direction purpose
135 | - `srcset`: (optional) media descriptors like '1.5x' or '600w' (string ot array)
136 | - `sizes`: (optional) sizes attribute (string or array)
137 | - `media`: (optional) the media attribute for this source
138 | - `type`: (optional) the type attribute for this source
139 | - `format`: (optional) the image-format for the source like `webp` or `png`, is applied to `imageSource` and `type`
140 | - `quality`: (optional) the image quality from 0 to 100, will be applied to the `imageSource`
141 | - `width`: (optional) the base width, will be applied to the `imageSource`
142 | - `height`: (optional) the base height, will be applied to the `imageSource`
143 | - `srcset`: media descriptors like '1.5x' or '600w' of the default image (string ot array)
144 | - `sizes`: sizes attribute of the default image (string ot array)
145 | - `formats`: (optional) image formats that will be rendered as sources of separate type (string or array)
146 | - `quality`: (optional) the image quality from 0 to 100, will be applied to the `imageSource`
147 | - `width`: (optional) the base width, will be applied to the `imageSource`
148 | - `height`: (optional) the base height, will be applied to the `imageSource`
149 | - `loading`: (optional, default "lazy") loading attribute for the img tag
150 | - `alt`: alt-attribute for the img tag
151 | - `title`: title attribute for the img tag
152 | - `attributes`: picture-tag-attributes, will override any automatically rendered ones
153 | - `imgAttributes`: img-tag-attributes, will override any automatically rendered ones
154 | - `class`: class attribute for the picture tag (deprecated in favor of attributes.class)
155 | - `renderDimensionAttributes`: render dimension attributes (width/height) for the img-tag when the data is available from the imageSource
156 | if not specified renderDimensionAttributes will be enabled automatically for pictures that only use the `formats` options.
157 |
158 | #### Picture multiple formats:
159 |
160 | The following code will render a picture with an img-tag and two additional
161 | source-tags for the formats webp and png in addition to the default img.
162 |
163 | ```
164 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
165 |
166 | renderer = afx`
167 |
191 |
195 |
200 |
204 |
205 | `
206 | ```
207 |
208 | ### `Sitegeist.Kaleidoscope:Source`
209 |
210 | Render an `src`-tag with `srcset`, `sizes`, `type` and `media` attributes.
211 |
212 | Props:
213 |
214 | - `imageSource`: the imageSource to render (inherited from picture)
215 | - `srcset`: media descriptors like '1.5x' or '600w' of the default image (string ot array, inherited from picture)
216 | - `sizes`: (optional) sizes attribute (string or array, inherited from picture)
217 | - `format`: (optional) the image-format like `webp` or `png`, will be applied to `imageSource` and `type`
218 | - `quality`: (optional) the image quality from 0 to 100, will be applied to the `imageSource`
219 | - `width`: (optional) the base width, will be applied to the `imageSource`
220 | - `height`: (optional) the base height, will be applied to the `imageSource`
221 | - `type`: (optional) the type attribute for the source like `image/png` or `image/webp`, the actual format is enforced via `imageSource.withFormat()`
222 | - `media`: (optional) the media query for the given source
223 | - `renderDimensionAttributes`: render dimension attributes (width/height) for the source-tag when the data is available from the imageSource
224 | if not specified renderDimensionAttributes will be enabled automatically.
225 |
226 | ## Responsive Images with AtomicFusion-Components and Sitegeist.Monocle
227 |
228 | ```
229 | prototype (Vendor.Site:Component.ResponsiveKevisualImage) < prototype(Neos.Fusion:Component) {
230 |
231 | #
232 | # Use the DummyImageSource inside the styleguide
233 | #
234 | @styleguide {
235 | props {
236 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
237 | }
238 | }
239 |
240 | #
241 | # Enforce the dimensions of the passed images by cropping to 1600 x 800
242 | #
243 | imageSource = null
244 | imageSource.@process.enforeDimensions = ${value ? value.withWidth(1600).withHeight(900) : null}
245 |
246 | renderer = afx`
247 |
248 | `
249 | }
250 | ```
251 |
252 | Please note that the enforced dimensions are applied in the presentational component.
253 | The dimension enforcement is applied to the DummySource aswell as to the AssetSource
254 | which will be defined by the integration.
255 |
256 | The integration of the component above as content-element works like this:
257 |
258 | ```
259 | prototype (Vendor.Site:Content.ResponsiveKevisual) < prototype(Neos.Neos:ContentComponent) {
260 | renderer = Vendor.Site:Component.ResponsiveKevisualImage {
261 | imageSource = Sitegeist.Kaleidoscope:AssetImageSource {
262 | asset = ${q(node).property('image')}
263 | title = ${q(node).property('title')}
264 | alt = ${q(node).property('alternativeText')}
265 | }
266 | }
267 | }
268 | ```
269 |
270 | This shows that integration-code dos not need to know the required image dimensions or wich
271 | variants are needed. This frontend know-how is now encapsulated into the presentational-component.
272 |
273 | ## Dynamically enable/disable the lazy rendering
274 |
275 | To optimize the initial load time lazy loading should be disabled for the first contents but be
276 | enabled for others. This can be implemented by enabling the `lazy`ness in the ContentCase prototype
277 | depending on whether or not the current node is the first content in the main collection.
278 |
279 | ```
280 | renderer = Neos.Neos:ContentCollection {
281 | nodePath = 'main'
282 |
283 | // configure seperate iterator for main content
284 | content.iterationName = 'mainContentIterator'
285 |
286 | // enable lazynes for first items
287 | prototype(Sitegeist.Kaleidoscope:Image) {
288 | loading = ${mainContentIterator.isFirst ? 'eager' : 'lazy'}
289 | }
290 | prototype(Sitegeist.Kaleidoscope:Picture) {
291 | loading = ${mainContentIterator.isFirst ? 'eager' : 'lazy'}
292 | }
293 | }
294 | ```
295 |
296 | ## ImageSource FusionObjects
297 |
298 | The package contains ImageSource-FusionObjects that encapsulate the intention to
299 | render an image. ImageSource-Objects return Eel-Helpers that allow to
300 | enforcing the rendered dimensions later in the rendering process.
301 |
302 | Note: The settings for `width`, `height`, `thumbnailPreset` and `variantPreset` can be defined
303 | via fusion but can also applied to the returned object which will override the fusion-settings.
304 |
305 | ### `Sitegeist.Kaleidoscope:AssetImageSource`
306 |
307 | Arguments:
308 |
309 | - `asset`: An image asset that shall be rendered (defaults to the context value `asset`)
310 | - `async`: Defer image-rendering until the image is actually requested by the browser (default true)
311 | - `thumbnailPreset`: `width` and `height` are supported as explained above
312 | - `variantPreset`: as explained above
313 | - `format`: Set the image output format, like webp (default null)
314 | - `quality`: Set the image quality from 0 to 100 (default null)
315 | - `alt`: The alt attribute if not specified otherwise (default null)
316 | - `title`: The title attribute if not specified otherwise (default null)
317 |
318 | ### `Sitegeist.Kaleidoscope:DummyImageSource`
319 |
320 |
321 |
322 |
323 | Arguments:
324 | - `baseWidth`: The default width for the image before scaling (default = 600)
325 | - `baseHeight`: The default height for the image before scaling (default = 400)
326 | - `backgroundColor`: The background color of the dummy image (default = '999')
327 | - `foregroundColor`: The foreground color of the dummy image (default = 'fff')
328 | - `text`: The text that is rendered on the image (default = null, show size)
329 | - `thumbnailPreset`: `width` and `height` are supported as explained above
330 | - `variantPreset`: as explained above
331 | - `alt`: The alt attribute if not specified otherwise (default null)
332 | - `title`: The title attribute if not specified otherwise (default null)
333 |
334 | ### `Sitegeist.Kaleidoscope:UriImageSource`
335 |
336 | Arguments:
337 | - `uri`: The uri that will be rendered
338 | - `alt`: The alt attribute if not specified otherwise (default null)
339 | - `title`: The title attribute if not specified otherwise (default null)
340 | -
341 | ### `Sitegeist.Kaleidoscope:ResourceImageSource`
342 |
343 | Arguments:
344 | - `package`: The package key (e.g. `'My.Package'`) (default = false)
345 | - `path`: Path to resource, either a path relative to `Public` and `package` or a `resource://` URI (default = null)
346 | - !!! `thumbnailPreset`: `width` and `height` have no effect on this ImageSource
347 | - !!! `variantPreset`: has no effect on this ImageSource
348 |
349 | ## ImageSource Eel-Helpers
350 |
351 | The ImageSource-helpers are created by the fusion-objects above and are passed to a
352 | rendering component. The helpers allow to set or override the intended
353 | dimensions and to render the `src` and `srcset`-attributes.
354 |
355 | Methods of ImageSource-Helpers that are accessible via Eel:
356 |
357 | - `withWidth( integer $width, bool $preserveAspect = false )`: Set the intend width modify height as well if
358 | - `withHeight( integer $height, bool $preserveAspect = false )`: Set the intended height
359 | - `withDimensions( integer, interger)`: Set the intended width and height
360 | - `withThumbnailPreset( string )`: Set width and/or height via named thumbnail preset from Settings `Neos.Media.thumbnailPresets`
361 | - `withVariantPreset( string, string )`: Select image variant via the named variant preset (parameters are "preset identifier" key and "preset variant name" key from Settings `Neos.Media.variantPresets`)
362 | - `withFormat( string )`: Set the image format to generate like `webp`, `png` or `jpeg`
363 | - `withQuality( integer )`: Set the image quality from 0 to 100
364 | - `withAlt( ?string )`: Set the alt atttribute for the image tag
365 | - `withTitle( ?string )`: Set the title atttribute for the image tag
366 |
367 | - `src()`: Render a src attribute for the given ImageSource-object
368 | - `srcset( array of descriptors )`: render a srcset attribute for the ImageSource with given media descriptors like `2.x` or `800w`
369 | - `width()`: The current width of the ImageSource if available
370 | - `height()`: The current height of the ImageSource if available
371 | - `alt()`: The alt value of the ImageSource if available
372 | - `title()`: The title value of the ImageSource if available
373 |
374 | deprecated methods:
375 |
376 | - `applyThumbnailPreset( string )`: Set width and/or height via named thumbnail preset from Settings `Neos.Media.thumbnailPresets`
377 | - `useVariantPreset( string, string )`: Select image variant via the named variant preset (parameters are "preset identifier" key and "preset variant name" key from Settings `Neos.Media.variantPresets`)
378 | - `setWidth( integer $width, bool $preserveAspect = false )`: Set the intend width modify height as well if
379 | - `setHeight( integer $height, bool $preserveAspect = false )`: Set the intended height
380 | - `setDimensions( integer, interger)`: Set the intended width and height
381 | - `setFormat( string )`: Set the image format to generate like `webp`, `png` or `jpeg`
382 | - `setQuality( integer )`: Set the image quality from 0 to 100
383 |
384 | Note: The Eel-helpers cannot be created directly. They have to be created
385 | by using the `Sitegeist.Kaleidoscope:AssetImageSource` or
386 | `Sitegeist.Kaleidoscope:DummyImageSource` fusion-objects.
387 |
388 | ### Examples
389 |
390 | Render an `img`-tag with `src` and a `srcset` in multiple resolutions:
391 |
392 | ```
393 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
394 | renderer = afx`
395 |
399 | `
400 | ```
401 |
402 | Render an `img`-tag with `src` plus `srcset` and `sizes`:
403 |
404 | ```
405 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
406 | renderer = afx`
407 |
412 | `
413 | ```
414 | Render a `picture`-tag with multiple `source`-children and an `img`-fallback :
415 |
416 | ```
417 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
418 | renderer = afx`
419 |
420 |
421 |
422 |
423 |
424 | `
425 | ```
426 |
427 | In this example devices smaller than 800px will show a square image,
428 | while larger devices will render a multires-source in the original image dimension.
429 |
430 | ## Contribution
431 |
432 | We will gladly accept contributions. Please send us pull requests.
433 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/Resources/Public/Images/KaleidoscopePromoImage.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
59 |
--------------------------------------------------------------------------------
4 |
5 | ## Responsive Images for Neos - with Atomic.Fusion & Monocle in mind
6 |
7 | This package implements responsive-images for Neos for being used via Fusion.
8 |
9 | ```
10 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
11 |
12 | renderer = afx`
13 | 
321 |
322 |
323 | Arguments:
324 | - `baseWidth`: The default width for the image before scaling (default = 600)
325 | - `baseHeight`: The default height for the image before scaling (default = 400)
326 | - `backgroundColor`: The background color of the dummy image (default = '999')
327 | - `foregroundColor`: The foreground color of the dummy image (default = 'fff')
328 | - `text`: The text that is rendered on the image (default = null, show size)
329 | - `thumbnailPreset`: `width` and `height` are supported as explained above
330 | - `variantPreset`: as explained above
331 | - `alt`: The alt attribute if not specified otherwise (default null)
332 | - `title`: The title attribute if not specified otherwise (default null)
333 |
334 | ### `Sitegeist.Kaleidoscope:UriImageSource`
335 |
336 | Arguments:
337 | - `uri`: The uri that will be rendered
338 | - `alt`: The alt attribute if not specified otherwise (default null)
339 | - `title`: The title attribute if not specified otherwise (default null)
340 | -
341 | ### `Sitegeist.Kaleidoscope:ResourceImageSource`
342 |
343 | Arguments:
344 | - `package`: The package key (e.g. `'My.Package'`) (default = false)
345 | - `path`: Path to resource, either a path relative to `Public` and `package` or a `resource://` URI (default = null)
346 | - !!! `thumbnailPreset`: `width` and `height` have no effect on this ImageSource
347 | - !!! `variantPreset`: has no effect on this ImageSource
348 |
349 | ## ImageSource Eel-Helpers
350 |
351 | The ImageSource-helpers are created by the fusion-objects above and are passed to a
352 | rendering component. The helpers allow to set or override the intended
353 | dimensions and to render the `src` and `srcset`-attributes.
354 |
355 | Methods of ImageSource-Helpers that are accessible via Eel:
356 |
357 | - `withWidth( integer $width, bool $preserveAspect = false )`: Set the intend width modify height as well if
358 | - `withHeight( integer $height, bool $preserveAspect = false )`: Set the intended height
359 | - `withDimensions( integer, interger)`: Set the intended width and height
360 | - `withThumbnailPreset( string )`: Set width and/or height via named thumbnail preset from Settings `Neos.Media.thumbnailPresets`
361 | - `withVariantPreset( string, string )`: Select image variant via the named variant preset (parameters are "preset identifier" key and "preset variant name" key from Settings `Neos.Media.variantPresets`)
362 | - `withFormat( string )`: Set the image format to generate like `webp`, `png` or `jpeg`
363 | - `withQuality( integer )`: Set the image quality from 0 to 100
364 | - `withAlt( ?string )`: Set the alt atttribute for the image tag
365 | - `withTitle( ?string )`: Set the title atttribute for the image tag
366 |
367 | - `src()`: Render a src attribute for the given ImageSource-object
368 | - `srcset( array of descriptors )`: render a srcset attribute for the ImageSource with given media descriptors like `2.x` or `800w`
369 | - `width()`: The current width of the ImageSource if available
370 | - `height()`: The current height of the ImageSource if available
371 | - `alt()`: The alt value of the ImageSource if available
372 | - `title()`: The title value of the ImageSource if available
373 |
374 | deprecated methods:
375 |
376 | - `applyThumbnailPreset( string )`: Set width and/or height via named thumbnail preset from Settings `Neos.Media.thumbnailPresets`
377 | - `useVariantPreset( string, string )`: Select image variant via the named variant preset (parameters are "preset identifier" key and "preset variant name" key from Settings `Neos.Media.variantPresets`)
378 | - `setWidth( integer $width, bool $preserveAspect = false )`: Set the intend width modify height as well if
379 | - `setHeight( integer $height, bool $preserveAspect = false )`: Set the intended height
380 | - `setDimensions( integer, interger)`: Set the intended width and height
381 | - `setFormat( string )`: Set the image format to generate like `webp`, `png` or `jpeg`
382 | - `setQuality( integer )`: Set the image quality from 0 to 100
383 |
384 | Note: The Eel-helpers cannot be created directly. They have to be created
385 | by using the `Sitegeist.Kaleidoscope:AssetImageSource` or
386 | `Sitegeist.Kaleidoscope:DummyImageSource` fusion-objects.
387 |
388 | ### Examples
389 |
390 | Render an `img`-tag with `src` and a `srcset` in multiple resolutions:
391 |
392 | ```
393 | imageSource = Sitegeist.Kaleidoscope:DummyImageSource
394 | renderer = afx`
395 |