Support Contracts (Arrayable / Jsonable / Htmlable / Responsable)

​

Wat zijn Support Contracts?

​

1) Arrayable

​

Interface-definitie

interface Arrayable
{
    public function toArray();
}

​

Implementatievoorbeeld

use Illuminate\Contracts\Support\Arrayable;

final class Money implements Arrayable
{
    public function __construct(
        public readonly int $amount,
        public readonly string $currency,
    ) {}

    public function toArray(): array
    {
        return [
            'amount' => $this->amount,
            'currency' => $this->currency,
        ];
    }
}

​

Gebruiksvoorbeelden in de Laravel-core

• Illuminate\Database\Eloquent\Model implementeert Arrayable en biedt toArray()
• Als Illuminate\Http\JsonResponse::setData() een Arrayable detecteert, serialiseert die via json_encode($data->toArray(), ...)

​

Toepassing in packageontwikkeling

• Je kunt DTO’s en value objects in een gemeenschappelijk formaat gieten voor controllers, resources en logoutput
• Je kunt de verantwoordelijkheid voor conversie naar een array binnen het object zelf houden

​

2) Jsonable

​

Interface-definitie

interface Jsonable
{
    public function toJson($options = 0);
}

​

Implementatievoorbeeld

use Illuminate\Contracts\Support\Jsonable;

final class ApiPayload implements Jsonable
{
    public function __construct(
        private array $data,
    ) {}

    public function toJson($options = 0): string
    {
        return json_encode([
            'data' => $this->data,
            'generated_at' => now()->toIso8601String(),
        ], $options | JSON_THROW_ON_ERROR);
    }
}

​

Gebruiksvoorbeelden in de Laravel-core

• Model implementeert ook Jsonable en biedt toJson($options = 0)
• JsonResponse::setData() controleert eerst op Jsonable en gebruikt dan toJson()

​

Toepassing in packageontwikkeling

• Je kunt de JSON-structuur strikt vastleggen voor bijvoorbeeld auditlogs en webhook-verzendingen
• Je legt de JSON-representatie vanuit je domein expliciet vast, in plaats van die aan json_encode() over te laten

​

3) Htmlable

​

Interface-definitie

interface Htmlable
{
    public function toHtml();
}

​

Implementatievoorbeeld

use Illuminate\Contracts\Support\Htmlable;

final class BadgeHtml implements Htmlable
{
    public function __construct(
        private string $label,
    ) {}

    public function toHtml(): string
    {
        $escaped = e($this->label);

        return "<span class=\"badge\">{$escaped}</span>";
    }
}

​

Gebruiksvoorbeelden in de Laravel-core

• Illuminate\Support\HtmlString implementeert Htmlable
• De e()-helper geeft toHtml() terug als het argument een Htmlable is (zonder opnieuw te escapen)

​

Toepassing in packageontwikkeling

• Je maakt de verantwoordelijkheidsgrens duidelijk voor het veilig doorgeven van HTML-fragmenten binnen Blade
• Ook waar je {!! $obj !!} gebruikt, blijft de output makkelijk als object te beheren

​

4) Responsable

​

Interface-definitie

interface Responsable
{
    public function toResponse($request);
}

​

Implementatievoorbeeld

use Illuminate\Contracts\Support\Responsable;

final class ExportCsvResponse implements Responsable
{
    public function __construct(
        private array $rows,
        private string $filename = 'export.csv',
    ) {}

    /**
     * @param \Illuminate\Http\Request $request
     */
    public function toResponse($request)
    {
        return response()->streamDownload(function () {
            $stream = fopen('php://output', 'w');

            foreach ($this->rows as $row) {
                fputcsv($stream, $row);
            }

            fclose($stream);
        }, $this->filename, [
            'Content-Type' => 'text/csv',
        ]);
    }
}

​

Gebruiksvoorbeelden in de Laravel-core

• Illuminate\Routing\Router::toResponse() controleert eerst op Responsable en roept $response->toResponse($request) aan
• Illuminate\Http\Resources\Json\JsonResource implementeert Responsable, waardoor je vanuit een controller direct return UserResource::make($user); kunt doen

​

Toepassing in packageontwikkeling

• Je kunt het genereren van de response delegeren aan een object, zonder in de controller arrays samen te stellen
• Het maakt het ontwerp “een DTO direct returnen” makkelijk en scheidt de HTTP-representatie van de domeinrepresentatie

​

Gids voor het kiezen van een implementatie

​

Verder lezen