Skip to content

[FEATURE] Add repeatable rows #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thommyhh wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[FEATURE] Add repeatable rows #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd5cee3
[FEATURE] Add repeatable rows
thommyhh Feb 22, 2022
88a9c74
[BUGFIX] Correctly set field identifiers for repeated rows
thommyhh May 24, 2022
d453b19
Merge branch 'master' into feature/add-repeatable-rows
thommyhh Feb 15, 2024
54bc270
[TASK] Allow installation in TYPO3 CMS 12
thommyhh Feb 15, 2024
148738d
[BUGFIX] Replace deprecated methods/classes & add missing rendering o…
thommyhh Feb 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Classes/FormElements/RepeatableRow.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php
declare(strict_types = 1);
namespace TRITUM\RepeatableFormElements\FormElements;

/**
* This file is part of the "repeatable_form_elements" Extension for TYPO3 CMS.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*/
use TYPO3\CMS\Form\Domain\Model\FormElements\Section;

class RepeatableRow extends Section implements RepeatableContainerInterface
{
}
142 changes: 75 additions & 67 deletions Classes/Hooks/FormHooks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*/
use TRITUM\RepeatableFormElements\FormElements\RepeatableContainerInterface;

use TRITUM\RepeatableFormElements\FormElements\RepeatableContainer;
use TRITUM\RepeatableFormElements\FormElements\RepeatableRow;
use TRITUM\RepeatableFormElements\Service\CopyService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface;
use TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement;
use TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface;
use TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface;
use TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface;
Expand All @@ -36,18 +35,32 @@ public function afterInitializeCurrentPage(
array $rawRequestArguments = []
): ?CompositeRenderableInterface {
foreach ($formRuntime->getPages() as $page) {
$this->setRootRepeatableContainerIdentifiers($page, $formRuntime);
$this->wrapChildrenIntoRow($page, $formRuntime);
}

// first request
if (!$lastPage) {
foreach($formRuntime->getPages() as $page) {
foreach($page->getElementsRecursively() as $formElement) {
$formElement->setRenderingOption('_originalIdentifier', $formElement->getIdentifier());
$formElement->setIdentifier($this->buildIdentifierForNestedFields($formElement));
}
}

return $currentPage;
}

if ($this->userWentBackToPreviousStep($formRuntime, $currentPage, $lastPage)) {
$this->getObjectManager()->get(CopyService::class, $formRuntime)->createCopiesFromFormState();
if ($this->userWentBackToPreviousStep($currentPage, $lastPage)) {
GeneralUtility::makeInstance(CopyService::class, $formRuntime)->createCopiesFromFormState();
} else {
$this->getObjectManager()->get(CopyService::class, $formRuntime)->createCopiesFromCurrentRequest();
GeneralUtility::makeInstance(CopyService::class, $formRuntime)->createCopiesFromCurrentRequest();
}

foreach($formRuntime->getPages() as $page) {
foreach($page->getElementsRecursively() as $formElement) {
$formElement->setRenderingOption('_originalIdentifier', $formElement->getRenderingOptions()['_originalIdentifier'] ?? $formElement->getIdentifier());
$formElement->setIdentifier($this->buildIdentifierForNestedFields($formElement));
}
}

return $currentPage;
Expand All @@ -73,89 +86,84 @@ public function beforeRendering(FormRuntime $formRuntime, RootRenderableInterfac
}
}

/**
* @param RenderableInterface $formElement
* @param FormRuntime $formRuntime
* @param array $repeatableContainerIdentifiers
*/
protected function setRootRepeatableContainerIdentifiers(
RenderableInterface $renderable,
FormRuntime $formRuntime,
array $repeatableContainerIdentifiers = []
): void {
$isRepeatableContainer = $renderable instanceof RepeatableContainerInterface ? true : false;

$hasOriginalIdentifier = isset($renderable->getRenderingOptions()['_originalIdentifier']);
if ($isRepeatableContainer) {
$repeatableContainerIdentifiers[] = $renderable->getIdentifier();
if (!$hasOriginalIdentifier) {
$renderable->setRenderingOption('_isRootRepeatableContainer', true);
$renderable->setRenderingOption('_isReferenceContainer', true);
}
}

if (!empty($repeatableContainerIdentifiers) && !$hasOriginalIdentifier) {
$newIdentifier = implode('.0.', $repeatableContainerIdentifiers) . '.0';
if (!$isRepeatableContainer) {
$newIdentifier .= '.' . $renderable->getIdentifier();
}
$originalIdentifier = $renderable->getIdentifier();
$renderable->setRenderingOption('_originalIdentifier', $originalIdentifier);

if($renderable instanceof AbstractFormElement && $renderable->getDefaultValue()) {
$formRuntime->getFormDefinition()->addElementDefaultValue($newIdentifier, $renderable->getDefaultValue());
}

$formRuntime->getFormDefinition()->unregisterRenderable($renderable);
$renderable->setIdentifier($newIdentifier);
$formRuntime->getFormDefinition()->registerRenderable($renderable);

$copyService = $this->getObjectManager()->get(CopyService::class, $formRuntime);
[$originalProcessingRule] = $copyService->copyProcessingRule($originalIdentifier, $newIdentifier);

/** @var ValidatorInterface $validator */
foreach ($originalProcessingRule->getValidators() as $validator) {
$renderable->addValidator($validator);
protected function wrapChildrenIntoRow(RenderableInterface $renderable, FormRuntime $formRuntime)
{
if ($renderable instanceof RepeatableContainer) {
$renderable->setRenderingOption('_originalIdentifier', $renderable->getIdentifier());
$renderable->setRenderingOption('_isRootRepeatableContainer', true);
$renderable->setRenderingOption('_isReferenceContainer', true);
/** @var RepeatableRow $row */
$row = $renderable->createElement(CopyService::buildRowIdentifier($renderable), 'RepeatableRow');
$row->setRenderingOption('_rowNumber', 0);

/** @var FormElementInterface|RenderableInterface $childElement */
foreach($renderable->getElements() as $childElement) {
if ($childElement !== $row) {
$renderable->removeElement($childElement);
$row->addElement($childElement);
// Fix the missing parent renderables removed by `removeElement`
$this->updateParentRenderableRecursively($childElement, $formRuntime);
}
}

foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['afterBuildingFinished'] ?? [] as $className) {
$hookObj = GeneralUtility::makeInstance($className);
if (method_exists($hookObj, 'afterBuildingFinished')) {
$hookObj->afterBuildingFinished($renderable);
$hookObj->afterBuildingFinished($row);
}
}
} elseif ($renderable instanceof CompositeRenderableInterface) {
foreach ($renderable->getElements() as $element) {
$this->wrapChildrenIntoRow($element, $formRuntime);
}
}
}

if ($renderable instanceof CompositeRenderableInterface) {
foreach ($renderable->getElements() as $childRenderable) {
$this->setRootRepeatableContainerIdentifiers($childRenderable, $formRuntime, $repeatableContainerIdentifiers);
protected function updateParentRenderableRecursively(RenderableInterface $renderable, FormRuntime $formRuntime) {
if ($renderable instanceof CompositeRenderableInterface && method_exists($renderable, 'getElements')) {
/** @var RenderableInterface $childElement */
foreach ($renderable->getElements() as $childElement) {
$formRuntime->getFormDefinition()->unregisterRenderable($childElement);
$childElement->setParentRenderable($renderable);

if ($childElement instanceof CompositeRenderableInterface) {
$this->updateParentRenderableRecursively($childElement, $formRuntime);
}
}
}
}

protected function buildIdentifierForNestedFields(RenderableInterface $renderable)
{
$identifierParts = [$renderable->getRenderingOptions()['_rowNumber'] ?? $renderable->getRenderingOptions()['_originalIdentifier'] ?? $renderable->getIdentifier()];
$currentRenderable = $renderable;

do {
$currentRenderable = $currentRenderable->getParentRenderable();
if ($currentRenderable instanceof RepeatableRow) {
array_unshift($identifierParts, $currentRenderable->getRenderingOptions()['_rowNumber']);
} elseif ($currentRenderable instanceof RepeatableContainer) {
array_unshift($identifierParts, $currentRenderable->getIdentifier());
}
} while ($currentRenderable->getParentRenderable() !== null);

return implode('.', $identifierParts);
}

/**
* returns TRUE if the user went back to any previous step in the form.
*
* @param FormRuntime $formRuntime
* @param CompositeRenderableInterface $currentPage
* @param CompositeRenderableInterface $lastPage
* @param CompositeRenderableInterface|null $currentPage
* @param CompositeRenderableInterface|null $lastPage
*
* @return bool
*/
protected function userWentBackToPreviousStep(
FormRuntime $formRuntime,
CompositeRenderableInterface $currentPage = null,
CompositeRenderableInterface $lastPage = null
): bool {
return $currentPage !== null
&& $lastPage !== null
&& $currentPage->getIndex() < $lastPage->getIndex();
}

/**
* @return ObjectManager
*/
protected function getObjectManager(): ObjectManager
{
return GeneralUtility::makeInstance(ObjectManager::class);
}
}
Loading