API Documentation

Feed/Pubsubhubbub/HttpResponse.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Pubsubhubbub
Classes
Zend_Feed_Pubsubhubbub_HttpResponse

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Feed_Pubsubhubbub_HttpResponse

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Pubsubhubbub
Properties
$_body
$_headers
$_httpResponseCode
Methods
sendResponse
sendHeaders
setHeader
getHeader
getHeaders
canSendHeaders
setHttpResponseCode
getHttpResponseCode
setBody
getBody
_normalizeHeader

Description

Properties

$_body

string $_body = ''

The body of any response to the current callback request

Details

$_body
string
visibility
protected
default
final
false
static
false

$_headers

array $_headers = 'array'

Array of headers. Each header is an array with keys 'name' and 'value'

Details

$_headers
array
visibility
protected
default
array
final
false
static
false

$_httpResponseCode

int $_httpResponseCode = '200'

HTTP response code to use in headers

Details

$_httpResponseCode
int
visibility
protected
default
200
final
false
static
false

Methods

_normalizeHeader

_normalizeHeader( string $name ) : string

Normalizes a header name to X-Capitalized-Names

Arguments
$name
string
Output
string
Details
visibility
protected
final
false
static
false

canSendHeaders

canSendHeaders( boolean $throw = false ) : boolean

Can we send headers?

Arguments
$throw
boolean
Whether or not to throw an exception if headers have been sent; defaults to false
Output
boolean
Details
visibility
public
final
false
static
false
throws

getBody

getBody( ) : string

Return the body content

Output
string
Details
visibility
public
final
false
static
false

getHeader

getHeader( string $name ) : string|null

Check if a specific Header is set and return its value

Arguments
$name
string
Output
string|null
Details
visibility
public
final
false
static
false

getHeaders

getHeaders( ) : array

Return array of headers; see {@link $_headers} for format

Output
array
Details
visibility
public
final
false
static
false

getHttpResponseCode

getHttpResponseCode( ) : int

Retrieve HTTP response code

Output
int
Details
visibility
public
final
false
static
false

sendHeaders

sendHeaders( ) : void

Send all headers

Sends any headers specified. If an {@link setHttpResponseCode() HTTP response code} has been specified, it is sent with the first header.

Details
visibility
public
final
false
static
false

sendResponse

sendResponse( ) : void

Send the response, including all headers

Details
visibility
public
final
false
static
false

setBody

setBody( string $content ) : Zend_Feed_Pubsubhubbub_HttpResponse

Set body content

Arguments
$content
string
Details
visibility
public
final
false
static
false

setHeader

setHeader( string $name, string $value, boolean $replace = false ) : Zend_Feed_Pubsubhubbub_HttpResponse

Set a header

If $replace is true, replaces any headers already defined with that $name.

Arguments
$name
string
$value
string
$replace
boolean
Details
visibility
public
final
false
static
false

setHttpResponseCode

setHttpResponseCode( int $code ) : Zend_Feed_Pubsubhubbub_HttpResponse

Set HTTP response code to use with headers

Arguments
$code
int
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.