Pneuma Framework

Cgi extends AbstractFactory
in package
implements CgiInterface

Simple CGI implementation.

Table of Contents

Interfaces

CgiInterface
Describes CGI interface.

Properties

$baseApp  : string
$baseResource  : string
$baseView  : string
$environment  : string
$splAutoload  : array<string, string>
$baseCgi  : string
$baseRoute  : string
$errorHandler  : callable
$middlewares  : array<string|int, MiddlewareInterface>
$uri  : UriInterface

Methods

__construct()  : mixed
addMiddleware()  : static
Return an instance with added middleware scenarios.
run()  : void
Run application.
withBaseApp()  : static
Return an instance with provided base application path.
withBaseCgi()  : static
Return an instance with provided base cgi path.
withBaseResource()  : static
Return an instance with provided base resource path.
withBaseRoute()  : static
Return an instance with provided base route path.
withBaseUrl()  : static
Return an instance with provided base url.
withBaseView()  : static
Return an instance with provided base view path.
withEnvironment()  : static
Return an instance with provided environment filename.
withErrorHandler()  : static
Return an instance with provided error handler.
withSplAutoload()  : static
Return an instance with provided SPL Autoload.
applyResponse()  : static
errorHandlerFactory()  : callable
getDispatcher()  : Dispatcher
getRouteResponse()  : ResponseInterface

Properties

$baseCgi

private string $baseCgi = ''

$baseRoute

private string $baseRoute = ''

$errorHandler

private callable $errorHandler = null

$middlewares

private array<string|int, MiddlewareInterface> $middlewares = []

$uri

private UriInterface $uri = null

Methods

__construct()

public __construct([array<string, mixed> $config = [] ]) : mixed
Parameters
$config : array<string, mixed> = []

The configuration.

addMiddleware()

Return an instance with added middleware scenarios.

public addMiddleware(mixed $middleware) : static
Parameters
$middleware : mixed

The middleware scenarios.

Tags
throws
PneumaException

If invalid.

Return values
static

run()

Run application.

public abstract run([array<string, mixed> $config = [] ]) : void
Parameters
$config : array<string, mixed> = []

The configuration.

Tags
throws
PneumaException

If error.

withBaseApp()

Return an instance with provided base application path.

public withBaseApp(string $path) : static
Parameters
$path : string

The application path.

Tags
throws
PneumaException

If invalid.

Return values
static

withBaseCgi()

Return an instance with provided base cgi path.

public withBaseCgi(string $path) : static
Parameters
$path : string

The base path.

Tags
throws
PneumaException

If invalid.

Return values
static

withBaseResource()

Return an instance with provided base resource path.

public withBaseResource(string $path) : static
Parameters
$path : string

The base path.

Tags
throws
PneumaException

If invalid.

Return values
static

withBaseRoute()

Return an instance with provided base route path.

public withBaseRoute(string $path) : static
Parameters
$path : string

The base path.

Tags
throws
PneumaException

If invalid.

Return values
static

withBaseUrl()

Return an instance with provided base url.

public withBaseUrl(string $url) : static
Parameters
$url : string

The base url.

Tags
throws
PneumaException

If invalid.

Return values
static

withBaseView()

Return an instance with provided base view path.

public withBaseView(string $path) : static
Parameters
$path : string

The base path.

Tags
throws
PneumaException

If invalid.

Return values
static

withEnvironment()

Return an instance with provided environment filename.

public withEnvironment(string $filename) : static
Parameters
$filename : string

The environment filename.

Tags
throws
PneumaException

If invalid.

Return values
static

withErrorHandler()

Return an instance with provided error handler.

public withErrorHandler(callable $errorHandler) : static
Parameters
$errorHandler : callable

The error handler.

Return values
static

withSplAutoload()

Return an instance with provided SPL Autoload.

public withSplAutoload(string $namespace, string $path) : static
Parameters
$namespace : string

The namespace.

$path : string

The path.

Tags
throws
PneumaException

If invalid.

Return values
static

errorHandlerFactory()

private errorHandlerFactory() : callable
Return values
callable

getDispatcher()

private getDispatcher() : Dispatcher
Return values
Dispatcher

getRouteResponse()

private getRouteResponse(array<string|int, mixed> $routeInfo, string $requestMethod, string $requestUri) : ResponseInterface
Parameters
$routeInfo : array<string|int, mixed>
$requestMethod : string
$requestUri : string
Return values
ResponseInterface

        
On this page

Search results