class PingController (View source)

Unauthenticated liveness probe. Answers if the process can serve a request and checks nothing else, so it still reports ok while the database is down.

Disabled by default.

Deliberately does not extend BaseController, whose constructor connects to the database unconditionally - that would make this fail exactly when a liveness probe is most useful. Use /api/health for dependency status.

Methods

__construct(BootContext $context)

No description

config()

Overridable so tests can substitute settings without a boot context.

void
run()

No description

Response
buildResponse()

No description

Details

__construct(BootContext $context)

No description

Parameters

BootContext $context

The booted context; the router passes it to every controller outside BaseController

protected ConfigurationInterface config()

Overridable so tests can substitute settings without a boot context.

Return Value

ConfigurationInterface

void run()

No description

Return Value

void

Response buildResponse()

No description

Return Value

Response