Page MenuHomeClusterLabs Projects
Diviner Tech Docs AphrontHTTPSink

abstract class AphrontHTTPSink
Phorge Technical Documentation (Aphront)

Abstract class which wraps some sort of output mechanism for HTTP responses. Normally this is just AphrontPHPHTTPSink, which uses "echo" and "header()" to emit responses.

Tasks

Writing Response Components

No methods for this task.

Emitting the Response

No methods for this task.

Other Methods

  • final public function setShowStackTraces($show_stack_traces)
  • final public function getShowStackTraces()
  • final public function writeHTTPStatus($code, $message) — Write an HTTP status code to the output.
  • final public function writeHeaders($headers) — Write HTTP headers to the output.
  • final public function writeData($data) — Write HTTP body data to the output.
  • final public function writeResponse($response) — Write an entire @{class:AphrontResponse} to the output.
  • abstract protected function emitHTTPStatus($code, $message)
  • abstract protected function emitHeader($name, $value)
  • abstract protected function emitData($data)
  • abstract protected function isWritable()

Methods

final public function setShowStackTraces($show_stack_traces)

This method is not documented.
Parameters
$show_stack_traces
Return
wild

final public function getShowStackTraces()

This method is not documented.
Return
wild

final public function writeHTTPStatus($code, $message)

Write an HTTP status code to the output.

Parameters
int$codeNumeric HTTP status code.
$message
Return
void

final public function writeHeaders($headers)

Write HTTP headers to the output.

Parameters
list<pair>$headersList of <name, value> pairs.
Return
void

final public function writeData($data)

Write HTTP body data to the output.

Parameters
string$dataBody data.
Return
void

final public function writeResponse($response)

Write an entire AphrontResponse to the output.

Parameters
AphrontResponse$responseThe response object to write.
Return
void

abstract protected function emitHTTPStatus($code, $message)

This method is not documented.
Parameters
$code
$message
Return
wild

abstract protected function emitHeader($name, $value)

This method is not documented.
Parameters
$name
$value
Return
wild

abstract protected function emitData($data)

This method is not documented.
Parameters
$data
Return
wild

abstract protected function isWritable()

This method is not documented.
Return
wild
Defined
src/aphront/sink/AphrontHTTPSink.php:11