13566190336

Committed 27 Feb 2025 12:18PM UTC coverage: 72.127% (-0.6%) from 72.746%

Build # 13566190336

Build Type

push

github

Committed by

NamelessCoder

Commit Message

[TER] 7.1.0

Run Details

5649 of 7832 relevant lines covered (72.13%)

20.01 hits per line

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

98.85

/Classes/ViewHelpers/Resource/Record/AbstractRecordResourceViewHelper.php

<?php
namespace FluidTYPO3\Vhs\ViewHelpers\Resource\Record;

/*
 * This file is part of the FluidTYPO3/Vhs project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use FluidTYPO3\Vhs\Proxy\DoctrineQueryProxy;
use FluidTYPO3\Vhs\Traits\TemplateVariableViewHelperTrait;
use FluidTYPO3\Vhs\Utility\ContentObjectFetcher;
use FluidTYPO3\Vhs\Utility\ErrorUtility;
use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;

/**
 * Base class: Record Resource ViewHelpers
 */
abstract class AbstractRecordResourceViewHelper extends AbstractViewHelper implements RecordResourceViewHelperInterface
{
    use TemplateVariableViewHelperTrait;

    protected string $table = '';
    protected string $field = '';
    protected string $idField = 'uid';

    /**
     * @var ConfigurationManagerInterface
     */
    protected $configurationManager;

    /**
     * @var boolean
     */
    protected $escapeOutput = false;

    public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager): void
    {
        $this->configurationManager = $configurationManager;
    }

    public function initializeArguments(): void
    {
        $this->registerArgument('table', 'string', 'The table to lookup records.', true);
        $this->registerArgument('field', 'string', 'The field of the table associated to resources.', true);
        $this->registerArgument(
            'record',
            'array',
            'The actual record. Alternatively you can use the "uid" argument.'
        );
        $this->registerArgument(
            'uid',
            'integer',
            'The uid of the record. Alternatively you can use the "record" argument.'
        );
        $this->registerArgument(
            'as',
            'string',
            'If specified, a template variable with this name containing the requested data will be inserted ' .
            'instead of returning it.'
        );
    }

    /**
     * @param mixed $identity
     * @return mixed
     */
    public function getResource($identity)
    {
        return $identity;
    }

    public function getResources(array $record): array
    {
        $field = $this->getField();

        if (!isset($record[$field])) {
            ErrorUtility::throwViewHelperException(
                'The "field" argument was not found on the selected record.',
                1384612728
            );
        }

        if (empty($record[$field])) {
            return [];
        }

        return GeneralUtility::trimExplode(',', $record[$field]);
    }

    public function getTable(): string
    {
        /** @var string|null $table */
        $table = $this->arguments['table'] ?? null;
        if (null === $table) {
            $table = $this->table;
        }

        if (empty($table) || !is_string($table)) {
            ErrorUtility::throwViewHelperException(
                'The "table" argument must be specified and must be a string.',
                1384611336
            );
        }

        return $table;
    }

    public function getField(): string
    {
        /** @var string|null $field */
        $field = $this->arguments['field'] ?? null;
        if (null === $field) {
            $field = $this->field;
        }

        if (empty($field) || !is_string($field)) {
            ErrorUtility::throwViewHelperException(
                'The "field" argument must be specified and must be a string.',
                1384611355
            );
        }

        return $field;
    }

    public function getRecord(int $id): ?array
    {
        $table = $this->getTable();
        $idField = $this->idField;

        /** @var ConnectionPool $connectionPool */
        $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
        /** @var QueryBuilder $queryBuilder */
        $queryBuilder = $connectionPool->getQueryBuilderForTable($table);

        /** @var Context $context */
        $context = GeneralUtility::makeInstance(Context::class);
        $fePreview = $context->hasAspect('frontend.preview')
            && $context->getPropertyFromAspect('frontend.preview', 'isPreview');

        if ($fePreview) {
            $queryBuilder->getRestrictions()->removeByType(HiddenRestriction::class);
        }

        $queryBuilder->createNamedParameter($id, Connection::PARAM_INT, ':id');

        $queryBuilder
            ->select('*')
            ->from($table)
            ->where(
                $queryBuilder->expr()->eq($idField, ':id')
            );
        $statement = DoctrineQueryProxy::executeQueryOnQueryBuilder($queryBuilder);
        $result = DoctrineQueryProxy::fetchAssociative($statement);
        return $result;
    }

    public function getActiveRecord(): array
    {
        $contentObject = ContentObjectFetcher::resolve($this->configurationManager);
        if ($contentObject === null) {
            throw new Exception(static::class . ' requires a ContentObjectRenderer, none found', 1737807859);
        }
        return $contentObject->data;
    }

    /**
     * @return mixed
     */
    public function render()
    {
        /** @var array|null $record */
        $record = $this->arguments['record'] ?? null;
        /** @var int|null $uid */
        $uid = $this->arguments['uid'] ?? null;

        if (null === $record) {
            if (null === $uid) {
                $record = $this->getActiveRecord();
            } else {
                $record = $this->getRecord($uid);
            }
        }

        if (null === $record) {
            ErrorUtility::throwViewHelperException(
                'No record was found. The "record" or "uid" argument must be specified.',
                1384611413
            );
        }

        // attempt to load resources. If any Exceptions happen, transform them to
        // ViewHelperExceptions which render as an inline text error message.
        $content = null;
        try {
            $resources = $this->getResources((array) $record);
            $content = $this->renderChildrenWithVariableOrReturnInput($resources);
        } catch (\Exception $error) {
            // we are doing the pokemon-thing and catching the very top level
            // of Exception because the range of Exceptions that are possibly
            // thrown by the getResources() method in subclasses are not
            // extended from a shared base class like RuntimeException. Thus,
            // we are forced to "catch them all" - but we also output them.
            ErrorUtility::throwViewHelperException($error->getMessage(), $error->getCode());
        }
        return $content;
    }
}

1	<?php
2	namespace FluidTYPO3\Vhs\ViewHelpers\Resource\Record;
3
4	/*
5	* This file is part of the FluidTYPO3/Vhs project under GPLv2 or later.
6	*
7	* For the full copyright and license information, please read the
8	* LICENSE.md file that was distributed with this source code.
9	*/
10
11	use FluidTYPO3\Vhs\Proxy\DoctrineQueryProxy;
12	use FluidTYPO3\Vhs\Traits\TemplateVariableViewHelperTrait;
13	use FluidTYPO3\Vhs\Utility\ContentObjectFetcher;
14	use FluidTYPO3\Vhs\Utility\ErrorUtility;
15	use TYPO3\CMS\Core\Context\Context;
16	use TYPO3\CMS\Core\Database\Connection;
17	use TYPO3\CMS\Core\Database\ConnectionPool;
18	use TYPO3\CMS\Core\Database\Query\QueryBuilder;
19	use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
20	use TYPO3\CMS\Core\Utility\GeneralUtility;
21	use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
22	use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
23	use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
24
25	/**
26	* Base class: Record Resource ViewHelpers
27	*/
28	abstract class AbstractRecordResourceViewHelper extends AbstractViewHelper implements RecordResourceViewHelperInterface
29	{
30	use TemplateVariableViewHelperTrait;
31
32	protected string $table = '';
33	protected string $field = '';
34	protected string $idField = 'uid';
35
36	/**
37	* @var ConfigurationManagerInterface
38	*/
39	protected $configurationManager;
40
41	/**
42	* @var boolean
43	*/
44	protected $escapeOutput = false;
45
46	public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager): void
47	{
48	$this->configurationManager = $configurationManager;	119✔
49	}
50
51	public function initializeArguments(): void
52	{
53	$this->registerArgument('table', 'string', 'The table to lookup records.', true);	42✔
54	$this->registerArgument('field', 'string', 'The field of the table associated to resources.', true);	42✔
55	$this->registerArgument(	42✔
56	'record',	42✔
57	'array',	42✔
58	'The actual record. Alternatively you can use the "uid" argument.'	42✔
59	);	42✔
60	$this->registerArgument(	42✔
61	'uid',	42✔
62	'integer',	42✔
63	'The uid of the record. Alternatively you can use the "record" argument.'	42✔
64	);	42✔
65	$this->registerArgument(	42✔
66	'as',	42✔
67	'string',	42✔
68	'If specified, a template variable with this name containing the requested data will be inserted ' .	42✔
69	'instead of returning it.'	42✔
70	);	42✔
71	}
72
73	/**
74	* @param mixed $identity
75	* @return mixed
76	*/
77	public function getResource($identity)
78	{
79	return $identity;	7✔
80	}
81
82	public function getResources(array $record): array
83	{
84	$field = $this->getField();	35✔
85
86	if (!isset($record[$field])) {	28✔
87	ErrorUtility::throwViewHelperException(	14✔
88	'The "field" argument was not found on the selected record.',	14✔
89	1384612728	14✔
90	);	14✔
91	}
92
93	if (empty($record[$field])) {	14✔
94	return [];	7✔
95	}
96
97	return GeneralUtility::trimExplode(',', $record[$field]);	7✔
98	}
99
100	public function getTable(): string
101	{
102	/** @var string\|null $table */
103	$table = $this->arguments['table'] ?? null;	49✔
104	if (null === $table) {	49✔
105	$table = $this->table;	7✔
106	}
107
108	if (empty($table) \|\| !is_string($table)) {	49✔
109	ErrorUtility::throwViewHelperException(	7✔
110	'The "table" argument must be specified and must be a string.',	7✔
111	1384611336	7✔
112	);	7✔
113	}
114
115	return $table;	42✔
116	}
117
118	public function getField(): string
119	{
120	/** @var string\|null $field */
121	$field = $this->arguments['field'] ?? null;	63✔
122	if (null === $field) {	63✔
123	$field = $this->field;	14✔
124	}
125
126	if (empty($field) \|\| !is_string($field)) {	63✔
127	ErrorUtility::throwViewHelperException(	14✔
128	'The "field" argument must be specified and must be a string.',	14✔
129	1384611355	14✔
130	);	14✔
131	}
132
133	return $field;	49✔
134	}
135
136	public function getRecord(int $id): ?array
137	{
138	$table = $this->getTable();	21✔
139	$idField = $this->idField;	21✔
140
141	/** @var ConnectionPool $connectionPool */
142	$connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);	21✔
143	/** @var QueryBuilder $queryBuilder */
144	$queryBuilder = $connectionPool->getQueryBuilderForTable($table);	21✔
145
146	/** @var Context $context */
147	$context = GeneralUtility::makeInstance(Context::class);	21✔
148	$fePreview = $context->hasAspect('frontend.preview')	21✔
149	&& $context->getPropertyFromAspect('frontend.preview', 'isPreview');	21✔
150
151	if ($fePreview) {	21✔
152	$queryBuilder->getRestrictions()->removeByType(HiddenRestriction::class);	7✔
153	}
154
155	$queryBuilder->createNamedParameter($id, Connection::PARAM_INT, ':id');	21✔
156
157	$queryBuilder	21✔
158	->select('*')	21✔
159	->from($table)	21✔
160	->where(	21✔
161	$queryBuilder->expr()->eq($idField, ':id')	21✔
162	);	21✔
163	$statement = DoctrineQueryProxy::executeQueryOnQueryBuilder($queryBuilder);	21✔
164	$result = DoctrineQueryProxy::fetchAssociative($statement);	21✔
165	return $result;	21✔
166	}
167
168	public function getActiveRecord(): array
169	{
170	$contentObject = ContentObjectFetcher::resolve($this->configurationManager);	35✔
171	if ($contentObject === null) {	35✔
172	throw new Exception(static::class . ' requires a ContentObjectRenderer, none found', 1737807859);	×
173	}
174	return $contentObject->data;	35✔
175	}
176
177	/**
178	* @return mixed
179	*/
180	public function render()
181	{
182	/** @var array\|null $record */
183	$record = $this->arguments['record'] ?? null;	42✔
184	/** @var int\|null $uid */
185	$uid = $this->arguments['uid'] ?? null;	42✔
186
187	if (null === $record) {	42✔
188	if (null === $uid) {	42✔
189	$record = $this->getActiveRecord();	35✔
190	} else {
191	$record = $this->getRecord($uid);	7✔
192	}
193	}
194
195	if (null === $record) {	42✔
196	ErrorUtility::throwViewHelperException(	7✔
197	'No record was found. The "record" or "uid" argument must be specified.',	7✔
198	1384611413	7✔
199	);	7✔
200	}
201
202	// attempt to load resources. If any Exceptions happen, transform them to
203	// ViewHelperExceptions which render as an inline text error message.
204	$content = null;	35✔
205	try {
206	$resources = $this->getResources((array) $record);	35✔
207	$content = $this->renderChildrenWithVariableOrReturnInput($resources);	14✔
208	} catch (\Exception $error) {	21✔
209	// we are doing the pokemon-thing and catching the very top level
210	// of Exception because the range of Exceptions that are possibly
211	// thrown by the getResources() method in subclasses are not
212	// extended from a shared base class like RuntimeException. Thus,
213	// we are forced to "catch them all" - but we also output them.
214	ErrorUtility::throwViewHelperException($error->getMessage(), $error->getCode());	21✔
215	}
216	return $content;	14✔
217	}
218	}

FluidTYPO3 / vhs / 13566190336

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