AjaxResponse Class Reference

Handle responses for Ajax requests (send headers, print content, that sort of thing) More...

Collaboration diagram for AjaxResponse:

Public Member Functions
	__construct ( $text=null, Config $config=null)
	addText ( $text)
	Add content to the response. More...
	checkLastModified ( $timestamp)
	checkLastModified tells the client to use the client-cached response if possible. More...
	disable ()
	Disable output. More...
	loadFromMemcached ( $mckey, $touched)
	printText ()
	Output text. More...
	sendHeaders ()
	Construct the header and output it. More...
	setCacheDuration ( $duration)
	Set the number of seconds to get the response cached by a proxy. More...
	setContentType ( $type)
	Set the HTTP header Content-Type. More...
	setResponseCode ( $code)
	Set the HTTP response code. More...
	setVary ( $vary)
	Set the HTTP Vary header. More...
	storeInMemcached ( $mckey, $expiry=86400)

Private Attributes
	$mCacheDuration
	Number of seconds to get the response cached by a proxy. More...
Config	$mConfig
	$mContentType
	HTTP header Content-Type. More...
	$mDisabled
	Disables output. More...
	$mLastModified
	Date for the HTTP header Last-modified. More...
	$mResponseCode
	HTTP response code. More...
	$mText
	Content of our HTTP response. More...
	$mVary
	HTTP Vary header. More...

Detailed Description

Handle responses for Ajax requests (send headers, print content, that sort of thing)

Definition at line 31 of file AjaxResponse.php.

Constructor & Destructor Documentation

__construct()

AjaxResponse::__construct	(		$text = null,
		Config	$config = null
	)

Parameters

string | null	$text
Config | null	$config

Definition at line 83 of file AjaxResponse.php.

References addText().

Member Function Documentation

addText()

AjaxResponse::addText

(

$text

)

Add content to the response.

Parameters

string

$text

Definition at line 142 of file AjaxResponse.php.

Referenced by __construct().

checkLastModified()

AjaxResponse::checkLastModified

(

$timestamp

)

checkLastModified tells the client to use the client-cached response if possible.

If successful, the AjaxResponse is disabled so that any future call to AjaxResponse::printText() have no effect.

Parameters

string

$timestamp

Returns

bool Returns true if the response code was set to 304 Not Modified.

Definition at line 222 of file AjaxResponse.php.

References $fname, $wgCacheEpoch, $wgCachePages, disable(), setResponseCode(), wfDebug(), and wfTimestamp().

disable()

AjaxResponse::disable

(

)

Disable output.

Definition at line 134 of file AjaxResponse.php.

Referenced by checkLastModified().

loadFromMemcached()

AjaxResponse::loadFromMemcached	(		$mckey,
			$touched
	)

Parameters

string	$mckey
int	$touched

Returns

bool

Definition at line 279 of file AjaxResponse.php.

References ObjectCache\getMainWANInstance(), and wfDebug().

printText()

AjaxResponse::printText

(

)

Output text.

Definition at line 151 of file AjaxResponse.php.

References $mText.

sendHeaders()

AjaxResponse::sendHeaders

(

)

Construct the header and output it.

Definition at line 160 of file AjaxResponse.php.

References HttpStatus\header().

setCacheDuration()

AjaxResponse::setCacheDuration

(

$duration

)

Set the number of seconds to get the response cached by a proxy.

Parameters

int

$duration

Definition at line 103 of file AjaxResponse.php.

setContentType()

AjaxResponse::setContentType

(

$type

)

Set the HTTP header Content-Type.

Parameters

string

$type

Definition at line 127 of file AjaxResponse.php.

References $type.

setResponseCode()

AjaxResponse::setResponseCode

(

$code

)

Set the HTTP response code.

Parameters

string

$code

Definition at line 119 of file AjaxResponse.php.

References $code.

Referenced by checkLastModified().

setVary()

AjaxResponse::setVary

(

$vary

)

Set the HTTP Vary header.

Parameters

string

$vary

Definition at line 111 of file AjaxResponse.php.

storeInMemcached()

AjaxResponse::storeInMemcached	(		$mckey,
			$expiry = 86400
	)

Parameters

string	$mckey
int	$expiry

Returns

bool

Definition at line 305 of file AjaxResponse.php.

References ObjectCache\getMainWANInstance(), and wfTimestampNow().

Member Data Documentation

$mCacheDuration

int AjaxResponse::$mCacheDuration

private

Number of seconds to get the response cached by a proxy.

Definition at line 36 of file AjaxResponse.php.

$mConfig

Config AjaxResponse::$mConfig

private

Definition at line 77 of file AjaxResponse.php.

$mContentType

string AjaxResponse::$mContentType

private

HTTP header Content-Type.

Definition at line 42 of file AjaxResponse.php.

$mDisabled

bool AjaxResponse::$mDisabled

private

Disables output.

Can be set by calling $AjaxResponse->disable()

Definition at line 48 of file AjaxResponse.php.

$mLastModified

string bool AjaxResponse::$mLastModified

private

Date for the HTTP header Last-modified.

Definition at line 54 of file AjaxResponse.php.

$mResponseCode

string AjaxResponse::$mResponseCode

private

HTTP response code.

Definition at line 60 of file AjaxResponse.php.

$mText

string AjaxResponse::$mText

private

Content of our HTTP response.

Definition at line 72 of file AjaxResponse.php.

Referenced by printText().

$mVary

string AjaxResponse::$mVary

private

HTTP Vary header.

Definition at line 66 of file AjaxResponse.php.

---

The documentation for this class was generated from the following file:

• includes/AjaxResponse.php