Leitfaden

Controller & Responses

Was `AbstractController` bietet und wann sich eine gemeinsame Anwendungsschicht lohnt.

Framework-Basis: AbstractController

Das Framework stellt AbstractController mit Helpern für Request, Response und Dienste bereit, darunter view(), url(), validator(), flash(), filesystem(), upload(), translator() und breadcrumb().

example.php
<?php

declare(strict_types=1);

namespace App\Controllers;

use Lemonade\Framework\Core\AbstractController;
use Psr\Http\Message\ResponseInterface;

final class ArticleController extends AbstractController
{
    public function detail(int $id): ResponseInterface
    {
        return $this->json([
            'id' => $id,
            'expects_json' => $this->expectsJson(),
        ]);
    }
}

Gemeinsamer Anwendungscontroller

Die Anwendung kann optional AppController extends AbstractController ergänzen. Das eignet sich für gemeinsames Rendering, geteilte Daten, Metadaten, Breadcrumbs oder kleine Helper. Es ist keine Vorgabe des Frameworks.

example.php
<?php

declare(strict_types=1);

namespace App\Controllers;

use Lemonade\Framework\Core\AbstractController;
use Psr\Http\Message\ResponseInterface;

abstract class AppController extends AbstractController
{
    /**
     * @param array<string, mixed> $data
     */
    protected function page(string $view, array $data = [], int $status = 200): ResponseInterface
    {
        return $this->html(
            $this->view()->template(
                'layouts.app',
                $view,
                $data,
            ),
            $status,
        );
    }
}

Weitere Schichten in größeren Anwendungen

In größeren Anwendungen kannst du über AppController zusätzliche Schichten für die öffentliche Website, Administration, Locale-Verarbeitung oder Canonical-Redirects einführen. Das ist eine Architekturentscheidung der Anwendung und keine vorgeschriebene Framework-Hierarchie.

example.php
AbstractController
    ↓
Optional application base controller
    ↓
Optional specialized controller
    ↓
Concrete controller

Auch reine PSR-Controller sind möglich

Ein Controller muss nicht von AbstractController erben, wenn du PSR-Responses lieber direkt mit ResponseFactoryInterface und StreamFactoryInterface zusammensetzt.

example.php
<?php

declare(strict_types=1);

namespace App\Controllers;

use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamFactoryInterface;

final class StatusController
{
    public function __construct(
        private readonly ResponseFactoryInterface $responses,
        private readonly StreamFactoryInterface $streams,
    ) {}

    public function index(): ResponseInterface
    {
        return $this->responses
            ->createResponse(200)
            ->withHeader('Content-Type', 'text/html; charset=UTF-8')
            ->withBody($this->streams->createStream('<h1>Status OK</h1>'));
    }
}