TASK: Migrate RelationResolver to FormEngine

* Replace old implementation for TYPO3 6.x with new one for rewritten
  form engine in 7.x and up.
This commit is contained in:
Daniel Siepmann 2017-05-11 12:39:56 +02:00
parent 7877c36a77
commit 687ba8075d
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
2 changed files with 69 additions and 79 deletions

View file

@ -25,6 +25,9 @@ use TYPO3\CMS\Core\SingletonInterface as Singleton;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
use TYPO3\CMS\Backend\Form\FormDataCompiler;
use TYPO3\CMS\Backend\Form\FormDataGroup\TcaDatabaseRecord;
/**
* Resolves relations from TCA using TCA.
*
@ -33,12 +36,6 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
*/
class RelationResolver implements Singleton
{
/**
* @var \TYPO3\CMS\Backend\Form\DataPreprocessor
* @inject
*/
protected $formEngine;
/**
* Resolve relations for the given record.
*
@ -47,12 +44,14 @@ class RelationResolver implements Singleton
*/
public function resolveRelationsForRecord(TcaTableService $service, array &$record)
{
$preprocessedData = $this->formEngine->renderRecordRaw(
$service->getTableName(),
$record['uid'],
$record['pid'],
$record
);
$formData = GeneralUtility::makeInstance(FormDataCompiler::class, GeneralUtility::makeInstance(TcaDatabaseRecord::class))
->compile([
'tableName' => $service->getTableName(),
'vanillaUid' => (int)$record['uid'],
'command' => 'edit',
]);
$record = $formData['databaseRow'];
foreach (array_keys($record) as $column) {
try {
@ -62,41 +61,35 @@ class RelationResolver implements Singleton
continue;
}
if (! $this->isRelation($config)) {
if (! $this->isRelation($config) || !is_array($formData['processedTca']['columns'][$column])) {
continue;
}
$record[$column] = $this->resolveValue($preprocessedData[$column], $config);
$record[$column] = $this->resolveValue($record[$column], $formData['processedTca']['columns'][$column]);
}
}
/**
* Resolve the given value from TYPO3 API response.
*
* As FormEngine uses an internal format, we resolve it to a usable format
* for indexing.
*
* TODO: Unittest to break as soon as TYPO3 api has changed, so we know
* exactly that we need to tackle this place.
*
* @param string $value The value from FormEngine to resolve.
* @param array $config The tca config of the relation.
* @param array $tcaColumn The tca config of the relation.
*
* @return array<String>|string
*/
protected function resolveValue($value, array $config)
protected function resolveValue($value, array $tcaColumn)
{
if ($value === '' || $value === '0') {
return '';
}
if (strpos($value, '|') !== false) {
return $this->resolveSelectValue($value);
if ($tcaColumn['config']['type'] === 'select') {
return $this->resolveSelectValue($value, $tcaColumn);
}
if (strpos($value, ',') !== false) {
return $this->resolveInlineValue($value, $config['foreign_table']);
if ($tcaColumn['config']['type'] === 'group' && strpos($value, '|') !== false) {
return $this->resolveForeignDbValue($value);
}
if ($config['type'] === 'select' && is_array($config['items'])) {
return $this->resolveSelectItemValue($value, $config['items']);
if ($tcaColumn['config']['type'] === 'inline') {
return $this->resolveInlineValue($tcaColumn);
}
return '';
@ -117,62 +110,55 @@ class RelationResolver implements Singleton
/**
* Resolves internal representation of select to array of labels.
*
* @param string $value
* @param array $value
* @param array $tcaColumn
* @return array
*/
protected function resolveSelectValue($value)
protected function resolveSelectValue(array $values, array $tcaColumn)
{
$newValue = [];
$resolvedValues = [];
foreach (GeneralUtility::trimExplode(',', $value) as $value) {
$value = substr($value, strpos($value, '|') + 1);
$value = rawurldecode($value);
$newValue[] = $value;
foreach ($tcaColumn['config']['items'] as $item) {
if (in_array($item[1], $values)) {
$resolvedValues[] = $item[0];
}
}
return $newValue;
if ($tcaColumn['config']['renderType'] === 'selectSingle' || $tcaColumn['config']['maxitems'] === 1) {
return current($resolvedValues);
}
return $resolvedValues;
}
/**
* @param string $value
* @param string $table
*
* @return array
*/
protected function resolveInlineValue($value, $table)
protected function resolveForeignDbValue($value)
{
$newValue = [];
$records = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('*', $table, 'uid in (' . $value . ')');
if ($records === null) {
return $newValue;
$titles = [];
foreach (explode(',', urldecode($value)) as $title) {
$titles[] = explode('|', $title)[1];
}
foreach ($records as $record) {
$newValue[] = BackendUtility::getRecordTitle($table, $record);
}
return $newValue;
return $titles;
}
/**
* @param string $value
* @param array $items
*
* @return string
* @param array $tcaColumn
* @return array
*/
protected function resolveSelectItemValue($value, array $items)
protected function resolveInlineValue(array $tcaColumn)
{
foreach ($items as $item) {
if ($item[1] === $value) {
$newValue = LocalizationUtility::translate($item[0], '');
$titles = [];
if ($newValue === null) {
return '';
}
return $newValue;
}
foreach ($tcaColumn['children'] as $selected) {
$titles[] = $selected['recordTitle'];
}
return '';
return $titles;
}
}

View file

@ -37,6 +37,10 @@ class RelationResolverTest extends AbstractFunctionalTestCase
$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
$table = 'sys_file';
// Only by adding the field to showitem, it will be processed by FormEngine.
// We use this field to test inline relations, as there is only one alternative.
$GLOBALS['TCA']['sys_file']['types'][1]['showitem'] .= ',metadata';
$subject = $objectManager->get(TcaTableService::class, $table);
$record = BackendUtility::getRecord($table, 1);
$subject->prepareRecord($record);
@ -109,8 +113,8 @@ class RelationResolverTest extends AbstractFunctionalTestCase
$this->assertEquals(
[
'Category 2',
'Category 1',
'Category 2',
],
$record['categories'],
'Foreign mm select relation was not resolved as expected.'