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 30 of file AjaxResponse.php.

Constructor & Destructor Documentation

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

Parameters

string \| null	$text
Config \| null	$config

Definition at line 82 of file AjaxResponse.php.

References addText(), and ConfigFactory\getDefaultInstance().

Member Function Documentation

AjaxResponse::addText ( $text )

Add content to the response.

Parameters

string $text

Definition at line 141 of file AjaxResponse.php.

Referenced by __construct().

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 221 of file AjaxResponse.php.

References $fname, $timestamp, $wgCacheEpoch, $wgCachePages, $wgUser, disable(), global, setResponseCode(), TS_MW, TS_RFC2822, wfDebug(), and wfTimestamp().

AjaxResponse::disable ( )

Disable output.

Definition at line 133 of file AjaxResponse.php.

Referenced by checkLastModified().

AjaxResponse::loadFromMemcached	(	$mckey,
		$touched
	)

Parameters

string	$mckey
int	$touched

Returns: bool

Definition at line 278 of file AjaxResponse.php.

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

AjaxResponse::printText ( )

Output text.

Definition at line 150 of file AjaxResponse.php.

References $mText, and print.

AjaxResponse::sendHeaders ( )

Construct the header and output it.

Definition at line 159 of file AjaxResponse.php.

References HttpStatus\header().

AjaxResponse::setCacheDuration ( $duration )

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

Parameters

int $duration

Definition at line 102 of file AjaxResponse.php.

AjaxResponse::setContentType ( $type )

Set the HTTP header Content-Type.

Parameters

string $type

Definition at line 126 of file AjaxResponse.php.

References $type.

AjaxResponse::setResponseCode ( $code )

Set the HTTP response code.

Parameters

string $code

Definition at line 118 of file AjaxResponse.php.

References $code.

Referenced by checkLastModified().

AjaxResponse::setVary ( $vary )

Set the HTTP Vary header.

Parameters

string $vary

Definition at line 110 of file AjaxResponse.php.

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

Parameters

string	$mckey
int	$expiry

Returns: bool

Definition at line 304 of file AjaxResponse.php.

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

Member Data Documentation

int AjaxResponse::$mCacheDuration

private

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

Definition at line 35 of file AjaxResponse.php.

Config AjaxResponse::$mConfig

private

Definition at line 76 of file AjaxResponse.php.

string AjaxResponse::$mContentType

private

HTTP header Content-Type.

Definition at line 41 of file AjaxResponse.php.

bool AjaxResponse::$mDisabled

private

Disables output.

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

Definition at line 47 of file AjaxResponse.php.

string bool AjaxResponse::$mLastModified

private

Date for the HTTP header Last-modified.

Definition at line 53 of file AjaxResponse.php.

string AjaxResponse::$mResponseCode

private

HTTP response code.

Definition at line 59 of file AjaxResponse.php.

string AjaxResponse::$mText

private

Content of our HTTP response.

Definition at line 71 of file AjaxResponse.php.

Referenced by printText().

string AjaxResponse::$mVary

private

HTTP Vary header.

Definition at line 65 of file AjaxResponse.php.

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

includes/AjaxResponse.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation