N°7063 - Forms SDK - Add Symfony forms component

error forms issue
2026-04-23 02:28:44 +02:00 · 2023-12-22 11:46:06 +01:00
parent 0cf480d824
commit 3b7cad5cbd
9 changed files with 121 additions and 71 deletions
--- a/sources/FormSDK/Controller/TestController.php
+++ b/sources/FormSDK/Controller/TestController.php
@@ -7,6 +7,7 @@ use Combodo\iTop\FormSDK\Dto\ObjectSearchDto;
 use Combodo\iTop\FormSDK\Helper\SelectHelper;
 use Combodo\iTop\FormSDK\Service\FormManager;
 use Combodo\iTop\Service\Base\ObjectRepository;
+use DateTime;
 use Exception;
 use JsonPage;
 use MetaModel;
@@ -39,26 +40,37 @@ class TestController extends AbstractAppController
 		// build the form
 		$oFormFactory = $oFormManager->CreateFactory();
 		// object plugin
-		$oObjectPlugin = $oFormFactory->CreateObjectPlugin($oPerson, false);
+		$oObjectPlugin = $oFormFactory->CreateObjectAddon($oPerson, true);
 		$oObjectPlugin->AddAttribute('name');
 		$oObjectPlugin->AddAttribute('mobile_phone');
 		// others data
-		$oFormFactory->AddTextField('data1', [
+		$oFormFactory->AddTextField('city', [
 			'label' => 'Ma ville',
 			'constraints' => new Length(['min' => 3])
 		], 'Autun');
-		$oFormFactory->AddTextField('data2', [
+		$oFormFactory->AddTextField('country', [
 			'label' => 'Pays'
 		], 'FRANCE');
-		$oFormFactory->AddSelectField('data3', [
+		$oFormFactory->AddDateField('birthday', [
+			'label' => 'Anniversaire',
+			'widget' => 'single_text',
+		], new DateTime('1979/06/27'));
+		$oFormFactory->AddSelectField('language', [
 			'label' => 'Ma langue',
 			'choices' => SelectHelper::GetApplicationLanguages()
 		], 'FR FR');
-		$oFormFactory->AddSelectAjaxField('data4', [
+		$oFormFactory->AddSelectAjaxField('dog', [
 			'label' => 'Mon Chien',
 			'placeholder' => 'Sélectionnez un chien'
-		], 'http://localhost' . $this->generateUrl('formSDK_ajax_select'), [], 'breed', 'breed', 'breed', 20);
-		$oFormFactory->AddSelectOqlField('data5', [
+		], [
+			'url' => 'http://localhost' . $this->generateUrl('formSDK_ajax_select'),
+			'ajax_query_parameter' => 'query',
+			'value_field' => 'breed',
+			'label_field' => 'breed',
+			'search_field' => 'breed',
+			'threshold' => 20
+		]);
+		$oFormFactory->AddSelectOqlField('friends', [
 			'label' => 'Ma personne',
 		], 'Person', 'SELECT Person', [], '', 20);

--- a/sources/FormSDK/Dto/ObjectSearchDto.php
+++ b/sources/FormSDK/Dto/ObjectSearchDto.php
@@ -12,7 +12,7 @@ class ObjectSearchDto
 		#[Assert\NotBlank]
 		public readonly string $oql,
 		public readonly string $fields,
-		public readonly string $search,
+		public readonly string $search = '',
 	) {
 	}
 }
--- a/sources/FormSDK/Field/Description/FormFieldTypeEnumeration.php
+++ b/sources/FormSDK/Field/Description/FormFieldTypeEnumeration.php
@@ -28,6 +28,7 @@ namespace Combodo\iTop\FormSDK\Field\Description;
 enum FormFieldTypeEnumeration : string
 {
 	case TEXT = 'TEXT';
+	case DATE = 'DATE';
 	case SELECT = 'SELECT';
 	case DB_OBJECT = 'DB_OBJECT';

--- a/sources/FormSDK/Service/FactoryPlugin/FormFactoryPluginInterface.php
+++ b/sources/FormSDK/Service/FactoryPlugin/FormFactoryPluginInterface.php
@@ -25,7 +25,7 @@ namespace Combodo\iTop\FormSDK\Service\FactoryPlugin;
 * @package FormSDK
 * @since 3.2.0
 */
-interface FormFactoryPluginInterface
+interface FormFactoryAddonInterface
 {
 	/**
 	 * Return data attached to the form.
--- a/sources/FormSDK/Service/FactoryPlugin/FormFactoryObjectPlugin.php
+++ b/sources/FormSDK/Service/FactoryPlugin/FormFactoryObjectPlugin.php
@@ -34,7 +34,7 @@ use MetaModel;
 * @package FormSDK
 * @since 3.2.0
 */
-final class FormFactoryObjectPlugin implements FormFactoryPluginInterface
+final class FormFactoryObjectAddon implements FormFactoryAddonInterface
 {
 	/** @var array list of object attributes */
 	private array $aAttributes = [];
@@ -61,7 +61,7 @@ final class FormFactoryObjectPlugin implements FormFactoryPluginInterface
 	 *
 	 * @return $this
 	 */
-	public function AddAttribute(string $sAttributeCode, array $aOptions = []) : FormFactoryObjectPlugin
+	public function AddAttribute(string $sAttributeCode, array $aOptions = []) : FormFactoryObjectAddon
 	{
 		$this->aAttributes[$sAttributeCode] = $aOptions;
 		return $this;
--- a/sources/FormSDK/Service/FormFactory.php
+++ b/sources/FormSDK/Service/FormFactory.php
@@ -20,8 +20,8 @@
 namespace Combodo\iTop\FormSDK\Service;

 use Combodo\iTop\FormSDK\Helper\SelectHelper;
-use Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryObjectPlugin;
-use Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryPluginInterface;
+use Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryObjectAddon;
+use Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryAddonInterface;
 use Combodo\iTop\FormSDK\Symfony\SymfonyBridge;
 use Combodo\iTop\FormSDK\Field\Description\FormFieldDescription;
 use Combodo\iTop\FormSDK\Field\Description\FormFieldTypeEnumeration;
@@ -39,8 +39,8 @@ use utils;
 */
 class FormFactory
 {
-	/** @var \Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryPluginInterface[] $aPlugins  */
-	private array $aPlugins = [];
+	/** @var \Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryAddonInterface[] $aAddons  */
+	private array $aAddons = [];

 	/** @var array $aDescriptions form types descriptions */
 	private array $aDescriptions = [];
@@ -74,7 +74,7 @@ class FormFactory
 		];

 		// append plugin data
-		foreach ($this->GetAllPlugins() as $oPlugin){
+		foreach ($this->GetAllAddons() as $oPlugin){
 			$aResult['descriptions'] = array_merge($aResult['descriptions'], $oPlugin->GetFormDescriptions());
 			$aResult['data'] = array_merge($aResult['data'], $oPlugin->GetFormData());
 		}
@@ -83,42 +83,42 @@ class FormFactory
 	}

 	/**
-	 * Create an object plugin.
+	 * Create an object addon.
 	 *
 	 * @param \DBObject $oDBObject
 	 * @param bool $bGroup
 	 *
-	 * @return \Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryObjectPlugin
+	 * @return \Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryObjectAddon
 	 */
-	public function CreateObjectPlugin(DBObject $oDBObject, bool $bGroup = true) : FormFactoryObjectPlugin
+	public function CreateObjectAddon(DBObject $oDBObject, bool $bGroup = true) : FormFactoryObjectAddon
 	{
-		$oObjectBuilder = new FormFactoryObjectPlugin($oDBObject, $bGroup);
-		$this->AddPlugin(get_class($oDBObject) . '_' . $oDBObject->GetKey(), $oObjectBuilder);
+		$oObjectBuilder = new FormFactoryObjectAddon($oDBObject, $bGroup);
+		$this->AddAddon(get_class($oDBObject) . '_' . $oDBObject->GetKey(), $oObjectBuilder);
 		return $oObjectBuilder;
 	}

 	/**
-	 * Add a plugin.
+	 * Add an addon.
 	 *
 	 * @param string $sKey
-	 * @param \Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryPluginInterface $oPlugin
+	 * @param \Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryAddonInterface $oPlugin
 	 *
 	 * @return $this
 	 */
-	public function AddPlugin(string $sKey, FormFactoryPluginInterface $oPlugin) : FormFactory
+	public function AddAddon(string $sKey, FormFactoryAddonInterface $oPlugin) : FormFactory
 	{
-		$this->aPlugins[$sKey] = $oPlugin;
+		$this->aAddons[$sKey] = $oPlugin;
 		return $this;
 	}

 	/**
-	 * Get all plugins.
+	 * Get all addons.
 	 *
-	 * @return \Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryPluginInterface[]
+	 * @return \Combodo\iTop\FormSDK\Service\FactoryPlugin\FormFactoryAddonInterface[]
 	 */
-	public function GetAllPlugins() : array
+	public function GetAllAddons() : array
 	{
-		return $this->aPlugins;
+		return $this->aAddons;
 	}

 	/**
@@ -132,7 +132,6 @@ class FormFactory
 		return $this->oSymfonyBridge->GetForm($aDescriptions, $aData);
 	}

-
 	/**
 	 * Add text field.
 	 *
@@ -150,6 +149,24 @@ class FormFactory
 		return $this;
 	}

+	/**
+	 * Add date field.
+	 *
+	 * @param string $sKey
+	 * @param array $aOptions
+	 * @param mixed $oData
+	 *
+	 * @return $this
+	 */
+	public function AddDateField(string $sKey, array $aOptions, mixed $oData = null) : FormFactory
+	{
+		$this->aDescriptions[$sKey] = new FormFieldDescription($sKey, FormFieldTypeEnumeration::DATE, $aOptions);
+		$this->aData[$sKey] = $oData;
+
+		return $this;
+	}
+
+
 	/**
 	 * Add select field.
 	 *
@@ -172,38 +189,36 @@ class FormFactory
 	 *
 	 * @param string $sKey
 	 * @param array $aOptions
-	 * @param string $sAjaxUrl
+	 * @param array $aAjaxOptions
 	 * @param array $aAjaxData
-	 * @param string $sValueField
-	 * @param string $sLabelField
-	 * @param string $sSearchField
-	 * @param int $iAjaxThershold
 	 * @param mixed $oData
 	 *
 	 * @return \Combodo\iTop\FormSDK\Service\FormFactory
 	 */
-	public function AddSelectAjaxField(string $sKey, array $aOptions, string $sAjaxUrl, array $aAjaxData, string $sValueField, string $sLabelField, string $sSearchField, int $iAjaxThershold, mixed $oData = null) : FormFactory
+	public function AddSelectAjaxField(string $sKey, array $aOptions, array $aAjaxOptions, array $aAjaxData = [], mixed $oData = null) : FormFactory
 	{
-		// ajax loader options
-		$aAjaxLoaderOptions = [
-			'ajax_url' => $sAjaxUrl,
-			'valueField' => $sValueField ? $sValueField : 'value',
-			'labelField' => $sLabelField ? $sLabelField : 'label',
-			'searchField' => $sSearchField ? $sSearchField : 'search',
+		// ajax options
+		array_merge([
+			'url' => '',
+			'query_parameter' => 'query',
+			'value_field' => 'value',
+			'label_field' => 'label',
+			'search_field' => 'search',
 			'preload' => false,
-		];
+			'threshold' => -1
+		], $aAjaxOptions);

 		// merge options
 		$aOptions = array_merge([
-			'placeholder' => 'Select a value...',
+			'placeholder' => 'Select...',
 			'attr' => [
 				'data-widget' => 'SelectWidget',
-				'data-widget-options' => json_encode($aAjaxLoaderOptions)
+				'data-widget-options' => json_encode($aAjaxOptions)
 			],
-			'choice_loader' => new CallbackChoiceLoader(function() use ($sAjaxUrl, $aAjaxData, $iAjaxThershold): array {
-				$curl_data = utils::DoPostRequest($sAjaxUrl, []);
+			'choice_loader' => new CallbackChoiceLoader(function() use ($aAjaxOptions, $aAjaxData): array {
+				$curl_data = utils::DoPostRequest($aAjaxOptions['url'], []);
 				$response_data = json_decode($curl_data);
-				if(count($response_data->items) > $iAjaxThershold) return [];
+				if(count($response_data->items) > $aAjaxOptions['threshold']) return [];
 				$result = [];
 				foreach ($response_data->items as $e) {
 					$result[$e->breed] = $e->breed;
@@ -232,14 +247,20 @@ class FormFactory
 	 */
 	public function AddSelectOqlField(string $sKey, array $aOptions, string $sObjectClass, string $sOql, array $aFieldsToLoad, string $sSearch, int $iAjaxThershold, mixed $oData = null) : FormFactory
 	{
-//		$sFieldsToLoad = implode($aFieldsToLoad);
-		$aData = [
+		$aAjaxData = [
 			'class' => $sObjectClass,
 			'oql' => $sOql,
-			'fields' => json_encode($aFieldsToLoad),
-			'search' => $sSearch
+			'fields' => '{'.implode($aFieldsToLoad).'}',
 		];
-		$sUrl = 'http://localhost' . $this->oRouter->generate('formSDK_object_search') . '?' . http_build_query($aData);
-		return $this->AddSelectAjaxField($sKey, $aOptions, $sUrl, $aData, 'id', 'friendlyname', 'friendlyname', $iAjaxThershold, $oData);
+		$sUrl = 'http://localhost' . $this->oRouter->generate('formSDK_object_search') . '?' . http_build_query($aAjaxData);
+		$aAjaxOptions = [
+			'url' => $sUrl,
+			'query_parameter' => 'search',
+			'value_field' => 'key',
+			'label_field' => 'friendlyname',
+			'search_field' => 'friendlyname',
+			'threshold' => $iAjaxThershold
+		];
+		return $this->AddSelectAjaxField($sKey, $aOptions, $aAjaxOptions, $aAjaxData, $oData);
 	}
 }
--- a/sources/FormSDK/Symfony/SymfonyBridge.php
+++ b/sources/FormSDK/Symfony/SymfonyBridge.php
@@ -68,6 +68,13 @@ class SymfonyBridge
 					'options' => $oFormDescription->GetOptions()
 				];

+			case FormFieldTypeEnumeration::DATE:
+				return [
+					'path' => $oFormDescription->GetPath(),
+					'type' => DateType::class,
+					'options' => $oFormDescription->GetOptions()
+				];
+
 			case FormFieldTypeEnumeration::SELECT:
 				return [
 					'path' => $oFormDescription->GetPath(),
--- a/templates/formSDK/form.html.twig
+++ b/templates/formSDK/form.html.twig
@@ -48,13 +48,22 @@
               const aOptions = $(this).data('widget-options');

               new TomSelect(`#${sId}`, {
-                   valueField: aOptions['valueField'],
-                   labelField: aOptions['labelField'],
-                   searchField: aOptions['searchField'],
-                   // fetch remote data
+                   valueField: aOptions['value_field'],
+                   labelField: aOptions['label_field'],
+                   searchField: aOptions['search_field'],
+                   maxItems: aOptions['maxItems'],
+                   plugins: {
+                       remove_button:{
+                           title:'Remove this item',
+                       }
+                   },
                   load: function(query, callback) {
-                       const url = aOptions['ajax_url'] + '?query=' + encodeURIComponent(query);
-                       fetch(url)
+                       let sUrl = aOptions['url'];
+                       if(!sUrl.includes('?')){
+                           sUrl += '?';
+                       }
+                       sUrl += '&'  + aOptions['query_parameter'] + '=' + encodeURIComponent(query);
+                       fetch(sUrl)
                               .then(response => response.json())
                               .then(json => {
                                   callback(json.items);
--- a/templates/formSDK/themes/portal.html.twig
+++ b/templates/formSDK/themes/portal.html.twig
@@ -1,16 +1,16 @@
 {% use "bootstrap_5_layout.html.twig" %}

-{%- block form_label -%}
-    {{- parent() -}}
-    <div class="form-type-pictograms">
+{#{%- block form_label -%}#}
+{#    {{- parent() -}}#}
+{#    <div class="form-type-pictograms">#}

-        {% if form.vars.required %}
-            <i class="fas fa-asterisk" title="required"></i>
-        {% endif %}
+{#        {% if form.vars.required %}#}
+{#            <i class="fas fa-asterisk" title="required"></i>#}
+{#        {% endif %}#}

-        {% if form.vars.attr['data-widget'] is defined %}
-            <i class="fas fa-plug" title="{{ form.vars.attr['data-widget'] }}"></i>
-        {% endif %}
+{#        {% if form.vars.attr['data-widget'] is defined %}#}
+{#            <i class="fas fa-plug" title="{{ form.vars.attr['data-widget'] }}"></i>#}
+{#        {% endif %}#}

-    </div>
-{%- endblock form_label -%}
+{#    </div>#}
+{#{%- endblock form_label -%}#}