From 3092e9d5d4a6c32b9190e0b4bec443d84459ed64 Mon Sep 17 00:00:00 2001 From: Eric Espie Date: Tue, 27 Jan 2026 16:37:17 +0100 Subject: [PATCH] Documentation --- core/metamodel.class.php | 14 ++++++++------ .../TwigBase/Controller/Controller.php | 1 + sources/Forms/Block/AbstractFormBlock.php | 3 +++ sources/Forms/Block/AbstractTypeFormBlock.php | 12 ++++++++++++ sources/Forms/Block/Base/CheckboxFormBlock.php | 9 +++++++-- sources/Forms/Block/Base/ChoiceFormBlock.php | 13 +++++++++++-- .../Forms/Block/Base/ChoiceFromInputsBlock.php | 3 ++- .../Forms/Block/Base/ChoiceImageFormBlock.php | 3 ++- sources/Forms/Block/Base/CollectionBlock.php | 8 +++++++- sources/Forms/Block/Base/DateFormBlock.php | 3 ++- sources/Forms/Block/Base/DateTimeFormBlock.php | 3 ++- sources/Forms/Block/Base/FormBlock.php | 5 ++++- sources/Forms/Block/Base/HiddenFormBlock.php | 3 ++- sources/Forms/Block/Base/IntegerFormBlock.php | 7 ++++++- sources/Forms/Block/Base/NumberFormBlock.php | 7 ++++++- .../Forms/Block/Base/PolymorphicFormBlock.php | 7 +++++++ sources/Forms/Block/Base/TextAreaFormBlock.php | 3 ++- sources/Forms/Block/Base/TextFormBlock.php | 7 ++++++- .../DataModel/AttributeChoiceFormBlock.php | 17 +++++++++++++++-- .../DataModel/AttributeTypeChoiceFormBlock.php | 18 +++++++++++++----- .../AttributeValueChoiceFormBlock.php | 11 ++++++++++- .../Dashlet/AggregateFunctionFormBlock.php | 7 ++++++- .../Dashlet/ClassAttributeGroupByFormBlock.php | 3 ++- .../Forms/Block/DataModel/LabelFormBlock.php | 7 +++++++ sources/Forms/Block/DataModel/OqlFormBlock.php | 7 ++++++- .../Expression/AbstractExpressionFormBlock.php | 3 ++- .../Expression/BooleanExpressionFormBlock.php | 12 +++++++++++- .../Expression/NumberExpressionFormBlock.php | 10 ++++++++-- .../Expression/StringExpressionFormBlock.php | 13 +++++++++++++ sources/Forms/Block/FormBlockService.php | 2 +- .../FormBuilder/FormFactoryBuilderService.php | 1 + 31 files changed, 185 insertions(+), 37 deletions(-) diff --git a/core/metamodel.class.php b/core/metamodel.class.php index 218307c6e..f9a85c62a 100644 --- a/core/metamodel.class.php +++ b/core/metamodel.class.php @@ -7033,9 +7033,11 @@ abstract class MetaModel /** * (Re)Init the global service locator with a configuration file * - * @param string|null $sRelativeConfigFileName default to the runtime config file + * @param string|null $sRelativeConfigFileName default to the runtime config file when null * * @return void + * @api + * @since 3.3.0 */ public static function InitServiceLocator(string $sRelativeConfigFileName = null): void { @@ -7048,16 +7050,16 @@ abstract class MetaModel } /** - * Get configured service - * - * @see conf/production/ServiceLocatorRuntimeConfig.php + * Get configured service using a service locator * * Example: $oModelReflection = \MetaModel::GetService('ModelReflexion'); * - * @param string $sServiceName + * @param string $sServiceName Name of the service to get * - * @return mixed + * @return mixed The service object instance corresponding to the service name * @throws \Combodo\iTop\Service\ServiceLocator\ServiceLocatorException + * @api + * @since 3.3.0 */ public static function GetService(string $sServiceName): mixed { diff --git a/sources/Application/TwigBase/Controller/Controller.php b/sources/Application/TwigBase/Controller/Controller.php index 569f1f88f..d63d8e50a 100644 --- a/sources/Application/TwigBase/Controller/Controller.php +++ b/sources/Application/TwigBase/Controller/Controller.php @@ -151,6 +151,7 @@ abstract class Controller extends AbstractController * @param array $aThemes * * @return void + * @throws \Combodo\iTop\Service\ServiceLocator\ServiceLocatorException * @throws \ReflectionException * @throws \Twig\Error\LoaderError */ diff --git a/sources/Forms/Block/AbstractFormBlock.php b/sources/Forms/Block/AbstractFormBlock.php index 4b6fb330b..f553c6e7a 100644 --- a/sources/Forms/Block/AbstractFormBlock.php +++ b/sources/Forms/Block/AbstractFormBlock.php @@ -23,6 +23,7 @@ use Combodo\iTop\Forms\Register\RegisterException; * * @package Combodo\iTop\Forms\Block * @since 3.3.0 + * @api */ abstract class AbstractFormBlock implements IFormBlock { @@ -119,6 +120,7 @@ abstract class AbstractFormBlock implements IFormBlock * @param OptionsRegister $oOptionsRegister * * @throws RegisterException + * @api */ protected function RegisterOptions(OptionsRegister $oOptionsRegister): void { @@ -130,6 +132,7 @@ abstract class AbstractFormBlock implements IFormBlock * @param array $aOptions * * @return void + * @throws \Combodo\iTop\Forms\Register\RegisterException */ private function SetOptions(array $aOptions): void { diff --git a/sources/Forms/Block/AbstractTypeFormBlock.php b/sources/Forms/Block/AbstractTypeFormBlock.php index 9e85e3686..96d0fb679 100644 --- a/sources/Forms/Block/AbstractTypeFormBlock.php +++ b/sources/Forms/Block/AbstractTypeFormBlock.php @@ -18,11 +18,23 @@ use Combodo\iTop\Forms\Register\RegisterException; * * @package Combodo\iTop\Forms\Block * @since 3.3.0 + * @api */ abstract class AbstractTypeFormBlock extends AbstractFormBlock { // Inputs + /** + * Boolean input to display or not the block + * (visible by default) + * @api + */ public const INPUT_VISIBLE = 'visible'; + + /** + * Boolean input to enable/disable the block + * (enabled by default) + * @api + */ public const INPUT_ENABLE = 'enable'; /** @var bool flag indicating the form insertion */ diff --git a/sources/Forms/Block/Base/CheckboxFormBlock.php b/sources/Forms/Block/Base/CheckboxFormBlock.php index f8b626cc5..b591ca948 100644 --- a/sources/Forms/Block/Base/CheckboxFormBlock.php +++ b/sources/Forms/Block/Base/CheckboxFormBlock.php @@ -17,12 +17,17 @@ use Symfony\Component\Form\Extension\Core\Type\CheckboxType; * A block to manage a checkbox. * This block expose one output: whether the checkbox is checked or not. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class CheckboxFormBlock extends AbstractTypeFormBlock { - // outputs + // Outputs + /** + * Boolean output whether the checkbox is checked or not + * @api + */ public const OUTPUT_CHECKED = 'checked'; /** @inheritdoc */ diff --git a/sources/Forms/Block/Base/ChoiceFormBlock.php b/sources/Forms/Block/Base/ChoiceFormBlock.php index e2654c8ea..e77406348 100644 --- a/sources/Forms/Block/Base/ChoiceFormBlock.php +++ b/sources/Forms/Block/Base/ChoiceFormBlock.php @@ -18,14 +18,23 @@ 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. * - * @package Combodo\iTop\Forms\Block\Base + * @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'; - public const OUTPUT_VALUE = 'value'; + + /** + * String output of the value of the selected choice + * @api + */ public const OUTPUT_VALUE = 'value'; /** @inheritdoc */ public function GetFormType(): string diff --git a/sources/Forms/Block/Base/ChoiceFromInputsBlock.php b/sources/Forms/Block/Base/ChoiceFromInputsBlock.php index 3cc860c6c..97372e6f4 100644 --- a/sources/Forms/Block/Base/ChoiceFromInputsBlock.php +++ b/sources/Forms/Block/Base/ChoiceFromInputsBlock.php @@ -13,7 +13,8 @@ use Combodo\iTop\Forms\Register\OptionsRegister; /** * A block to manage a list of choices given by forms inputs current values. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class ChoiceFromInputsBlock extends ChoiceFormBlock diff --git a/sources/Forms/Block/Base/ChoiceImageFormBlock.php b/sources/Forms/Block/Base/ChoiceImageFormBlock.php index 9511d08eb..d6fa13367 100644 --- a/sources/Forms/Block/Base/ChoiceImageFormBlock.php +++ b/sources/Forms/Block/Base/ChoiceImageFormBlock.php @@ -14,7 +14,8 @@ use utils; * A block to manage a list of images. * This block expose two outputs: the label and the value of the selected choice. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class ChoiceImageFormBlock extends ChoiceFormBlock diff --git a/sources/Forms/Block/Base/CollectionBlock.php b/sources/Forms/Block/Base/CollectionBlock.php index a1f86bd29..47b0e8608 100644 --- a/sources/Forms/Block/Base/CollectionBlock.php +++ b/sources/Forms/Block/Base/CollectionBlock.php @@ -19,13 +19,19 @@ use Combodo\iTop\Forms\Register\RegisterException; /** * A block to manage collections of form blocks. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class CollectionBlock extends AbstractTypeFormBlock { /** @var AbstractTypeFormBlock Prototype block */ private AbstractTypeFormBlock $oPrototypeBlock; + + /** + * Integer output value giving the number of entries in the collection + * @api + */ public const OUTPUT_COUNT = 'count'; /** @inheritdoc */ diff --git a/sources/Forms/Block/Base/DateFormBlock.php b/sources/Forms/Block/Base/DateFormBlock.php index 829225123..bb09354cf 100644 --- a/sources/Forms/Block/Base/DateFormBlock.php +++ b/sources/Forms/Block/Base/DateFormBlock.php @@ -14,7 +14,8 @@ use Symfony\Component\Form\Extension\Core\Type\DateType; /** * A block to manage a date field. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class DateFormBlock extends AbstractTypeFormBlock diff --git a/sources/Forms/Block/Base/DateTimeFormBlock.php b/sources/Forms/Block/Base/DateTimeFormBlock.php index ad5bad25c..565ca275c 100644 --- a/sources/Forms/Block/Base/DateTimeFormBlock.php +++ b/sources/Forms/Block/Base/DateTimeFormBlock.php @@ -14,7 +14,8 @@ use Symfony\Component\Form\Extension\Core\Type\DateTimeType; /** * A block to manage a date and time field * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class DateTimeFormBlock extends AbstractTypeFormBlock diff --git a/sources/Forms/Block/Base/FormBlock.php b/sources/Forms/Block/Base/FormBlock.php index 0038a602c..3c55ebe41 100644 --- a/sources/Forms/Block/Base/FormBlock.php +++ b/sources/Forms/Block/Base/FormBlock.php @@ -21,7 +21,8 @@ use ReflectionException; /** * A block to manage a form with children. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class FormBlock extends AbstractTypeFormBlock @@ -77,6 +78,7 @@ class FormBlock extends AbstractTypeFormBlock * @return $this * @throws ReflectionException * @throws FormBlockException + * @api */ public function Add(string $sName, string $sBlockClass, array $aOptions = []): AbstractFormBlock { @@ -148,6 +150,7 @@ class FormBlock extends AbstractTypeFormBlock /** * Build the form. * + * @api * @return void */ protected function BuildForm(): void diff --git a/sources/Forms/Block/Base/HiddenFormBlock.php b/sources/Forms/Block/Base/HiddenFormBlock.php index 928f4bcae..d85741b03 100644 --- a/sources/Forms/Block/Base/HiddenFormBlock.php +++ b/sources/Forms/Block/Base/HiddenFormBlock.php @@ -13,7 +13,8 @@ use Symfony\Component\Form\Extension\Core\Type\HiddenType; /** * A block to manage a hidden field * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class HiddenFormBlock extends AbstractTypeFormBlock diff --git a/sources/Forms/Block/Base/IntegerFormBlock.php b/sources/Forms/Block/Base/IntegerFormBlock.php index dcee7f8e0..e95433cf7 100644 --- a/sources/Forms/Block/Base/IntegerFormBlock.php +++ b/sources/Forms/Block/Base/IntegerFormBlock.php @@ -17,11 +17,16 @@ use Symfony\Component\Form\Extension\Core\Type\IntegerType; * A block to manage an integer * This block exposes a single output: the integer value. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class IntegerFormBlock extends AbstractTypeFormBlock { + /** + * Integer output giving the value entered + * @api + */ public const OUTPUT_INTEGER = 'integer'; public function GetFormType(): string diff --git a/sources/Forms/Block/Base/NumberFormBlock.php b/sources/Forms/Block/Base/NumberFormBlock.php index a7ac15a7b..a5dd0ff59 100644 --- a/sources/Forms/Block/Base/NumberFormBlock.php +++ b/sources/Forms/Block/Base/NumberFormBlock.php @@ -16,12 +16,17 @@ use Symfony\Component\Form\Extension\Core\Type\NumberType; * A block to manage a number input. * This block exposes a single output: the number value. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class NumberFormBlock extends AbstractTypeFormBlock { // Outputs + /** + * Number output giving the value entered + * @api + */ public const OUTPUT_NUMBER = "number"; /** @inheritdoc */ diff --git a/sources/Forms/Block/Base/PolymorphicFormBlock.php b/sources/Forms/Block/Base/PolymorphicFormBlock.php index 5b42c5a3c..3523948fc 100644 --- a/sources/Forms/Block/Base/PolymorphicFormBlock.php +++ b/sources/Forms/Block/Base/PolymorphicFormBlock.php @@ -9,6 +9,13 @@ namespace Combodo\iTop\Forms\Block\Base; use Combodo\iTop\Forms\Block\AbstractFormBlock; +/** + * A block that can be instantiated into other block type + * + * @api + * @package FormBlock + * @since 3.3.0 + */ class PolymorphicFormBlock extends AbstractFormBlock { } diff --git a/sources/Forms/Block/Base/TextAreaFormBlock.php b/sources/Forms/Block/Base/TextAreaFormBlock.php index 9fcab0c6a..f0081e380 100644 --- a/sources/Forms/Block/Base/TextAreaFormBlock.php +++ b/sources/Forms/Block/Base/TextAreaFormBlock.php @@ -13,7 +13,8 @@ use Symfony\Component\Form\Extension\Core\Type\TextareaType; /** * A block to manage a textarea. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class TextAreaFormBlock extends AbstractTypeFormBlock diff --git a/sources/Forms/Block/Base/TextFormBlock.php b/sources/Forms/Block/Base/TextFormBlock.php index 5a6b74606..b811afe25 100644 --- a/sources/Forms/Block/Base/TextFormBlock.php +++ b/sources/Forms/Block/Base/TextFormBlock.php @@ -16,12 +16,17 @@ use Symfony\Component\Form\Extension\Core\Type\TextType; * A block to manage a text input. * This block exposes a single text output. * - * @package Combodo\iTop\Forms\Block\Base + * @api + * @package FormBlock * @since 3.3.0 */ class TextFormBlock extends AbstractTypeFormBlock { // Outputs + /** + * String output giving the value entered + * @api + */ public const OUTPUT_TEXT = "text"; /** @inheritdoc */ diff --git a/sources/Forms/Block/DataModel/AttributeChoiceFormBlock.php b/sources/Forms/Block/DataModel/AttributeChoiceFormBlock.php index e96f3bc35..970e77fc9 100644 --- a/sources/Forms/Block/DataModel/AttributeChoiceFormBlock.php +++ b/sources/Forms/Block/DataModel/AttributeChoiceFormBlock.php @@ -22,16 +22,29 @@ use utils; /** * A block to choose an attribute from a given class. * - * @package Combodo\iTop\Forms\Block\DataModel + * @api + * @package FormBlock * @since 3.3.0 */ class AttributeChoiceFormBlock extends ChoiceFormBlock { // inputs + /** + * Class input reflecting the selected class + * @api + */ public const INPUT_CLASS_NAME = 'class'; + /** + * String input for the category of attributes to select from + * @api + */ public const INPUT_CATEGORY = 'category'; // outputs + /** + * String output of the selected attribute + * @api + */ public const OUTPUT_ATTRIBUTE = 'attribute'; /** @inheritdoc */ @@ -61,7 +74,7 @@ class AttributeChoiceFormBlock extends ChoiceFormBlock /** * @inheritdoc * - * @throws ServiceLocationException + * @throws ServiceLocatorException * @throws FormBlockException * @throws RegisterException */ diff --git a/sources/Forms/Block/DataModel/AttributeTypeChoiceFormBlock.php b/sources/Forms/Block/DataModel/AttributeTypeChoiceFormBlock.php index dd0fb7e20..19838c49e 100644 --- a/sources/Forms/Block/DataModel/AttributeTypeChoiceFormBlock.php +++ b/sources/Forms/Block/DataModel/AttributeTypeChoiceFormBlock.php @@ -15,12 +15,17 @@ use Combodo\iTop\Forms\Register\OptionsRegister; /** * A block to choose an attribute type. * - * @package Combodo\iTop\Forms\Block\DataModel + * @api + * @package FormBlock * @since 3.3.0 */ class AttributeTypeChoiceFormBlock extends ChoiceFormBlock { // outputs + /** + * String output of the selected attribute type + * @api + */ public const OUTPUT_ATTRIBUTE_TYPE = 'output_type'; /** @inheritdoc */ @@ -29,10 +34,13 @@ class AttributeTypeChoiceFormBlock extends ChoiceFormBlock parent::RegisterOptions($oOptionsRegister); $oOptionsRegister->SetOption('placeholder', 'Select a type...'); $oOptionsRegister->SetOption('choices', [ - 'numeric' => 'numeric', - 'group_by' => 'group_by', - 'date' => 'date', - 'enum' => 'enum', + 'numeric' => 'numeric', + 'groupable' => 'groupable', + 'date' => 'date', + 'enum' => 'enum', + 'link' => 'link', + 'string' => 'string', + 'all' => 'all', ]); } diff --git a/sources/Forms/Block/DataModel/AttributeValueChoiceFormBlock.php b/sources/Forms/Block/DataModel/AttributeValueChoiceFormBlock.php index bbb9228e1..1b3dd71e0 100644 --- a/sources/Forms/Block/DataModel/AttributeValueChoiceFormBlock.php +++ b/sources/Forms/Block/DataModel/AttributeValueChoiceFormBlock.php @@ -19,13 +19,22 @@ use Exception; /** * A block to choose some values from attribute of a given class. * - * @package Combodo\iTop\Forms\Block\DataModel + * @api + * @package FormBlock * @since 3.3.0 */ class AttributeValueChoiceFormBlock extends ChoiceFormBlock { // inputs + /** + * Class input reflecting the selected class + * @api + */ public const INPUT_CLASS_NAME = 'class'; + /** + * String input reflecting the selected attribute + * @api + */ public const INPUT_ATTRIBUTE = 'attribute'; /** @inheritdoc */ diff --git a/sources/Forms/Block/DataModel/Dashlet/AggregateFunctionFormBlock.php b/sources/Forms/Block/DataModel/Dashlet/AggregateFunctionFormBlock.php index 9f19a9f93..7c96509f0 100644 --- a/sources/Forms/Block/DataModel/Dashlet/AggregateFunctionFormBlock.php +++ b/sources/Forms/Block/DataModel/Dashlet/AggregateFunctionFormBlock.php @@ -17,11 +17,16 @@ use Dict; /** * A block to manage an aggregation function list * - * @package Combodo\iTop\Forms\Block\DataModel\Dashlet + * @api + * @package FormBlock * @since 3.3.0 */ class AggregateFunctionFormBlock extends ChoiceFormBlock { + /** + * Class input reflecting the selected class + * @api + */ public const INPUT_CLASS_NAME = 'class'; /** @inheritdoc */ diff --git a/sources/Forms/Block/DataModel/Dashlet/ClassAttributeGroupByFormBlock.php b/sources/Forms/Block/DataModel/Dashlet/ClassAttributeGroupByFormBlock.php index 9cb8837a0..0818b51d4 100644 --- a/sources/Forms/Block/DataModel/Dashlet/ClassAttributeGroupByFormBlock.php +++ b/sources/Forms/Block/DataModel/Dashlet/ClassAttributeGroupByFormBlock.php @@ -17,7 +17,8 @@ use Exception; /** * A block to manage an attribute of a data model class for grouping purpose * - * @package Combodo\iTop\Forms\Block\DataModel\Dashlet + * @api + * @package FormBlock * @since 3.3.0 */ class ClassAttributeGroupByFormBlock extends AttributeChoiceFormBlock diff --git a/sources/Forms/Block/DataModel/LabelFormBlock.php b/sources/Forms/Block/DataModel/LabelFormBlock.php index 754e6b09d..81a94994a 100644 --- a/sources/Forms/Block/DataModel/LabelFormBlock.php +++ b/sources/Forms/Block/DataModel/LabelFormBlock.php @@ -9,6 +9,13 @@ namespace Combodo\iTop\Forms\Block\DataModel; use Combodo\iTop\Forms\Block\Base\TextFormBlock; +/** + * A block to input text matching dictionary entry + * + * @api + * @package FormBlock + * @since 3.3.0 + */ class LabelFormBlock extends TextFormBlock { } diff --git a/sources/Forms/Block/DataModel/OqlFormBlock.php b/sources/Forms/Block/DataModel/OqlFormBlock.php index a76c8c431..eca88e16e 100644 --- a/sources/Forms/Block/DataModel/OqlFormBlock.php +++ b/sources/Forms/Block/DataModel/OqlFormBlock.php @@ -18,12 +18,17 @@ use Combodo\iTop\Forms\Register\OptionsRegister; * A block to manage OQL expression input. * This block exposes an output providing the selected class from the OQL. * - * @package Combodo\iTop\Forms\Block\DataModel + * @api + * @package FormBlock * @since 3.3.0 */ class OqlFormBlock extends TextAreaFormBlock { // outputs + /** + * Class output reflecting the selected class + * @api + */ public const OUTPUT_SELECTED_CLASS = 'selected_class'; /** @inheritdoc */ diff --git a/sources/Forms/Block/Expression/AbstractExpressionFormBlock.php b/sources/Forms/Block/Expression/AbstractExpressionFormBlock.php index 8050921bd..71d9b87a5 100644 --- a/sources/Forms/Block/Expression/AbstractExpressionFormBlock.php +++ b/sources/Forms/Block/Expression/AbstractExpressionFormBlock.php @@ -18,7 +18,8 @@ use Symfony\Component\Form\FormEvents; /** * An abstract block to manage an expression. * - * @package Combodo\iTop\Forms\Block\Expression + * @api + * @package FormBlock * @since 3.3.0 */ abstract class AbstractExpressionFormBlock extends AbstractFormBlock diff --git a/sources/Forms/Block/Expression/BooleanExpressionFormBlock.php b/sources/Forms/Block/Expression/BooleanExpressionFormBlock.php index 9364981ba..1445dd27b 100644 --- a/sources/Forms/Block/Expression/BooleanExpressionFormBlock.php +++ b/sources/Forms/Block/Expression/BooleanExpressionFormBlock.php @@ -15,13 +15,23 @@ use Combodo\iTop\Forms\Register\IORegister; * An abstract block to manage an expression. * This block expose two boolean outputs: the result of the expression and its negation. * - * @package Combodo\iTop\Forms\Block\Expression + * @api + * @package FormBlock * @since 3.3.0 */ class BooleanExpressionFormBlock extends AbstractExpressionFormBlock { // Outputs + /** + * Boolean output of the result of the expression + * @api + */ public const OUTPUT_RESULT = "result"; + + /** + * Boolean output of the negation of the result of the expression + * @api + */ public const OUTPUT_NOT_RESULT = "not_result"; /** @inheritdoc */ diff --git a/sources/Forms/Block/Expression/NumberExpressionFormBlock.php b/sources/Forms/Block/Expression/NumberExpressionFormBlock.php index 920567485..6588841b1 100644 --- a/sources/Forms/Block/Expression/NumberExpressionFormBlock.php +++ b/sources/Forms/Block/Expression/NumberExpressionFormBlock.php @@ -12,15 +12,21 @@ use Combodo\iTop\Forms\IO\Format\NumberIOFormat; use Combodo\iTop\Forms\Register\IORegister; /** - * A block to manage an number expression. + * A block to manage a number expression. * This block expose a number output: the result of the expression. * - * @package Combodo\iTop\Forms\Block\Expression + * @api + * @package FormBlock * @since 3.3.0 */ class NumberExpressionFormBlock extends AbstractExpressionFormBlock { // Outputs + + /** + * Number output of the result of the expression + * @api + */ public const OUTPUT_RESULT = "result"; /** @inheritdoc */ diff --git a/sources/Forms/Block/Expression/StringExpressionFormBlock.php b/sources/Forms/Block/Expression/StringExpressionFormBlock.php index 13aed6593..9f9868f9d 100644 --- a/sources/Forms/Block/Expression/StringExpressionFormBlock.php +++ b/sources/Forms/Block/Expression/StringExpressionFormBlock.php @@ -10,9 +10,22 @@ namespace Combodo\iTop\Forms\Block\Expression; use Combodo\iTop\Forms\IO\Format\StringIOFormat; use Combodo\iTop\Forms\Register\IORegister; +/** + * A block to manage a string expression. + * This block expose a string output: the result of the expression. + * + * @api + * @package FormBlock + * @since 3.3.0 + */ class StringExpressionFormBlock extends AbstractExpressionFormBlock { // Outputs + + /** + * String output of the result of the expression + * @api + */ public const OUTPUT_RESULT = 'result'; /** @inheritdoc */ diff --git a/sources/Forms/Block/FormBlockService.php b/sources/Forms/Block/FormBlockService.php index 4dd74ed68..70d26db88 100644 --- a/sources/Forms/Block/FormBlockService.php +++ b/sources/Forms/Block/FormBlockService.php @@ -20,7 +20,7 @@ class FormBlockService { private PropertyTypeService $oPropertyTypeService; - public function __construct(ModelReflection $oModelReflection = null) + public function __construct() { $this->oPropertyTypeService = \MetaModel::GetService('PropertyTypeService'); } diff --git a/sources/Forms/FormBuilder/FormFactoryBuilderService.php b/sources/Forms/FormBuilder/FormFactoryBuilderService.php index d346f8ddf..b65d685f8 100644 --- a/sources/Forms/FormBuilder/FormFactoryBuilderService.php +++ b/sources/Forms/FormBuilder/FormFactoryBuilderService.php @@ -20,6 +20,7 @@ use Symfony\Component\Security\Csrf\CsrfTokenManager; * Factory form builder (from Symfony form component @link https://symfony.com/doc/current/components/form.html) * * @since 3.3.0 + * @api */ class FormFactoryBuilderService {