Diviner Tech Docs AphrontApplicationConfiguration

final class AphrontApplicationConfiguration
Phorge Technical Documentation (Aphront)

This class is not documented.

Tasks

URI Routing

private function buildController() — Build a controller to respond to the request.
private function routePath($maps, $path) — Map a specific path to the corresponding controller. For a description of routing, see @{method:buildController}.

Response Handling

private function isValidResponseObject($response) — Tests if a response is of a valid type.
private function validateControllerResponse($controller, $response) — Verifies that the return value from an @{class:AphrontController} is of an allowed type.
private function validateProducerResponse($producer, $response) — Verifies that the return value from an @{class:AphrontResponseProducerInterface} is of an allowed type.
private function validateErrorHandlerResponse($handler, $response) — Verifies that the return value from an @{class:AphrontRequestExceptionHandler} is of an allowed type.
private function produceResponse($request, $response) — Resolves a response object into an @{class:AphrontResponse}.

Exception Handling

private function handleThrowable($throwable) — Convert an exception which has escaped the controller into a response.

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
public function buildRequest()
public function buildRedirectController($uri, $external)
public function setRequest($request)
public function getRequest()
public function getConsole()
public function setConsole($console)
public function setHost($host)
public function getHost()
public function setPath($path)
public function getPath()
public static function runHTTPRequest($sink)
public function processRequest($request, $access_log, $sink, $multimeter)
private static function writeResponse($sink, $response)
private function buildSiteForRequest($request)
private static function newSelfCheckResponse()
private static function readHTTPPOSTData()

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function buildRequest()

This method is not documented.

Return

wild

public function buildRedirectController($uri, $external)

This method is not documented.

Parameters

	$uri
	$external

Return

wild

public function setRequest($request)

This method is not documented.

Parameters

AphrontRequest

$request

Return

wild

public function getRequest()

This method is not documented.

Return

wild

public function getConsole()

This method is not documented.

Return

wild

public function setConsole($console)

This method is not documented.

Parameters

$console

Return

wild

public function setHost($host)

This method is not documented.

Parameters

$host

Return

wild

public function getHost()

This method is not documented.

Return

wild

public function setPath($path)

This method is not documented.

Parameters

$path

Return

wild

public function getPath()

This method is not documented.

Return

wild

public static function runHTTPRequest($sink)

This method is not documented.

Parameters

AphrontHTTPSink

$sink

Return

wild

public function processRequest($request, $access_log, $sink, $multimeter)

This method is not documented.

Parameters

AphrontRequest	$request
PhutilDeferredLog	$access_log
AphrontHTTPSink	$sink
MultimeterControl	$multimeter

Return

wild

private static function writeResponse($sink, $response)

This method is not documented.

Parameters

AphrontHTTPSink	$sink
AphrontResponse	$response

Return

wild

private function buildController()

Build a controller to respond to the request.

Return

pair<AphrontController,dict>

Controller and dictionary of request parameters.

private function routePath($maps, $path)

Map a specific path to the corresponding controller. For a description of routing, see buildController().

Parameters

list<AphrontRoutingMap>	$maps	List of routing maps.
string	$path	Path to route.

Return

pair<AphrontController,dict>

Controller and dictionary of request parameters.

private function buildSiteForRequest($request)

This method is not documented.

Parameters

AphrontRequest

$request

Return

wild

private function isValidResponseObject($response)

Tests if a response is of a valid type.

Parameters

wild

$response

Supposedly valid response.

Return

bool	True if the object is of a valid type.

private function validateControllerResponse($controller, $response)

Verifies that the return value from an AphrontController is of an allowed type.

Parameters

AphrontController	$controller	Controller which returned the response.
wild	$response	Supposedly valid response.

Return

void

private function validateProducerResponse($producer, $response)

Verifies that the return value from an AphrontResponseProducerInterface is of an allowed type.

Parameters

AphrontResponseProducerInterface	$producer	Object which produced this response.
wild	$response	Supposedly valid response.

Return

void

private function validateErrorHandlerResponse($handler, $response)

Verifies that the return value from an AphrontRequestExceptionHandler is of an allowed type.

Parameters

AphrontRequestExceptionHandler	$handler	Object which produced this response.
wild	$response	Supposedly valid response.

Return

void

private function produceResponse($request, $response)

Resolves a response object into an AphrontResponse.

Controllers are permitted to return actual responses of class AphrontResponse, or other objects which implement AphrontResponseProducerInterface and can produce a response.

If a controller returns a response producer, invoke it now and produce the real response.

Parameters

AphrontRequest	$request	Request being handled.
AphrontResponse\|AphrontResponseProducerInterface	$response	Response, or response producer.

Return

AphrontResponse

Response after any required production.

private function handleThrowable($throwable)

Convert an exception which has escaped the controller into a response.

This method delegates exception handling to available subclasses of AphrontRequestExceptionHandler.

Parameters

Throwable

$throwable

Exception which needs to be handled.

Return

wild	Response or response producer, or null if no available handler can produce a response.

private static function newSelfCheckResponse()

This method is not documented.

Return

wild

private static function readHTTPPOSTData()

This method is not documented.

Return

wild

Defined: src/aphront/configuration/AphrontApplicationConfiguration.php:8
Extends: Phobject

final class AphrontApplicationConfigurationPhorge Technical Documentation (Aphront)

Tasks

URI Routing

Response Handling

Exception Handling

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function buildRequest()

public function buildRedirectController($uri, $external)

public function setRequest($request)

public function getRequest()

public function getConsole()

public function setConsole($console)

public function setHost($host)

public function getHost()

public function setPath($path)

public function getPath()

public static function runHTTPRequest($sink)

public function processRequest($request, $access_log, $sink, $multimeter)

private static function writeResponse($sink, $response)

private function buildController()

private function routePath($maps, $path)

private function buildSiteForRequest($request)

private function isValidResponseObject($response)

private function validateControllerResponse($controller, $response)

private function validateProducerResponse($producer, $response)

private function validateErrorHandlerResponse($handler, $response)

private function produceResponse($request, $response)

private function handleThrowable($throwable)

private static function newSelfCheckResponse()

private static function readHTTPPOSTData()

final class AphrontApplicationConfiguration
Phorge Technical Documentation (Aphront)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited