Nextended

English

Deutsch

English

Deutsch

Appearance

Nextended.Aspire.Hosting.Php ​

📚 Full API reference — every public type and member, generated from the compiled assembly.

Run PHP endpoints inside your Aspire stack — a docroot folder or a single router script served by PHP's built-in web server, with php.ini settings as fluent options. NuGet

🇩🇪 Diese Seite auf Deutsch

Installation ​

bash
dotnet add package Nextended.Aspire.Hosting.Php

Runnable sample ​

A complete AppHost you can start is checked into the repository:

Php.AppHost

bash
git clone https://github.com/fgilde/Nextended.git
cd Nextended/Tests/TestProjects/Php.AppHost
dotnet run

Run PHP endpoints inside your .NET Aspire stack — a folder or a single .php file, served by PHP's built-in web server in the official php:cli container — and call them from your .NET services like any other referenced resource.

Quick start ​

csharp
var builder = DistributedApplication.CreateBuilder(args);

// Folder mode: ./php is the docroot, every .php file inside becomes an endpoint.
var php = builder.AddPhp("php", "./php")
    .WithPhpIni("memory_limit", "256M")
    .WithPhpIni("display_errors", "1");

builder.AddProject<Projects.Api>("api")
    .WithReference(php); // service discovery: http://php resolves inside "api"

builder.Build().Run();

Calling it from .NET:

csharp
// with Microsoft.Extensions.ServiceDiscovery (standard Aspire service defaults):
var client = new HttpClient { BaseAddress = new Uri("http://php") };
var json = await client.GetStringAsync("/index.php?who=aspire");
await client.PostAsJsonAsync("/send-mail.php", new { to = "x@y.z", subject = "hi" });

Single file mode ​

Pass a .php file instead of a folder and it becomes the router script — every request, regardless of path, is handled by that one file:

csharp
builder.AddPhp("mailer", "./php/send-mail.php");

API ​

MethodWhat it does
AddPhp(name, path, port?, image?, tag?)Adds the container. path = folder (docroot) or .php file (router script); relative to the AppHost directory.
WithPhpIni(key, value)One php.ini directive, passed as php -d key=value.
WithPhpIni(dictionary)Several directives at once.
WithPhpIniConfiguration(a => ...)Typed directives: a.DisplayErrors = true, a.MemoryLimit = "256M", a.DateTimezone = "Europe/Berlin", … Subclass PhpIniConfiguration (+ [PhpIniKey("...")]) for anything missing.
WithPhpIniFile(path)Mounts a complete ini file into PHP's conf.d scan dir (overrides the base php.ini).
WithPhpExtensions("mysqli", ...)Installs PHP extensions at container start (docker-php-ext-install). Good for mysqli, pdo_mysql, bcmath, … — heavier ones (gd, intl) need a custom image.
WithComposer(image?, tag?)Runs composer install (official composer image, same mount) before PHP starts — vendor/ lands on the host. Folder mode only.
WithWorkers(n)Parallel request workers of the built-in server (PHP_CLI_SERVER_WORKERS, default 8).

Notes ​

  • Concurrency: the built-in server runs 8 request workers by default; tune with WithWorkers(n).
  • Dev server: PHP's built-in server is a development server — a fine match for Aspire's local orchestration. For production deploys use a proper PHP image (fpm + nginx / apache).
  • Extensions: the stock php:cli image ships without extras like mysqli/pdo_mysql — use WithPhpExtensions(...) (compiled at container start, ~20–40s) or bake a custom image and pass it via AddPhp(..., image: "my/php", tag: "dev").
  • MySQL: combine with Aspire.Hosting.MySql — AddMySql("mysql").WithPhpMyAdmin() gives you the server plus phpMyAdmin; hand PHP the endpoint via .WithEnvironment("MYSQL_URL", mysql.GetEndpoint("tcp")) and add WithPhpExtensions("mysqli").
  • mail(): the container has no MTA, so PHP's mail() silently no-ops. Speak SMTP instead — e.g. add a Mailpit container to the stack and hand its endpoint to PHP (.WithEnvironment("SMTP_URL", mailpit.GetEndpoint("smtp"))). The Php.AppHost test project in this repo shows the full pattern including a dependency-free PHP SMTP sender.

Supported frameworks ​

  • net8.0
  • net9.0
  • net10.0

Dependencies ​

  • Aspire.Hosting.AppHost