Ajouter un modèle à la partie site

Cet article fait partie du tutoriel "Développer un composant MVC pour Joomla 4.x". Il est destiné à être un tutoriel de programmation à suivre, donc si vous n'avez pas lu les parties précédentes du tutoriel, il est recommandé de le faire.

Maintenant que nous avons mis en place les parties "Contrôleur" et "Vue" du motif de conception Modèle-Vue-Contrôleur, dans cet article, nous ajouterons un modèle à notre composant Hello World. Le modèle stockera certaines données d'exemple que notre modèle de page (template) rendra. Pour créer un modèle, nous étendons l'un des modèles abstraits fournis par Joomla! Plusieurs de ces modèles existent et peuvent être trouvés dans l'espace de noms Joomla\CMS\MVC\Model :

'site/src/Model/MessageModel.php'

Le nouveau modèle de données pour un seul élément. La méthode getItem() est la seule requise lors de l'extension de ItemModel. Elle renvoie un objet qui représente l'élément du modèle. Cet "élément" pourrait être n'importe quoi, mais il s'agit généralement d'un enregistrement de base de données. Jusqu'à ce que nous connectons ce modèle à la base de données dans une partie future du tutoriel, nous renverrons un objet de base avec notre nouveau message, directement depuis le système de langage.

<?php

namespace JohnSmith\Component\HelloWorld\Site\Model;

defined('_JEXEC') or die;

use Joomla\CMS\MVC\Model\ItemModel;
use Joomla\CMS\Language\Text;

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

/**
 * Hello World Message Model
 * @since 0.0.5
 */
class MessageModel extends ItemModel {

    /**
     * Returns a message for display
     * @param integer $pk Primary key of the "message item", currently unused
     * @return object Message object
     */
    public function getItem($pk= null): object {
        $item = new \stdClass();
        $item->message = Text::_('COM_HELLOWORLD_MSG_GREETING');
        return $item;
    }
        
}

'site/src/Controller/DisplayController.php'

Nous allons indiquer au DisplayController d'ajouter notre nouveau modèle à la vue lors de son chargement. Comme nous n'avons actuellement qu'une seule vue, cela suffira pour le moment. À mesure que notre composant deviendra plus complexe, nos vues auront leurs propres contrôleurs et pourront charger leurs propres modèles de manière indépendante.

<?php

namespace JohnSmith\Component\HelloWorld\Site\Controller;

defined('_JEXEC') or die;

use Joomla\CMS\MVC\Controller\BaseController;
use Joomla\CMS\Factory;

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

/**
 * HelloWorld Component Controller
 * @since  0.0.2
 */
class DisplayController extends BaseController {
    
    public function display($cachable = false, $urlparams = array()) {        
        $document = Factory::getDocument();
        $viewName = $this->input->getCmd('view', 'login');
        $viewFormat = $document->getType();
        
        $view = $this->getView($viewName, $viewFormat);
        $view->setModel($this->getModel('Message'), true);
        
        $view->document = $document;
        $view->display();
    }
    
}