Class ResponseUtil

Standalone environmentally-agnostic content/message feedback utility.

In the scope of a web request, it will respond via JSON (i.e. for use in an API or AJAX response action). When run in a command line interface, it will echo messages without exiting.

Setting elements of an object of this class (using the ArrayAccess implementation) will control the properties of the JSON that is returned when using it in a web request.

ResponseUtil implements ArrayAccess

Author: Demitri Morgan <demitri@x2engine.com>
Located at x2engine/protected/components/util/ResponseUtil.php

Methods summary
`public static`	# `end( )` Performs the shutdown code. Performs the shutdown code.
`public static`	# `getObject( )` Returns the current response singleton object. Returns the current response singleton object.
`public static array`	# `getStatusMessages( )` Returns the static array of status messages, i.e. for reference Returns the static array of status messages, i.e. for reference Returns `array`
`public static boolean`	# `isCli( )` Returns true or false based on whether or not the current thread of PHP is being run from the command line. Returns true or false based on whether or not the current thread of PHP is being run from the command line. Returns `boolean`
`public static`	# `respond( type $message, boolean $error = false, boolean $fatal = false )` Universal, web-agnostic response function. Universal, web-agnostic response function. Responds with a JSON and closes the connection if used in a web request; merely echoes the response message (but optionally exits) otherwise. Parameters `$message` `type` $message The message to respond with. `$error` `boolean` $error Indicates that an error has occurred `$fatal` `boolean` $fatal Shut down PHP thread after printing the message
`public static`	# `respondWithError( type $no, type $st, type $fi = Null, type $ln = Null )` Error handler method that uses the web-agnostic response method. Error handler method that uses the web-agnostic response method. This is disabled by default; fatal errors should ordinarily be caught by `ResponseUtil::respondFatalErrorMessage()`. This can be enabled for debugging purposes via setting `ResponseUtil::$exitNonFatal` to true. Parameters `$no` `type` $no `$st` `type` $st `$fi` `type` $fi `$ln` `type` $ln
`public static`	# `respondFatalErrorMessage( )` Shutdown function for handling fatal errors not caught by `ResponseUtil::respondWithError()`. Shutdown function for handling fatal errors not caught by `ResponseUtil::respondWithError()`.
`public static`	# `respondWithException( Exception $e )` Parameters `$e` `Exception` $e The uncaught exception
`public static string`	# `statusMessage( integer $code )` Obtain an appropriate message for a given HTTP status code. Obtain an appropriate message for a given HTTP status code. Parameters `$code` `integer` $status Returns `string`
`public`	# `__construct( )` Constructor. If one tries to instantiate two `ResponseUtil` objects, an exception will be thrown. The idea is that there should only ever be one response happening at a time. Constructor. If one tries to instantiate two `ResponseUtil` objects, an exception will be thrown. The idea is that there should only ever be one response happening at a time.
`public type`	# `offsetExists( type $offset )` Array interface method from ArrayAccess Array interface method from ArrayAccess Parameters `$offset` `type` $offset Returns `type` Implementation of `ArrayAccess::offsetExists()`
`public type`	# `offsetGet( type $offset )` Array interface method from ArrayAccess Array interface method from ArrayAccess Parameters `$offset` `type` $offset Returns `type` Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( type $offset, type $value )` Array interface method from ArrayAccess Array interface method from ArrayAccess Parameters `$offset` `type` $offset `$value` `type` $value Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( type $offset )` Array interface method from ArrayAccess Array interface method from ArrayAccess Parameters `$offset` `type` $offset Implementation of `ArrayAccess::offsetUnset()`
`public`	# `sendHttp( integer $status = null, type $message = '', type $error = null )` Sends a HTTP response back to the client. Sends a HTTP response back to the client. Parameters `$status` `integer` $status The status code to use `$message` `type` $message `$error` `type` $error Throws `Exception`
`protected`	# `sendHttpHeader( boolean $replace = true )` Sends HTTP headers. This method should be called before any content is sent. Sends HTTP headers. This method should be called before any content is sent. Parameters `$replace` `boolean` $replace The argument sent to header as the replacement flag.
`public`	# `setProperties( array $properties )` Sets _properties Sets _properties Parameters `$properties` `array` $properties

Properties summary
`public static boolean`	`$exitNonFatal`	`false`	# Exit on non-fatal PHP errors. Exit on non-fatal PHP errors. If set to true, the error handler `ResponseUtil::respondWithError()` will force a premature response for any PHP error, even if it's not of type E_ERROR.
`public static integer`	`$errorCode`	`500`	# The default HTTP status code to use when handling an internal error. The default HTTP status code to use when handling an internal error. This can be set to 200 when dealing with client-side code that cannot retrieve response data if the response code is not 200. This would thus allow user-friendly error reporting.
`public static boolean`	`$includeExtraneousOutput`	`false`	# Whether to include or ignore any unintentional output Whether to include or ignore any unintentional output If false, any extra output generated within the scope of the response (i.e. error messages) will be excluded from the response altogether.
`public static string\|array\|closure`	`$shutdown`	`'die();'`	# Shutdown method. Shutdown method. Can be set to, for instance, "Yii::app()->end();" for a graceful Yii shutdown that saves/rotates logs and performs other useful/appropriate operations before terminating the PHP thread.
`public static type`	`$longErrorTrace`	`false`	# Produce extended error traces in responses triggered by error handlers. Produce extended error traces in responses triggered by error handlers.
`public string`	`$body`		# Override body. Override body. If left unset, the content type header will be set to JSON, and the response body will be _properties, encoded in JSON. Otherwise, any content type can be used, andthis property will be returned instead.
`public array`	`$httpHeader`	`array( 'Content-Type' => 'application/json' )`	# HTTP header fields. HTTP header fields. The default of the "Content-type" field is JSON for ease of use, since it's expected that this class will be used mostly to compose responses in JSON format.

Packages

Classes

Interfaces

Exceptions

Functions

Class ResponseUtil

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Throws

Parameters

Parameters