Files
iTop/sources/Forms/Block/Base/ChoiceFormBlock.php
2026-01-27 16:37:17 +01:00

64 lines
1.6 KiB
PHP

<?php
/*
* @copyright Copyright (C) 2010-2025 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Forms\Block\Base;
use Combodo\iTop\Forms\Block\AbstractTypeFormBlock;
use Combodo\iTop\Forms\FormType\Base\ChoiceFormType;
use Combodo\iTop\Forms\IO\Converter\ChoiceValueToLabelConverter;
use Combodo\iTop\Forms\IO\Format\StringIOFormat;
use Combodo\iTop\Forms\Register\IORegister;
use Combodo\iTop\Forms\Register\OptionsRegister;
/**
* A block to manage a list of choices.
* This block expose two outputs: the label and the value of the selected choice.
*
* @api
* @package FormBlock
* @since 3.3.0
*/
class ChoiceFormBlock extends AbstractTypeFormBlock
{
// Outputs
/**
* String output of the label of the selected choice
* @api
*/
public const OUTPUT_LABEL = 'label';
/**
* String output of the value of the selected choice
* @api
*/ public const OUTPUT_VALUE = 'value';
/** @inheritdoc */
public function GetFormType(): string
{
return ChoiceFormType::class;
}
protected function RegisterOptions(OptionsRegister $oOptionsRegister): void
{
parent::RegisterOptions($oOptionsRegister);
$oOptionsRegister->SetOption('multiple', false);
$oOptionsRegister->SetOption('plugins');
}
/** @inheritdoc */
protected function RegisterIO(IORegister $oIORegister): void
{
parent::RegisterIO($oIORegister);
$bMultiple = $this->GetOption('multiple');
$oIORegister->AddOutput(self::OUTPUT_LABEL, StringIOFormat::class, $bMultiple, new ChoiceValueToLabelConverter($this));
$oIORegister->AddOutput(self::OUTPUT_VALUE, StringIOFormat::class, $bMultiple);
}
}