Custom Back - End Configuration dans Magento

Dans ce tutoriel, je vais vous présenter la configuration de modules personnalisés dans le back-end de Magento. Il est toujours utile de fournir un ensemble d'options configurables du module dans le back-end, ce qui permet aux administrateurs de configurer facilement les paramètres spécifiques au module. Nous allons suivre le processus de configuration de la configuration du module en créant un module personnalisé dans Magento..

Introduction à la configuration personnalisée dans Magento

En tant que développeur, au cours du processus de création de module personnalisé, vous pouvez penser qu’il serait intéressant de pouvoir transférer le contrôle de certains paramètres spécifiques au module sur le back-end. Magento vous permet d'y parvenir à l'aide d'un système de configuration basé sur un fichier XML. Il vous suffit de configurer les fichiers conformément aux conventions de Magento, et ils seront automatiquement récupérés! La plupart du temps, vous devrez gérer de nombreux paramètres configurables fournis par les modules centraux lors de la configuration du magasin frontal de base..

Je suppose que vous connaissez le processus de création de modules de base dans Magento. Voici un bel article, si vous souhaitez en savoir plus sur les modules personnalisés dans Magento. Cela dit, Magento respecte la convention sur le paradigme de la configuration, ce qui devrait faciliter la compréhension si vous débutez dans le processus de développement de modules personnalisés..

Créer un module personnalisé pour fournir une configuration personnalisée

Au cours de ce didacticiel, je vais créer un module personnalisé de base nommé "CustomConfig" qui fournit la configuration dorsale sous le Système> Configuration menu. Voici la liste des fichiers requis pour la configuration souhaitée:

app / etc / modules / Envato_All.xml: C'est un fichier utilisé pour activer notre module personnalisé.
app / code / local / Envato / CustomConfig / etc / config.xml: C'est un fichier de configuration de module.
app / code / local / Envato / CustomConfig / etc / system.xml: C'est un fichier qui déclare les options de configuration de notre module.
app / code / local / Envato / CustomConfig / Model / Options.php: C'est un fichier de modèle qui fournit les options pour certains éléments de configuration de formulaire.
app / code / local / Envato / CustomConfig / Helper / Data.php: C'est un fichier utilisé par le système de traduction Magento.

Configuration des fichiers

Pour commencer, nous allons créer un fichier d'activation de module. Créez un fichier "app / etc / modules / Envato_All.xml" et collez le contenu suivant dans ce fichier. Nous avons utilisé "Envato" comme espace de noms de module et "CustomConfig" comme nom de module. Cela activera notre module "CustomConfig" par défaut.

    vrai local

Ensuite, nous devons créer un fichier de configuration de module. Créez "app / code / local / Envato / CustomConfig / etc / config.xml" et collez le contenu suivant dans ce fichier.

    0.0.1      Envato_CustomConfig_Helper     Envato_CustomConfig_Model              Section de configuration personnalisée

Vous devez être familiarisé avec la déclaration du modèle et de la classe d'assistance conformément aux conventions de Magento. Bien sûr, le tag est nouveau pour vous, ce qui nous préoccupe dans le cadre de ce didacticiel. Passons en revue chaque balise en détail pour comprendre ce qu’elle représente.

le tag est utilisé pour définir les ressources du côté admin. Dans notre exemple, la page de configuration de notre module est une ressource. De plus, nous avons utilisé le tag pour envelopper un tag, ce qui signifie qu'il ne sera accessible qu'aux utilisateurs authentifiés.

Les deux balises suivantes sont utilisées pour définir le chemin de notre page de configuration back-end. Le chemin de notre page de configuration ressemble donc à "admin / system / config / customconfig_options". Bien sûr, la dernière balise devrait être unique afin qu'il ne soit pas en conflit avec d'autres extensions.

Pour aller de l'avant, définissons le fichier le plus important, "system.xml". Créez "app / code / local / Envato / CustomConfig / etc / system.xml" et collez le contenu suivant dans ce fichier.

    Onglet Configuration personnalisée 1     Paramètres de configuration personnalisés configuration personnalisée texte 1 1 1 1   Section un texte 1 1 1 1   Champ de texte personnalisé texte 1 1 1 1 Exemple de champ de texte.     Section deux texte 2 1 1 1   Champ de sélection personnalisé sélectionner configuration personnalisée / options 1 1 1 1 Exemple de champ sélectionné.   Champ radio personnalisé radios configuration personnalisée / options 2 1 1 1 Exemple de champ radios.   Champ multisélection personnalisé sélection multiple configuration personnalisée / options 3 1 1 1 Exemple de champ multisélection.

Comme vous l'avez peut-être deviné, ce fichier est responsable de l'affichage d'une page de configuration de notre module dans le back-end. Examinons de plus près certaines des balises importantes de ce fichier..

le tag est utilisé pour définir les onglets qui seront affichés sur le côté gauche de la page de configuration. Et le balise est utilisée pour définir des sections sous chaque onglet.

Essayons de le comprendre à travers un exemple. Aller à Système> Configuration au fond de Magento. Vous remarquerez qu'il existe différents onglets comme Général, Catalogue, Clients, etc.

Sous chaque onglet, vous verrez également différentes sections. Par exemple, sous la Avancée tag, il y a Admin, Système, Avancé et Développeur sections. Dans notre cas, nous aurons un Paramètres de configuration personnalisés section sous le Onglet Configuration personnalisée.

Ensuite, nous utilisons le balise pour regrouper des champs de configuration similaires. Par exemple, vous souhaitez afficher les champs liés à l’image et les champs liés au courrier électronique dans différentes sections. Pour cela, nous avons défini et Mots clés.

Enfin, nous encapsulons les champs de chaque section avec étiquette. Dans notre exemple, nous avons fourni un champ de texte sous le groupe de champs "Section 1", tandis que d'autres champs tels que les zones de sélection, les boutons radio et la sélection multiple sont disponibles sous le groupe de champs "Section deux". Voilà pour le fichier "system.xml".

Créons ensuite un fichier modèle "app / code / local / Envato / CustomConfig / Model / Options.php".

1, 'label' => 'One'), tableau ('valeur' => 2, 'label' => 'deux'), tableau ('valeur' => 3, 'label' => 'trois'), tableau ('valeur' => 4, 'étiquette' => 'quatre'));

Rien d'extraordinaire ici. Il est simplement utilisé pour alimenter des options dans un champ de formulaire radio et pour sélectionner le champ de formulaire dans le formulaire de configuration..

Enfin, nous devrons créer le fichier "app / code / local / Envato / CustomConfig / Helper / Data.php" afin de nous assurer que le système de traduction de Magento fonctionne correctement. C'est presque un fichier vide, mais devrait être là selon les conventions!

Nous en avons terminé avec la configuration des fichiers. Dans la section suivante, nous vérifierons son apparence dans le back-end de Magento..

Parcourez le back-end pour tester la configuration personnalisée

Rendez-vous à l'arrière de Magento et effacez toutes les caches. On peut y arriver en allant à Système> Gestion du cache.

Maintenant, allez à Système> Configuration pour ouvrir la page de configuration. Vous devriez remarquer ONGLET CONFIGURATION PERSONNALISÉE sur le côté gauche de la page. En vertu de cela, le Paramètres de configuration personnalisés Ce lien est disponible, et en cliquant dessus, une page de configuration de notre module s’ouvrira. Si vous ne le voyez pas, essayez de vous déconnecter de la section admin et de vous reconnecter..

C'est une belle interface qui fonctionne immédiatement, n'est-ce pas? Vous pouvez jouer un peu, remplir le formulaire et cliquer sur le bouton Enregistrer la configuration bouton pour valider les modifications et Magento se chargera du reste.

Pour accéder aux valeurs des paramètres de configuration dans le code, vous pouvez utiliser le getStoreConfig méthode statique. Par exemple, vous pouvez récupérer la valeur du custom_field_one paramètre en utilisant la syntaxe suivante:

Mage :: getStoreConfig ('customconfig_options / section_one / custom_field_one');

La syntaxe est assez simple: vous devez utiliser le modèle "nom de section / nom de groupe / nom de champ" défini dans le fichier system.XML..

Conclusion

La configuration du système administrateur est l’un des composants les plus puissants et les plus utiles de Magento. Magento vous permet de brancher très facilement des paramètres de configuration personnalisés, grâce à l’extensibilité de l’un des systèmes de commerce électronique les plus puissants! Partagez vos pensées en utilisant le flux ci-dessous!

Code