Contrôleur
Le contrôleur est ce que son nom suggère. C'est un fichier propre et simple collant les modèles et les vues avec la logique de contrôleur de base. Un contrôleur ne doit jamais avoir de logique compliquée ou de fonction de données à l'intérieur, même s'il fonctionnera toujours.
Un contrôleur est le premier fichier appelé par le système de navigation lorsqu'il est sélectionné. Le contrôleur décide ensuite des actions à entreprendre, des données à charger, puis pousse cette charge vers ce que l'utilisateur final visualise.
Création du contrôleur
Le contrôleur peut être autonome, c'est le noud auquel le menu accédera lorsqu'il sera exécuté. La première chose à faire est de créer le fichier du contrôleur. Dans votre dossier plugins, créez un fichier de nom échantillonné appelé :
| controllers/example-control.php |
Dans votre exemple de contrôleur, ajoutez le contenu suivant :
- class exampleControl extends PHPDS_controller {
- /**
- * Exécuter le contrôleur
- * @author Sylvain Maltais
- */
- public function execute() {
- $this->template->heading(_('Exemple de contrôleur.'));
- $this->template->info(_('Ceci est un exemple de contrôleur.'));
- /* Continuer à coder... */
- }
- }
-
- return 'exampleControl'
Une fois votre contrôleur prêt, vous pouvez lui associer un élément de menu; en déclarant un menu, un élément apparaît dans le tableau de bord qui, une fois cliqué, exécutera notre script. Allez dans System Management -> Menu Admin -> New Menu -> Fill the fields as as comme suit :
| Champ | Description |
|---|---|
| Plugin Item | Plugin standard (laissez le reste de la colonne de gauche vide). |
| Name | Le nom d'affichage visible par l'utilisateur ; essayons «Exemple de contrôleur» (notez que ce nom peut être différent en fonction de la langue de l'utilisateur) |
| Alias | Un nom alternatif, pouvant être utilisé à partir du code pour faire référence au menu quelle que soit la langue de l'utilisateur; essayons "hello-world" |
| Plugin Name/Folder | Le nom du dossier dans lequel se trouve votre plugicel; nous avons choisi «tutoriel» plus tôt. |
| URL or path | Cela indiquera au moteur où trouver exactement notre fichier de script ; c'est «example-control.php». |
Laissez le reste aux valeurs par défaut et cliquez sur «Save». Cliquez ensuite sur «Dashboard» dans le menu supérieur : votre nouvel élément de menu devrait apparaître, lors de son exécution, il devrait afficher votre contenu.
Contenu du contrôleur
Maintenant que votre contrôleur est exécutable, vous pouvez le remplir de code, notamment en y apportant des modèles et des vues. Un contrôleur typique ressemblera éventuellement à ceci :
- class manageExample extends PHPDS_controller {
-
- /**
- * Execute Contrôleur
- * @author Sylvain Maltais
- */
- public function execute() {
- /* Définition */
- $id = 0;
- $example_name = '';
- $example_note = '';
- $alias = '';
-
- /* Créons des informations d'entête. */
- if (!empty($this->security->get['ee']) || !empty($this->security->post['save'])) {
- $this->template->heading(_('Nous sommes en mode édition, éditons un exemple.'));
- $this->template->info(_('En utilisant PHPDevShells, créez un lien symbolique vers une autre fonctionnalité d\'élément. Il est possible de créer un lien symbolique vers l\'exemple de gestion d\'origine pour gérer les modifications.'));
-
- /* Mettre en mode édition. */
- $edit_mode = true;
-
- /* Définir l'ID d'exemple d'édition. */
- (!empty($this->security->get['ee'])) ? $ee = $this->security->get['ee'] : $ee = 0;
-
- } else {
- $this->template->heading(_('Add new Example'));
- $this->template->info(_('Sur cette page, nous vous montrerons comment créer un formulaire simple et enregistrer des données dans la base de données.'));
-
- /* Mettre en mode édition. */
- $edit_mode = false;
-
- /* Définir l'ID du groupe d'édition. */
- $ee = 0;
- }
- /* Si l'article est publié, lisons-le et sauvegardons-le dans la base de données. */
- if (!empty($this->security->post['save'])) {
- if (!empty($this->security->post['id'])) {
- $id = $this->security->post['id'];
- } else {
- $id = 0;
- }
- if (! empty($this->security->post['id']))
- $id = $this->security->post['id'];
- $example_name = $this->security->post['example_name'];
- $example_note = $this->security->post['example_note'];
- $alias = $this->security->post['alias'];
-
- /* Vérification d'erreurs mineures. */
- if (empty($example_name)) {
- $this->template->warning(_('Vous devez fournir des valeurs pour tous les champs, veuillez réessayer.'));
- $error[1] = true;
- }
- /* Si tout va bien, nous pouvons maintenant sauvegarder. */
- if (empty($error)) {
- $id = $this->db->invokeQuery('ExamplePlugin_writeExampleQuery', $id, $example_name, $example_note, $alias);
- // Show item updated.
- $this->template->ok(sprintf(_('Bien, %s a été enregistré dans la base de données.'), $example_name));
- }
- }
- /* Modifier l'exemple et charger les données pour l'exemple. */
- if (!empty($edit_mode) && !empty($ee)) {
- /* Si l'élément est en mode édition. */
- $ex_array = $this->db->invokeQuery('ExamplePlugin_editExampleQuery', $ee);
-
- $id = $ex_array['id'];
- $example_name = $ex_array['example_name'];
- $example_note = $ex_array['example_note'];
- $alias = $ex_array['alias'];
- }
-
- /* Charger le plugiciel de vues. */
- $view = $this->factory('views');
-
- /* Définir des valeurs. */
- $view->set('self_url', $this->navigation->selfUrl());
- $view->set('id', $id);
- $view->set('example_name', $example_name);
- $view->set('example_note', $example_note);
- $view->set('alias', $alias);
-
- /* Sortie à afficher. */
- $view->show();
- }
- }
-
- return 'manageExample';
Comme toujours, PHPDevShell n'essaiera jamais de vous forcer à utiliser son système de modèles. Vous pouvez effectuer des requêtes directes depuis le contrôleur. Pour effectuer une requête directe, il vous suffit de :
- $query = $this->db->newQuery('SELECT * FROM _db_core_users');
- /* Ou utilisez sa méthode alias qui fait exactement la même chose */
- $query = $this->db->sqlQuery('SELECT * FROM _db_core_users');
Dans l'exemple ci-dessus, on voit comment les vues et les modèles sont réalisés à l'intérieur du contrôleur.