Développement d'un composant de base

Détails du fichier

helloworld.xml

Il s'agit d'un fichier manifeste qui décrit le composant et sa configuration à Joomla! Il est utilisé lors de l'installation pour copier les fichiers du composant dans les emplacements corrects, déclencher l'installation de la base de données, configurer l'espace de noms PHP du composant, etc ...

<?xml version="1.0" encoding="utf-8"?>
<extension type="component" method="upgrade">
<!--  L'attribut 'version' pour la balise 'extension' n'est plus utilisé. -->

    <name>Hello World</name>
    <!-- Les éléments suivants sont facultatifs et exempts de contraintes de formatage. -->
    <creationDate>December 2020</creationDate>
    <!-- Auteur fictif, n'hésitez pas à le remplacer partout où vous le voyez.-->
    <author>John Smith</author>
    <authorUrl>https://smith.ca</authorUrl>
    <copyright>John Smith</copyright>
    <license>GPL v3</license>
    <!--  The version string is recorded in the components table -->
    <version>0.0.1</version>
    <!-- The description is optional and defaults to the name -->
    <description>
        A hello world component!
    </description>

    <!-- Il s'agit de l'espace de noms PHP sous lequel le code de l'extension est organisé. Il devrait suivre ce format :
    
    Vendor\Component\ComponentName

    "Vendor" can be your company or your own name
    
   "Vendor" peut être le nom de votre entreprise ou votre propre nom.

La section "ComponentName" DOIT correspondre au nom utilisé partout ailleurs pour votre composant. Quel que soit le nom de ce fichier XML, l'espace de noms doit correspondre (en ignorant la casse).
    -->
    <namespace path="src/">JohnSmith\Component\HelloWorld</namespace>
            
    <administration>
        <!-- Le lien qui apparaîtra dans le menu "Composants" du panneau d'administration : -->
        <menu link="index.php?option=com_helloworld">Hello World</menu>
        <!-- Liste des fichiers et dossiers à copier. Notez l'attribut 'folder'. C'est le nom du dossier dans votre package de composant à partir duquel effectuer la copie : -->
        <files folder="admin/">
            <folder>services</folder>
            <folder>src</folder>
            <folder>tmpl</folder>
        </files>
    </administration>

</extension>

`admin/services/provider.php` est un fichier spécial qui indique à Joomla! comment initialiser le composant, c'est-à-dire quels services il nécessite et comment ils doivent être fournis.

<?php

defined('_JEXEC') or die;

use Joomla\CMS\Dispatcher\ComponentDispatcherFactoryInterface;
use Joomla\CMS\Extension\ComponentInterface;
use Joomla\CMS\Extension\MVCComponent;
use Joomla\CMS\Extension\Service\Provider\ComponentDispatcherFactory;
use Joomla\CMS\Extension\Service\Provider\MVCFactory;
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;

return new class implements ServiceProviderInterface {
    
    public function register(Container $container): void {
        $container->registerServiceProvider(new MVCFactory('\\JohnSmith\\Component\\HelloWorld'));
        $container->registerServiceProvider(new ComponentDispatcherFactory('\\JohnSmith\\Component\\HelloWorld'));
        $container->set(
            ComponentInterface::class,
            function (Container $container) {
                $component = new MVCComponent($container->get(ComponentDispatcherFactoryInterface::class));
                $component->setMVCFactory($container->get(MVCFactoryInterface::class));

                return $component;
            }
        );
    }
};

<?php

namespace JohnSmith\Component\HelloWorld\Administrator\Controller;

defined('_JEXEC') or die;

use Joomla\CMS\MVC\Controller\BaseController;

/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2020 John Smith. All rights reserved.
 * @license     GNU General Public License version 3; see LICENSE
 */

/**
 * Default Controller of HelloWorld component
 *
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 */
class DisplayController extends BaseController {
    /**
     * The default view for the display method.
     *
     * @var string
     */
    protected $default_view = 'hello';
    
    public function display($cachable = false, $urlparams = array()) {
        return parent::display($cachable, $urlparams);
    }
    
}

<?php

namespace JohnSmith\Component\HelloWorld\Administrator\View\Hello;

defined('_JEXEC') or die;

use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;

/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2020 John Smith. All rights reserved.
 * @license     GNU General Public License version 3; see LICENSE
 */

/**
 * Main "Hello World" Admin View
 */
class HtmlView extends BaseHtmlView {
    
    /**
     * Display the main "Hello World" view
     *
     * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
     * @return  void
     */
    function display($tpl = null) {
        parent::display($tpl);
    }

}

`admin/tmpl/hello/default.php`

Ce fichier contient le modèle de la page. Il est utilisé pour rendre la page en utilisant la configuration effectuée par l'objet de vue.

Lorsqu'aucune mise en page spécifique n'est demandée pour une vue, Joomla! chargera le modèle du fichier default.php, c'est pourquoi nous utilisons ce nom de fichier.

<?php

/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2020 John Smith. All rights reserved.
 * @license     GNU General Public License version 3; see LICENSE
 */

 // No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<h2>Hello world!</h2>

Installation du composant Joomla!

L'installation du composant se fait généralement en suivant ces étapes :

1. **Archivage :** Regroupez tous les fichiers du composant dans une archive, comme un fichier ZIP.

2. **Panneau d'administration Joomla! :** Connectez-vous au panneau d'administration de votre site Joomla!.

3. **Gestionnaire d'extensions :** Accédez à l'onglet "Extensions" dans le panneau d'administration, puis sélectionnez "Gestionnaire d'extensions".

4. **Téléchargement :** Sélectionnez l'onglet "Installer" et téléchargez le fichier d'archive ZIP contenant votre composant.

5. **Installation :** Cliquez sur le bouton "Installer" pour installer le composant depuis le fichier ZIP.

6. **Vérification :** Une fois l'installation terminée, vérifiez si le composant apparaît dans la liste des extensions installées.

7. **Configuration :** En fonction du composant, vous pourriez avoir besoin de le configurer via le gestionnaire d'extensions ou d'autres paramètres spécifiques au composant.

8. **Vérification sur le site :** Accédez à la partie frontale de votre site Joomla! et assurez-vous que le composant fonctionne comme prévu.

N'oubliez pas de consulter la documentation spécifique à votre composant pour des instructions détaillées d'installation et de configuration.

Tester le composant

Une fois que le composant est installé, cliquez sur la section "Composants" dans le menu à gauche du panneau d'administration. Vous devriez maintenant voir un nouveau lien sous cette section intitulé "Hello World". C'est le lien détaillé dans le fichier manifeste du composant. Si vous cliquez dessus, vous devriez voir la page "Hello World".

Félicitations ! Vous avez créé votre premier composant Joomla ! Maintenant, commençons à le rendre utile.