composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-13 07:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

N°7063 - Forms SDK - Add Symfony forms component

Browse Source 
error forms issue
This commit is contained in:
Benjamin Dalsass
2024-01-10 09:32:05 +01:00
parent 54d98ba4f7
commit c7281a5cfc
9 changed files with 140 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
sources/FormImplementation/Helper/FormHelper.php
View File

@@ -53,6 +53,7 @@ class FormHelper
* @return \Combodo\iTop\FormSDK\Service\FormFactory
* @throws \ArchivedObjectException
* @throws \CoreException
* @throws \Exception
*/
static public function CreateSampleFormFactory(FormManager $oFormManager, RouterInterface $oRouter, int $iMode) : FormFactory
{
@@ -260,6 +261,12 @@ class FormHelper
]
]);
// file - file download
$oFormFactory->AddFileField('file', [
'label' => 'Download a file',
'required' => false
]);
}
if(self::$MODES_DEFINITIONS[$iMode]['layout']){
@@ -273,12 +280,13 @@ class FormHelper
],
'column__2' => [
'css_classes' => 'custom-container container-color mb-3',
'fieldset__2' => ['mode', 'interval'],
'fieldset__1' => ['mode', 'interval'],
],
],
'row__2' => [
'css_classes' => 'custom-container container-color2 mb-3',
'fieldset__2' => ['file'],
]
];
@@ -297,4 +305,95 @@ class FormHelper
return $oFormFactory;
}
private function Definitions()
{
// condensé // + lisible - organisé // generic id
$aDescription = [
'row__1' => [
'column__1' => [
'css_classes' => 'custom-container container-flower layout-grow',
'fieldset__1' => [ 'birthday', 'city', 'tel'],
],
'column__2' => [
'css_classes' => 'custom-container container-color mb-3',
'fieldset__1' => ['mode', 'interval'],
],
],
'row__2' => [
'css_classes' => 'custom-container container-color2 mb-3',
'fieldset__2' => ['file'],
]
];
// etendu // - lisible + organisé // free id
$aDescription2 = [
'1' => [
'properties' => [
'type' => 'row',
'css_classes' => 'custom-container container-flower layout-grow',
'rank' => 1
],
'content' => [
'11' => [
'properties' => [
'type' => 'column',
'rank' => 1
],
'content' => [
'111' => [
'properties' => [
'type' => 'fieldset',
'rank' => 1
],
],
'112' => [
'properties' => [
'type' => 'fieldset',
'rank' => 1
],
]
]
]
],
'column__1' => [
'css_classes' => 'custom-container container-flower layout-grow',
'fieldset__1' => [ 'birthday', 'city', 'tel'],
],
'column__2' => [
'css_classes' => 'custom-container container-color mb-3',
'fieldset__1' => ['mode', 'interval'],
],
],
'row__2' => [
'css_classes' => 'custom-container container-color2 mb-3',
'fieldset__2' => ['file'],
]
];
return [$aDescription, $aDescription2];
}
}

5
sources/FormSDK/Field/FormFieldTypeEnumeration.php
View File

@@ -36,6 +36,7 @@ enum FormFieldTypeEnumeration
case DURATION;
case FIELDSET;
case COLLECTION;
case FILE;
/**
* Return available options.
@@ -47,7 +48,7 @@ enum FormFieldTypeEnumeration
// global options
$aOptions = ['required', 'disabled', 'attr', 'label', 'label_attr', 'help'];
// specific options
// : specific options
return match ($this) {
FormFieldTypeEnumeration::TEXT => array_merge($aOptions,
['constraints']
@@ -86,7 +87,7 @@ enum FormFieldTypeEnumeration
// retrieve available options
$aAvailableOptions = $this->GetAvailableOptions();
// check each option...
// check each options...
foreach($aOptions as $sKey => $oOption){
if(!in_array($sKey, $aAvailableOptions)){
$aInvalidOptions[] = $sKey;

9
sources/FormSDK/Service/FormFactory.php
View File

@@ -35,13 +35,13 @@ use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
*/
final class FormFactory
{
/** @var array $aFieldsDescriptions form types descriptions */
/** @var array $aFieldsDescriptions form fields descriptions */
private array $aFieldsDescriptions = [];
/** @var mixed $oFieldsData form data */
/** @var mixed $oFieldsData form fields data */
private mixed $oFieldsData = [];
/** @var array $aLayoutDescription description of the layout */
/** @var array $aLayoutDescription layout description */
private array $aLayoutDescription = [];
/** @var \Combodo\iTop\FormSDK\Service\FactoryAdapter\FormFactoryAdapterInterface[] $aAdapters list of adapters */
@@ -180,8 +180,7 @@ final class FormFactory
*/
public function CreateForm(?string $sName = null) : mixed
{
$aFieldsDescriptions = $this->GetFieldsDescriptions();
return $this->oSymfonyBridge->CreateForm($aFieldsDescriptions, $this->GetData(), $sName, $this->GetLayoutDescription());
return $this->oSymfonyBridge->CreateForm($this->GetFieldsDescriptions(), $this->GetData(), $sName, $this->GetLayoutDescription());
}
}

16
sources/FormSDK/Service/FormFactoryBuilderTrait.php
View File

@@ -287,4 +287,20 @@ trait FormFactoryBuilderTrait
return $this;
}
/**
* Add file field.
*
* @param string $sKey
* @param array $aOptions
*
* @return \Combodo\iTop\FormSDK\Service\FormFactory
* @throws \Exception
*/
public function AddFileField(string $sKey, array $aOptions) : FormFactory
{
$this->aFieldsDescriptions[$sKey] = new FormFieldDescription($sKey, FormFieldTypeEnumeration::FILE, $aOptions);
return $this;
}
}

15
sources/FormSDK/Symfony/SymfonyBridge.php
View File

@@ -30,6 +30,7 @@ use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\DateIntervalType;
use Symfony\Component\Form\Extension\Core\Type\DateType;
use Symfony\Component\Form\Extension\Core\Type\FileType;
use Symfony\Component\Form\Extension\Core\Type\FormType;
use Symfony\Component\Form\Extension\Core\Type\NumberType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
@@ -135,6 +136,14 @@ class SymfonyBridge
'options' => $aOptions
];
case FormFieldTypeEnumeration::FILE:
$aOptions = $oFormDescription->GetOptions();
return [
'name' => $oFormDescription->GetName(),
'type' => FileType::class,
'options' => $aOptions
];
default:
return null;
}
@@ -147,7 +156,8 @@ class SymfonyBridge
*
* @return void
*/
private function TransformFieldsetOptions(array &$aOptions){
private function TransformFieldsetOptions(array &$aOptions) : void
{
$aFields = [];
foreach ($aOptions['fields'] as $oChildFormDescription){
@@ -164,7 +174,8 @@ class SymfonyBridge
*
* @return void
*/
private function TransformCollectionOptions(array &$aOptions){
private function TransformCollectionOptions(array &$aOptions) : void
{
$aOptions['entry_type'] = FieldsetType::class;

2
sources/FormSDK/Symfony/Type/Compound/CollectionType.php
View File

@@ -61,6 +61,6 @@ class CollectionType extends AbstractType
/** @inheritdoc */
public function getBlockPrefix()
{
return 'itop_collection';
return 'itop_collection'; // need a specific block prefix as we create a CollectionType that's already exist in Symfony namespace
}
}

2
sources/FormSDK/Symfony/Type/Compound/FieldsetType.php
View File

@@ -37,8 +37,6 @@ class FieldsetType extends AbstractType
/** @inheritdoc */
public function buildForm(FormBuilderInterface $builder, array $options) : void
{
foreach ($options['fields'] as $oField){
$builder->add($oField['name'], $oField['type'], $oField['options']);
}

2
sources/FormSDK/Symfony/Type/Layout/LayoutType.php
View File

@@ -47,7 +47,7 @@ class LayoutType extends AbstractType
{
$resolver->setDefaults([
'fields' => [],
'inherit_data' => true // this type is abstract and used for grouping
'inherit_data' => true // this type is abstract and used for logical grouping
]);
}

2
templates/formSDK/themes/portal.html.twig
View File

@@ -26,6 +26,8 @@
<span class="ajax-query-type">OQL</span>
{% endif %}
<i class="fa-solid fa-fingerprint" title="{{ form.vars.id }}"></i>
</div>
{% endif %}