33596869355

Committed 02 Sep 2026 05:58AM UTC coverage: 90.098% (-0.2%) from 90.324%

Build # 33596869355

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #628 from CPS-IT/feature/keyword

[FEATURE] Simplify keyword-based data source collection resolution

Coverage Stats

12 of 17 new or added lines in 4 files covered. (70.59%)

1 existing line in 1 file now uncovered.

1565 of 1737 relevant lines covered (90.1%)

6.94 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.38

/Classes/DataProcessing/DataSource/DataSourceCollection.php

<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS extension "handlebars".
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

namespace CPSIT\Typo3Handlebars\DataProcessing\DataSource;

use CPSIT\Typo3Handlebars\Exception;

/**
 * DataSourceCollection
 *
 * @author Elias Häußler <e.haeussler@familie-redlich.de>
 * @license GPL-2.0-or-later
 */
final class DataSourceCollection
{
    /**
     * @var array<value-of<DataSource>, array<string|int, mixed>>
     */
    private array $dataSources = [];

    /**
     * @return array<string|int, mixed>
     */
    public function get(DataSource $dataSource): array
    {
        return $this->dataSources[$dataSource->value] ?? [];
    }

    /**
     * @param array<string|int, mixed> $configuration
     */
    public function set(DataSource $dataSource, array $configuration): self
    {
        $this->dataSources[$dataSource->value] = $configuration;

        return $this;
    }

    public function has(DataSource $dataSource): bool
    {
        return array_key_exists($dataSource->value, $this->dataSources);
    }

    public function remove(DataSource $dataSource): self
    {
        unset($this->dataSources[$dataSource->value]);

        return $this;
    }

    /**
     * @template T
     * @param non-empty-string $key
     * @param DataSource|list<DataSource> $dataSources
     * @param T $default
     * @return mixed|T
     */
    public function resolve(string $key, DataSource|array $dataSources = [], mixed $default = null): mixed
    {
        // Get from all configured data sources (in the given order) if no data sources are configured explicitly
        // The order can be seen as priority for each single data source
        if ($dataSources === []) {
            $dataSources = $this->getConfiguredDataSourcesSortedByPriority();
        } elseif ($dataSources instanceof DataSource) {
            $dataSources = [$dataSources];
        }

        foreach ($dataSources as $dataSource) {
            $found = false;
            $result = $this->resolveForDataSource($key, $dataSource, $found);

            if ($found) {
                return $result;
            }
        }

        return $default;
    }

    /**
     * @template T
     * @param non-empty-string $keyword
     * @param DataSource|list<DataSource> $dataSources
     * @param T $default
     * @return array{mixed|T, non-empty-string}
     * @throws Exception\KeywordCannotBeResolved
     */
    public function resolveKeyword(string $keyword, DataSource|array $dataSources = [], mixed $default = null): array
    {
        $variableName = $this->resolve($keyword, DataSource::ProcessorConfiguration);

        if (!is_string($variableName) || $variableName === '') {
            throw new Exception\KeywordCannotBeResolved($keyword);
        }

        return [
            $this->resolve($variableName, $dataSources, $default),
            $variableName,
        ];
    }

    public function resolveCurrentUid(): int|string
    {
        $uid = $this->resolve('uid', DataSource::ContentObjectRenderer);

        if (!is_numeric($uid)) {
            return '*unknown*';
        }

        return (int)$uid;
    }

    /**
     * @param DataSource|list<DataSource> $dataSources
     */
    public function with(string $key, mixed $value, DataSource|array $dataSources = []): self
    {
        // Apply to all configured data sources if no data sources are configured explicitly
        if ($dataSources === []) {
            foreach ($this->dataSources as $dataSource => $configuration) {
                $this->dataSources[$dataSource][$key] = $value;
            }

            return $this;
        }

        if ($dataSources instanceof DataSource) {
            $dataSources = [$dataSources];
        }

        foreach ($dataSources as $dataSource) {
            $this->dataSources[$dataSource->value] ??= [];
            $this->dataSources[$dataSource->value][$key] = $value;
        }

        return $this;
    }

    private function resolveForDataSource(string $key, DataSource $dataSource, bool &$found = false): mixed
    {
        $configuration = $this->get($dataSource);
        $found = array_key_exists($key, $configuration);

        return $found ? $configuration[$key] : null;
    }

    /**
     * @return list<DataSource>
     */
    private function getConfiguredDataSourcesSortedByPriority(): array
    {
        $dataSources = array_map(DataSource::from(...), array_keys($this->dataSources));

        return DataSource::sortByPriority($dataSources);
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of the TYPO3 CMS extension "handlebars".
7	*
8	* It is free software; you can redistribute it and/or modify it under
9	* the terms of the GNU General Public License, either version 2
10	* of the License, or any later version.
11	*
12	* For the full copyright and license information, please read the
13	* LICENSE.txt file that was distributed with this source code.
14	*
15	* The TYPO3 project - inspiring people to share!
16	*/
17
18	namespace CPSIT\Typo3Handlebars\DataProcessing\DataSource;
19
20	use CPSIT\Typo3Handlebars\Exception;
21
22	/**
23	* DataSourceCollection
24	*
25	* @author Elias Häußler <e.haeussler@familie-redlich.de>
26	* @license GPL-2.0-or-later
27	*/
28	final class DataSourceCollection
29	{
30	/**
31	* @var array<value-of<DataSource>, array<string\|int, mixed>>
32	*/
33	private array $dataSources = [];
34
35	/**
36	* @return array<string\|int, mixed>
37	*/
38	public function get(DataSource $dataSource): array	14✔
39	{
40	return $this->dataSources[$dataSource->value] ?? [];	14✔
41	}
42
43	/**
44	* @param array<string\|int, mixed> $configuration
45	*/
46	public function set(DataSource $dataSource, array $configuration): self	12✔
47	{
48	$this->dataSources[$dataSource->value] = $configuration;	12✔
49
50	return $this;	12✔
51	}
52
53	public function has(DataSource $dataSource): bool	2✔
54	{
55	return array_key_exists($dataSource->value, $this->dataSources);	2✔
56	}
57
58	public function remove(DataSource $dataSource): self	1✔
59	{
60	unset($this->dataSources[$dataSource->value]);	1✔
61
62	return $this;	1✔
63	}
64
65	/**
66	* @template T
67	* @param non-empty-string $key
68	* @param DataSource\|list<DataSource> $dataSources
69	* @param T $default
70	* @return mixed\|T
71	*/
72	public function resolve(string $key, DataSource\|array $dataSources = [], mixed $default = null): mixed	11✔
73	{
74	// Get from all configured data sources (in the given order) if no data sources are configured explicitly
75	// The order can be seen as priority for each single data source
76	if ($dataSources === []) {	11✔
77	$dataSources = $this->getConfiguredDataSourcesSortedByPriority();	2✔
78	} elseif ($dataSources instanceof DataSource) {	10✔
79	$dataSources = [$dataSources];	9✔
80	}
81
82	foreach ($dataSources as $dataSource) {	11✔
83	$found = false;	11✔
84	$result = $this->resolveForDataSource($key, $dataSource, $found);	11✔
85
86	if ($found) {	11✔
87	return $result;	9✔
88	}
89	}
90
91	return $default;	3✔
92	}
93
94	/**
95	* @template T
96	* @param non-empty-string $keyword
97	* @param DataSource\|list<DataSource> $dataSources
98	* @param T $default
99	* @return array{mixed\|T, non-empty-string}
100	* @throws Exception\KeywordCannotBeResolved
101	*/
102	public function resolveKeyword(string $keyword, DataSource\|array $dataSources = [], mixed $default = null): array	4✔
103	{
104	$variableName = $this->resolve($keyword, DataSource::ProcessorConfiguration);	4✔
105
106	if (!is_string($variableName) \|\| $variableName === '') {	4✔
107	throw new Exception\KeywordCannotBeResolved($keyword);	2✔
108	}
109
110	return [	2✔
111	$this->resolve($variableName, $dataSources, $default),	2✔
112	$variableName,	2✔
113	];	2✔
114	}
115
UNCOV 116	public function resolveCurrentUid(): int\|string	×
117	{
118	$uid = $this->resolve('uid', DataSource::ContentObjectRenderer);	×
119
120	if (!is_numeric($uid)) {	×
121	return 'unknown';	×
122	}
123
124	return (int)$uid;	×
125	}
126
127	/**
128	* @param DataSource\|list<DataSource> $dataSources
129	*/
130	public function with(string $key, mixed $value, DataSource\|array $dataSources = []): self	3✔
131	{
132	// Apply to all configured data sources if no data sources are configured explicitly
133	if ($dataSources === []) {	3✔
134	foreach ($this->dataSources as $dataSource => $configuration) {	1✔
135	$this->dataSources[$dataSource][$key] = $value;	1✔
136	}
137
138	return $this;	1✔
139	}
140
141	if ($dataSources instanceof DataSource) {	2✔
142	$dataSources = [$dataSources];	1✔
143	}
144
145	foreach ($dataSources as $dataSource) {	2✔
146	$this->dataSources[$dataSource->value] ??= [];	2✔
147	$this->dataSources[$dataSource->value][$key] = $value;	2✔
148	}
149
150	return $this;	2✔
151	}
152
153	private function resolveForDataSource(string $key, DataSource $dataSource, bool &$found = false): mixed	11✔
154	{
155	$configuration = $this->get($dataSource);	11✔
156	$found = array_key_exists($key, $configuration);	11✔
157
158	return $found ? $configuration[$key] : null;	11✔
159	}
160
161	/**
162	* @return list<DataSource>
163	*/
164	private function getConfiguredDataSourcesSortedByPriority(): array	2✔
165	{
166	$dataSources = array_map(DataSource::from(...), array_keys($this->dataSources));	2✔
167
168	return DataSource::sortByPriority($dataSources);	2✔
169	}
170	}

CPS-IT / handlebars / 33596869355

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous