model/modx/modresponse.class.php

Classes 
package
modx
Classes
modResponse

Description

Encapsulates a MODX response to a web request.

Includes functions to manipluate header data, such as status codes, as well as manipulating the response body.

\modResponse

package
modx
Properties
$body
$header
$modx
Methods
__construct
checkPreview
outputContent
sendRedirect

Description

Encapsulates a MODX response to a web request.

Includes functions to manipluate header data, such as status codes, as well as manipulating the response body.

Properties

$body

 $body = 'null'

Details

visibility
public
default
null
final
false
static
false

$header

 $header = 'null'

Details

visibility
public
default
null
final
false
static
false

$modx

 $modx = 'null'

Details

visibility
public
default
null
final
false
static
false

Methods

__construct

__construct(  $modx ) :
Arguments
$modx
Details
visibility
public
final
false
static
false

checkPreview

checkPreview( ) : boolean

Checks to see if the preview parameter is set.

Output
boolean
Details
visibility
public
final
false
static
false

outputContent

outputContent( array $options = array ) :

Prepare the final response after the resource has been processed.

Arguments
$options
array
Various options that can be set.
Details
visibility
public
final
false
static
false

sendRedirect

sendRedirect( string $url, array|boolean $options = false, string $type, string $responseCode ) :

Sends a redirect to the specified URL using the specified method.

Valid $type values include: REDIRECT_REFRESH Uses the header refresh method REDIRECT_META Sends a a META HTTP-EQUIV="Refresh" tag to the output REDIRECT_HEADER Uses the header location method

REDIRECT_HEADER is the default.

Arguments
$url
string
The URL to redirect the client browser to.
$options
arrayboolean
An array of options for the redirect OR indicates if redirect attempts should be counted and limited to 3 (latter is deprecated usage; use count_attempts in options array).
$type
string
The type of redirection to attempt (deprecated, use type in options array).
$responseCode
string
The type of HTTP response code HEADER to send for the redirect (deprecated, use responseCode in options array)
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox 0.11.2.