Aller au contenu principal
Version: 26.0.10.0

Contrôleurs

Les contrôleurs Elementum simplifient le développement en fournissant des méthodes pratiques pour gérer les services, les réponses et les redirections.

Créer un contrôleur​

Utilisez la commande Dobby pour générer un nouveau contrôleur :

php dobby make:controller MonController
Convention de nommage

Toujours suffixer le nom par Controller :

  • ✅ HomeController
  • ❌ Home

La commande génère un fichier dans app/Controllers/MonController.php.

Accès aux services​

Méthodes de raccourci​

Accédez facilement aux services courants :

  • customize() → Appareance
  • postTypes() → PostTypes
  • adminPages() → AdminPages
  • templates() → Templates
  • flash() → FlashBag
  • roles() → Roles

Accès générique aux services​

Pour les services non listés, utilisez getService() avec la constante NAME du service :

$router = $this->getService(Router::NAME);

Récupérer un service ou échouer​

La méthode getServiceOrNull() tente de récupérer un service à partir de sa classe. Si le service n'existe pas, retourne null.

$monService = $this->getServiceOrNull(\App\Services\MonService::class);

if ($monService) {
    $monService->doSomething();
}

Paramètres :

  • $serviceClassName (string) : Le nom complet de la classe du service (ex: \App\Services\MonService::class)

Retourne : mixed|null - L'instance du service ou null si la classe n'existe pas

Gestion des réponses​

Affichage de vues​

// Affiche une vue Twig avec des données optionnelles
$this->render('mon-template.html.twig', ['titre' => 'Accueil']);

Réponses JSON​

// Retourne une réponse JSON
$this->json(['status' => 'success', 'data' => $mesDonnees]);

Gestion des redirections​

Redirections de base​

// Redirection vers une URL
$this->redirect('https://exemple.com/mapage');

// Redirection vers une route nommée
$this->redirectToRoute('nom_de_ma_route');

Redirections avancées​

// Retour à la page précédente (ou page d'accueil)
$this->redirectBack();

// Redirection vers un article
$this->redirectToPost(123); // Par ID
$this->redirectToPost($monObjetPost); // Ou par objet WP_Post

Récupération de contenu​

getPostType est déprécié.

// Récupère un type de contenu personnalisé
$monTypeContenu = $this->postType('mon-type');

// Fonctionne aussi avec les types natifs
$articles = $this->postType('post');
$pages = $this->postType('page');

Récupération de page admin​

La méthode page() permet de récupérer une page admin spécifique par son slug.

// Récupère une page admin
$page = $this->page('settings');

if ($page) {
    // Manipuler la page
    echo $page->getTitle();
}

Paramètres :

  • $pageSlug (string) : Le slug de la page admin à récupérer

Retourne : AdminPage|null - L'objet AdminPage ou null si non trouvé

Exemple complet dans un controller :

app/Controllers/Admin/DashboardController.php
use Elementum\Attributes\Template;

class DashboardController
{
    #[Template('admin/dashboard.html.twig')]
    public function index(): array
    {
        // Récupère une page admin spécifique
        $settingsPage = $this->page('settings');

        return [
            'settingsPage' => $settingsPage,
            'settingsUrl' => $settingsPage ? $settingsPage->getUrl() : null
        ];
    }
}

Helper Response​

Le helper Response (namespace Elementum\Helpers) permet de définir le code de statut HTTP ou d'envoyer une réponse JSON depuis n'importe quel controller.

Response::send(int $code)​

Définit le code de statut HTTP. Pour un 404, appelle également $wp_query->set_404() en interne.

use Elementum\Helpers\Response;

Response::send(404);
return $this->render('@elementum/login/404.html.twig', []);

Response::json(array $data)​

Encode le tableau en JSON et arrête immédiatement l'exécution (équivalent à wp_send_json()).

Response::json([
    'success' => true,
    'message' => 'Élément créé.',
]);

Messages flash​

Ajout de messages​

// Message personnalisé
$this->flashAdd('info', 'Action effectuée avec succès');

// Méthodes dédiées
$this->flashSuccess('Opération réussie !');
$this->flashError('Une erreur est survenue');
$this->flashWarning('Attention : action requise');
$this->flashInfo('Information importante');

Types de messages disponibles​

  • flashSuccess() → Clé 'success'
  • flashError() → Clé 'error'
  • flashWarning() → Clé 'warning'
  • flashInfo() → Clé 'info'