Skip to content

Commit

Permalink
[TASK] Harden Core\Functional\Framework\DataHandling\Scenario (#594)
Browse files Browse the repository at this point in the history 
Improved type and return value hinting.
  • Loading branch information
@lolli42
lolli42 authored Jun 24, 2024
1 parent 9093b08 commit ffcf3c1
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 263 deletions.
127 changes: 14 additions & 113 deletions Classes/Core/Functional/Framework/DataHandling/Scenario/DataHandlerFactory.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,6 @@ class DataHandlerFactory
*/
private array $staticIdsPerEntity = [];

/**
* @param string $yamlFile
* @return static
*/
public static function fromYamlFile(string $yamlFile): self
{
return new static(Yaml::parseFile($yamlFile));
Expand All @@ -68,17 +64,11 @@ final public function __construct(array $settings)
$this->processEntities($this->settings['entities'] ?? []);
}

/**
* @return array
*/
public function getDataMapPerWorkspace(): array
{
return $this->dataMapPerWorkspace;
}

/**
* @return array
*/
public function getCommandMapPerWorkspace(): array
{
return $this->commandMapPerWorkspace;
Expand All @@ -103,15 +93,10 @@ public function getSuggestedIds(): array
return $this->suggestedIds;
}

/**
* @param array $settings
* @param string|null $nodeId
* @param string|null $parentId
*/
private function processEntities(
array $settings,
string $nodeId = null,
string $parentId = null
?string $nodeId = null,
?string $parentId = null
): void {
foreach ($settings as $entityName => $entitySettings) {
$entityConfiguration = $this->provideEntityConfiguration($entityName);
Expand All @@ -126,33 +111,25 @@ private function processEntities(
}
}

/**
* @param EntityConfiguration $entityConfiguration
* @param array $itemSettings
* @param string|null $nodeId
* @param string|null $parentId
*/
private function processEntityItem(
EntityConfiguration $entityConfiguration,
array $itemSettings,
string $nodeId = null,
string $parentId = null
?string $nodeId = null,
?string $parentId = null
): void {
$values = $this->processEntityValues(
$entityConfiguration,
$itemSettings,
$nodeId,
$parentId
);

$workspaceId = $itemSettings['version']['workspace'] ?? 0;
$tableName = $entityConfiguration->getTableName();
$newId = $this->getUniqueIdForNewRecords();
$this->setInDataMap($tableName, $newId, $values, (int)$workspaceId);
if (isset($itemSettings['actions'])) {
$this->setInCommandMap($tableName, $newId, $nodeId, $itemSettings['actions'], (int)$workspaceId);
}

foreach ($itemSettings['versionVariants'] ?? [] as $versionVariantSettings) {
$this->processVersionVariantItem(
$entityConfiguration,
Expand All @@ -161,7 +138,6 @@ private function processEntityItem(
$entityConfiguration->isNode() ? $newId : $nodeId
);
}

foreach ($itemSettings['languageVariants'] ?? [] as $variantItemSettings) {
$this->processLanguageVariantItem(
$entityConfiguration,
Expand All @@ -170,7 +146,6 @@ private function processEntityItem(
$entityConfiguration->isNode() ? '-' . $newId : $nodeId
);
}

foreach ($itemSettings['children'] ?? [] as $childItemSettings) {
$this->processEntityItem(
$entityConfiguration,
Expand All @@ -179,7 +154,6 @@ private function processEntityItem(
$newId
);
}

if (!empty($itemSettings['entities']) && $entityConfiguration->isNode()) {
$this->processEntities(
$itemSettings['entities'],
Expand All @@ -189,38 +163,29 @@ private function processEntityItem(
}
}

/**
* @param EntityConfiguration $entityConfiguration
* @param array $itemSettings
* @param array $ancestorIds
* @param string|null $nodeId
*/
private function processLanguageVariantItem(
EntityConfiguration $entityConfiguration,
array $itemSettings,
array $ancestorIds,
string $nodeId = null
?string $nodeId = null
): void {
$values = $this->processEntityValues(
$entityConfiguration,
$itemSettings,
$nodeId
);

// Language values can be overriden by declared values
// Language values can be overridden by declared values
$values = array_merge(
$entityConfiguration->processLanguageValues($ancestorIds),
$values
);

$tableName = $entityConfiguration->getTableName();
$newId = $this->getUniqueIdForNewRecords();
$workspaceId = $itemSettings['version']['workspace'] ?? 0;
$this->setInDataMap($tableName, $newId, $values, (int)$workspaceId);
if (isset($itemSettings['actions'])) {
$this->setInCommandMap($tableName, $newId, $nodeId, $itemSettings['actions'], (int)$workspaceId);
}

foreach ($itemSettings['languageVariants'] ?? [] as $variantItemSettings) {
$this->processLanguageVariantItem(
$entityConfiguration,
Expand All @@ -231,16 +196,11 @@ private function processLanguageVariantItem(
}
}

/**
* @param EntityConfiguration $entityConfiguration
* @param array $itemSettings
* @param string $ancestorId
*/
private function processVersionVariantItem(
EntityConfiguration $entityConfiguration,
array $itemSettings,
string $ancestorId,
string $nodeId = null
?string $nodeId = null
): void {
if (isset($itemSettings['self'])) {
throw new \LogicException(
Expand All @@ -260,32 +220,23 @@ private function processVersionVariantItem(
1574365936
);
}

$values = $this->processEntityValues(
$entityConfiguration,
$itemSettings,
$nodeId
);

$tableName = $entityConfiguration->getTableName();
$this->setInDataMap($tableName, $ancestorId, $values, (int)$values['workspace']);
if (isset($itemSettings['actions'])) {
$this->setInCommandMap($tableName, $ancestorId, $nodeId, $itemSettings['actions'], (int)$values['workspace']);
}
}

/**
* @param EntityConfiguration $entityConfiguration
* @param array $itemSettings
* @param string|null $nodeId
* @param string|null $parentId
* @return array
*/
private function processEntityValues(
EntityConfiguration $entityConfiguration,
array $itemSettings,
string $nodeId = null,
string $parentId = null
?string $nodeId = null,
?string $parentId = null
): array {
if (isset($itemSettings['self']) && isset($itemSettings['version'])) {
throw new \LogicException(
Expand All @@ -305,9 +256,7 @@ private function processEntityValues(
1534872400
);
}

$sourceProperty = isset($itemSettings['version']) ? 'version' : 'self';

if (empty($itemSettings[$sourceProperty]) || !is_array($itemSettings[$sourceProperty])) {
throw new \LogicException(
sprintf(
Expand All @@ -318,7 +267,6 @@ private function processEntityValues(
1533734369
);
}

$staticId = (int)($itemSettings[$sourceProperty]['id'] ?? 0);
if ($this->hasStaticId($entityConfiguration, $staticId)) {
throw new \LogicException(
Expand All @@ -329,10 +277,8 @@ private function processEntityValues(
1533734370
);
}

$parentColumnName = $entityConfiguration->getParentColumnName();
$nodeColumnName = $entityConfiguration->getNodeColumnName();

// @todo probably dynamic assignment is a bad idea & we should just use auto incremented values...
$incrementValue = !empty($itemSettings['version']) ? 2 : 1;
if ($staticId > 0) {
Expand All @@ -344,7 +290,6 @@ private function processEntityValues(
$this->addSuggestedId($entityConfiguration, $suggestedId);
$values = $entityConfiguration->processValues($itemSettings[$sourceProperty]);
$values['uid'] = $suggestedId;

// Assign node pointer value
if ($nodeId !== null && !empty($nodeColumnName)) {
$values[$nodeColumnName] = $nodeId;
Expand All @@ -353,13 +298,9 @@ private function processEntityValues(
if ($parentId !== null && !empty($parentColumnName)) {
$values[$parentColumnName] = $parentId;
}

return $values;
}

/**
* @param array $settings
*/
private function buildEntityConfigurations(array $settings): void
{
$defaultSettings = $settings['*'] ?? [];
Expand All @@ -378,10 +319,6 @@ private function buildEntityConfigurations(array $settings): void
}
}

/**
* @param string $entityName
* @return EntityConfiguration
*/
private function provideEntityConfiguration(
string $entityName
): EntityConfiguration {
Expand All @@ -391,10 +328,6 @@ private function provideEntityConfiguration(
return $this->entityConfigurations[$entityName];
}

/**
* @param EntityConfiguration $entityConfiguration
* @param int $suggestedId
*/
private function addSuggestedId(
EntityConfiguration $entityConfiguration,
int $suggestedId
Expand All @@ -413,11 +346,6 @@ private function addSuggestedId(
$this->suggestedIds[$identifier] = true;
}

/**
* @param EntityConfiguration $entityConfiguration
* @param int $id
* @return bool
*/
private function hasStaticId(
EntityConfiguration $entityConfiguration,
int $id
Expand All @@ -429,10 +357,6 @@ private function hasStaticId(
);
}

/**
* @param EntityConfiguration $entityConfiguration
* @return int
*/
private function incrementDynamicId(
EntityConfiguration $entityConfiguration,
int $incrementValue = 1
Expand All @@ -450,31 +374,24 @@ private function incrementDynamicId(
* Adds values to data map and ensures sorting.
* Per default DataHandler inserts records to top on according page
* however, this factory shall insert sequentially one after another.
*
* @param string $tableName
* @param string $identifier
* @param array $values
* @param int $workspaceId
*/
private function setInDataMap(
string $tableName,
string $identifier,
array $values,
int $workspaceId = 0
?int $workspaceId = 0
): void {
if (empty($values)) {
$this->dataMapPerWorkspace[$workspaceId][$tableName][$identifier] = $values;
return;
}

$tableDataMap = $this->filterDataMapByPageId(
$workspaceId,
$tableName,
$values['pid'] ?? null
);
$identifiers = array_keys($tableDataMap);
$currentIndex = array_search($identifier, $identifiers);

// current item did not have any values in data map, use last identifer
if ($currentIndex === false && !empty($identifiers)) {
$values['pid'] = '-' . $identifiers[count($identifiers) - 1];
Expand All @@ -483,7 +400,6 @@ private function setInDataMap(
$previousIndex = $identifiers[$currentIndex - 1];
$values['pid'] = '-' . $identifiers[$previousIndex];
}

$this->dataMapPerWorkspace[$workspaceId][$tableName][$identifier] = $values;
}

Expand All @@ -492,7 +408,7 @@ private function setInCommandMap(
string $identifier,
?string $nodeId,
array $actionItems,
int $workspaceId = 0
?int $workspaceId = 0
): void {
if (empty($actionItems)) {
return;
Expand All @@ -518,21 +434,14 @@ private function setInCommandMap(
}
}

/**
* @param int $workspaceId
* @param string $tableName
* @param int|string|null $pageId
* @return array
*/
private function filterDataMapByPageId(
int $workspaceId,
string $tableName,
$pageId
int|string|null $pageId = null
): array {
if ($pageId === null) {
return [];
}

return array_filter(
$this->dataMapPerWorkspace[$workspaceId][$tableName] ?? [],
function (array $item) use ($pageId, $workspaceId) {
Expand All @@ -545,12 +454,7 @@ function (array $item) use ($pageId, $workspaceId) {
);
}

/**
* @param int $workspaceId
* @param int|string|null $pageId
* @return int|string|null
*/
private function resolveDataMapPageId(int $workspaceId, $pageId)
private function resolveDataMapPageId(int $workspaceId, int|string|null $pageId = null): int|string|null
{
$normalizePageId = (string)$pageId;
if ($pageId === null || $normalizePageId[0] !== '-') {
Expand All @@ -563,10 +467,7 @@ private function resolveDataMapPageId(int $workspaceId, $pageId)
}

/**
* This function generates a unique id by using the more entropy parameter, so it can be used
* in DataHandler.
*
* @return string
* This function generates a unique id by using the more entropy parameter, so it can be used in DataHandler.
*/
private function getUniqueIdForNewRecords(): string
{
Expand Down
Loading

0 comments on commit ffcf3c1

Please sign in to comment.