J3.x

Création d'un module simple - Ajouter des champs de formulaire

From Joomla! Documentation

< J3.x:Creating a simple module
This page is a translated version of the page J3.x:Creating a simple module/Adding Form Fields and the translation is 100% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎Bahasa Indonesia • ‎Nederlands • ‎русский
Joomla! 
3.x
Didacticiel
Création d'un module simple

Ceci est une série de plusieurs articles expliquant la façon de développer un module pour Joomla! Version Joomla 3.x. Vous pouvez naviguer dans les articles de cette série à l'aide du menu déroulant.

Commencez par l'Introduction puis naviguez dans les articles de cette série en utilisant soit les boutons de navigation situés en bas des articles, soit le menu droit (Les articles de cette série).



Dans Joomla, les champs de formulaire permettent une forte personnalisation et, pour les modules, c'est la seule façon de permettre à l'utilisateur de configurer le module selon les besoin de son site.

Ajouter des champs de formulaire au module

Dans notre cas, nous allons étendre notre précédent exemple en utilisant la base de données pour fournir une liste de langues à sélectionner par l'utilisateur. Pour ce faire, nous allons utiliser le type de champs de formulaire SQL (des détails complets sont disponibles sur la page champs de formulaire SQL ).

En premier lieu, nous allons ajouter un champ de formulaire à notre fichier XML. Vous souvenez-vous des balises de configuration que nous avons ajoutées précédemment ? Et bien, maintenant, à l'intérieur de ces balises, nous allons ajouter le code suivant !

<fields name="params">
    <fieldset name="basic">
        <field
               name="lang"
               type="sql"
               default="1"
               label="Select a language"
               query="SELECT id AS value, lang FROM #__helloworld" />
    </fieldset>
</fields>

Cela permet de sélectionner les langues à partir de la table de base de données et permet à l'utilisateur de choisir la langue d'un élément sélectionné.

Si vous installiez le module tel qu'il est actuellement, et alliez dans le module en backend, vous pourriez constater qu'une liste déroulante est apparue (même si pour l'instant la sélection d'une option n'a pas d'effet sur le module).

Remarque : les paramètres de champs de formulaire pour chaque module sont stockés dans la table #__modules sous le champ params en tant que chaîne de code json.

Maintenant, faisons faire quelque chose à notre champ !

Allons dans le mod_helloworld.php et récupérons le paramètre (notez vous ne pouvez pas récupérer le paramètre dans le helper), puis passons le dans la fonction helper.

/**
  * This retrieves the lang parameter we stored earlier. Note the second part
  * which states to use the default value of 1 if the parameter cannot be
  * retrieved for some reason
**/
$language = $params->get('lang', '1');
$hello    = modHelloWorldHelper::getHello( $language );

Maintenant, modifions notre requête de base dans le fichier helper pour refléter notre choix de paramètre.

// Obtain a database connection
$db = JFactory::getDbo();
// Retrieve the shout - note we are now retrieving the id not the lang field.
$query = $db->getQuery(true)
            ->select($db->quoteName('hello'))
            ->from($db->quoteName('#__helloworld'))
            ->where('id = '. $db->Quote($params));
// Prepare the query
$db->setQuery($query);
// Load the row.
$result = $db->loadResult();
// Return the Hello
return $result;

Conclusion

Les champs de formulaire permettent à l'utilisateur de personnaliser facilement un module selon les paramètres de leur site. Cela permet d'augmenter la portée des modules pour de nombreuses langues et applications.