Nextended.Aspire.Hosting.Php — API reference

🇩🇪 Diese Seite auf Deutsch

The complete public surface of Nextended.Aspire.Hosting.Php, generated from the compiled assembly.

Generated

This page is generated by tools/ApiRef from the compiled assembly — it includes members with no XML comment and therefore cannot drift from the code. Do not edit by hand.

↩ Back to the package page

Nextended.Aspire.Hosting.Php

PhpBuilderExtensions

static class

Fluent API for running PHP endpoints inside your Aspire stack. Start with AddPhp, then optionally tune php.ini via WithPhpIni or WithPhpIniFile.

PhpIniConfiguration

class

Typed php.ini settings for WithPhpIniConfiguration. Only assigned (non-null) properties are applied. Property names map to directives by convention (DisplayErrors → display_errors); PhpIniKeyAttribute overrides where the convention doesn't fit. Booleans become 1/0. The mapping is purely reflective — subclass this and add your own properties for any directive not listed here.

Constructors

• PhpIniConfiguration()

Properties

• DateTimezone : string { get; set; }
date.timezone — e.g. "Europe/Berlin".
• DefaultCharset : string { get; set; }
default_charset — e.g. "UTF-8".
• DisplayErrors : bool? { get; set; }
display_errors — print errors as part of the output (dev setting).
• DisplayStartupErrors : bool? { get; set; }
display_startup_errors — also show errors from PHP's startup sequence.
• ErrorReporting : string { get; set; }
error_reporting — passed verbatim (e.g. "E_ALL" or a numeric value like "32767").
• FileUploads : bool? { get; set; }
file_uploads — allow HTTP file uploads at all.
• LogErrors : bool? { get; set; }
log_errors — log errors to the server log (visible in the Aspire console).
• MaxExecutionTime : int? { get; set; }
max_execution_time — script timeout in seconds.
• MaxFileUploads : int? { get; set; }
max_file_uploads — maximum simultaneous file uploads.
• MaxInputTime : int? { get; set; }
max_input_time — input parsing timeout in seconds.
• MaxInputVars : int? { get; set; }
max_input_vars — maximum number of accepted input variables.
• MemoryLimit : string { get; set; }
memory_limit — e.g. "256M".
• PostMaxSize : string { get; set; }
post_max_size — e.g. "64M".
• SessionSavePath : string { get; set; }
session.save_path — where session files are stored inside the container.
• ShortOpenTag : bool? { get; set; }
short_open_tag — allow <? as PHP open tag.
• UploadMaxFilesize : string { get; set; }
upload_max_filesize — e.g. "32M".

PhpIniKeyAttribute

class

Names the php.ini directive a PhpIniConfiguration property maps to, for directives the PascalCase→snake_case convention can't produce (e.g. date.timezone).

Constructors

• PhpIniKeyAttribute(string key)
  Names the php.ini directive a PhpIniConfiguration property maps to, for directives the PascalCase→snake_case convention can't produce (e.g. date.timezone).

Properties

• Key : string { get; }
  The php.ini directive name.

PhpResource

class

A PHP app served by PHP's built-in web server (php -S) inside the official php:cli container. The source is a bind-mounted host folder (docroot) or a single .php file (router script — every request is handed to it). Exposes one HTTP endpoint and supports service discovery, so .NET services can call the PHP endpoints via WithReference.

Constructors

• PhpResource(string name)
  A PHP app served by PHP's built-in web server (php -S) inside the official php:cli container. The source is a bind-mounted host folder (docroot) or a single .php file (router script — every request is handed to it). Exposes one HTTP endpoint and supports service discovery, so .NET services can call the PHP endpoints via WithReference.

Properties

• Extensions : IList<string> { get; }
  PHP extensions installed at container start (see WithPhpExtensions).
• IniSettings : IDictionary<string, string> { get; }
  php.ini directives applied as -d key=value (see WithPhpIni).
• RouterScript : string { get; }
  File name of the router script when a single .php file was added; null in folder (docroot) mode.
• SourcePath : string { get; }
  Resolved host path (folder or file) that is mounted into the container.

Fields

• AppDirectory : string
  Mount point of the app source inside the container.
• DefaultImage : string
  Container image: the official PHP image.
• DefaultTag : string
  Default image tag (CLI variant — ships the built-in web server).
• DefaultTargetPort : int
  Port the built-in server listens on inside the container.
• HttpEndpointName : string
  Name of the HTTP endpoint.

Projects

Nextended_Aspire_Hosting_Php

class

Metadata for the Aspire AppHost project.

Properties

• ProjectPath : string { get; }
  The path to the Aspire Host project.

↩ Back to the package page