<?php
declare(strict_types=1);
namespace FluidTYPO3\Flux\ViewHelpers\Form;

/*
 * This file is part of the FluidTYPO3/Flux 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\Flux\Form\Container\Column;
use FluidTYPO3\Flux\Form\Container\Row;
use FluidTYPO3\Flux\ViewHelpers\AbstractFormViewHelper;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;

/**
 * Adds a content area to a source using Flux FlexForms
 *
 * Only works to insert a single content area into your element.
 * To insert multiple content areas, use instead a full `flux:grid`
 * with your desired row and column structure; each column then
 * becomes a content area.
 *
 * Using `flux:grid` after this ViewHelper in the same `flux:form`
 * will overwrite this ViewHelper.
 *
 * Using this ViewHelper after `flux:grid` will cause this ViewHelper
 * to be ignored.
 *
 * ### Example of difference
 *
 *     <flux:form id="myform">
 *         <!-- Creates a basic Grid with one row and one column, names
 *              the column "mycontent" and makes Flux use this Grid -->
 *         <flux:content name="mycontent" />
 *         <!-- Additional flux:content tags are completely ignored -->
 *     </flux:form>
 *
 *     <flux:form id="myform">
 *         <!-- Creates a full, multi-column/row Grid -->
 *         <flux:grid>
 *             <flux:grid.row>
 *                 <flux:grid.column name="mycontentA" colPos="0" />
 *                 <flux:grid.column name="mycontentB" colPos="1" />
 *             </flux:grid.row>
 *             <flux:grid.row>
 *                 <flux:grid.column name="mycontentC" colPos="2" colspan="2" />
 *             </flux:grid.row>
 *         </flux:grid>
 *         <!-- No use of flux:content is possible after this point -->
 *     </flux:form>
 */
class ContentViewHelper extends AbstractFormViewHelper
{
    public function initializeArguments(): void
    {
        $this->registerArgument('name', 'string', 'Name of the content area, FlexForm XML-valid tag name string', true);
        $this->registerArgument(
            'label',
            'string',
            'Label for content area, can be LLL: value. Optional - if not specified, Flux tries to detect an LLL ' .
            'label named "flux.fluxFormId.columns.foobar" based on column name, in scope of extension rendering the ' .
            'Flux form.'
        );
        $this->registerArgument(
            'extensionName',
            'string',
            'If provided, enables overriding the extension context for this and all child nodes. The extension name ' .
            'is otherwise automatically detected from rendering context.'
        );
    }

    public static function getComponent(RenderingContextInterface $renderingContext, iterable $arguments): Column
    {
        /** @var array $arguments */
        // get the current Grid and check for existence of one row and one column, if missing then create them:
        $grid = static::getGridFromRenderingContext($renderingContext, 'grid');
        $grid->setExtensionName(static::getExtensionNameFromRenderingContextOrArguments($renderingContext, $arguments));
        $row = $grid->createContainer(Row::class, 'row');
        $column = $row->createContainer(Column::class, 'column');
        $column->setName((string) $arguments['name']);
        $column->setLabel($arguments['label']);
        return $column;
    }
}