Class: HTTP_OAuth_Provider_Response

Source Location: /HTTP_OAuth-0.1.6/HTTP/OAuth/Provider/Response.php

Class Overview

HTTP_OAuth
   |
   --HTTP_OAuth_Message
      |
      --HTTP_OAuth_Provider_Response

HTTP_OAuth_Provider_Response

Author(s):

Jeff Hodsdon <jeffhodsdon at gmail.com>

Copyright:

2009 Jeff Hodsdon <jeffhodsdon@gmail.com>

Variables

Methods

Inherited Variables

Class: HTTP_OAuth_Message

HTTP_OAuth_Message::$oauthParams
HTTP_OAuth_Message::$parameters

Class: HTTP_OAuth

HTTP_OAuth::$logs

Inherited Methods

Class: HTTP_OAuth_Message

HTTP_OAuth_Message::count(): Count
HTTP_OAuth_Message::getIterator(): Get iterator
HTTP_OAuth_Message::getOAuthParameters(): Get OAuth specific parameters
HTTP_OAuth_Message::getParameters(): Get parameters
HTTP_OAuth_Message::getSignatureMethod(): Get signature method
HTTP_OAuth_Message::offsetExists(): Offset exists
HTTP_OAuth_Message::offsetGet(): Offset get
HTTP_OAuth_Message::offsetSet(): Offset set
HTTP_OAuth_Message::offsetUnset(): Offset unset
HTTP_OAuth_Message::prefixParameter(): Prefix parameter
HTTP_OAuth_Message::setParameters(): Set parameters
HTTP_OAuth_Message::__get(): Get
HTTP_OAuth_Message::__set(): Set

Class: HTTP_OAuth

HTTP_OAuth::attachLog(): Attaches an instance of PEAR Log
HTTP_OAuth::buildHttpQuery(): Build HTTP Query
HTTP_OAuth::debug(): Log debug message
HTTP_OAuth::detachLog(): Detaches an instance of PEAR Log
HTTP_OAuth::err(): Log error message
HTTP_OAuth::info(): Log info message
HTTP_OAuth::log(): Log a message
HTTP_OAuth::urldecode(): URL Decode
HTTP_OAuth::urlencode(): URL Encode

Class Details

[line 35]
HTTP_OAuth_Provider_Response

Author: Jeff Hodsdon <jeffhodsdon@gmail.com>
Copyright: 2009 Jeff Hodsdon <jeffhodsdon@gmail.com>
Link: http://pear.php.net/package/HTTP_OAuth
Link: http://github.com/jeffhodsdon/HTTP_OAuth
License: New BSD License

[ Top ]

Class Variables

$body = ''

[line 94]

Body of the response

Var: Body of the response
Access: protected

Type:

string

[ Top ]

$headers = array()

[line 87]

Headers to be sent the OAuth response

Var: Headers to send as an OAuth response
Access: protected

Type:

array

[ Top ]

$statusMap = array(
        self::STATUS_UNSUPPORTED_PARAMETER => array(
            400, 'Unsupported parameter'
        ),self::STATUS_UNSUPPORTED_SIGNATURE_METHOD=>array(400,'Unsupported signature method'),self::STATUS_MISSING_REQUIRED_PARAMETER=>array(400,'Missing required parameter'),self::STATUS_DUPLICATED_OAUTH_PARAMETER=>array(400,'Duplicated OAuth Protocol Parameter'),self::STATUS_INVALID_CONSUMER_KEY=>array(401,'Invalid Consumer Key'),self::STATUS_INVALID_TOKEN=>array(401,'Invalid / expired Token'),self::STATUS_INVALID_SIGNATURE=>array(401,'Invalid signature'),self::STATUS_INVALID_NONCE=>array(401,'Invalid / used nonce'))

[line 55]

Status map

Map of what statuses have codes and body text

Var: Map of status to code and text
Access: protected

Type:

array

[ Top ]

Method Detail

getBody [line 245]

string getBody(
)

Get body

Return: Body that will be sent
Access: public

[ Top ]

getHeader [line 129]

string|null getHeader(
string
$name)

Get header

Return: Header if exists, null if not
Access: public

Parameters:

string $name — Name of header

[ Top ]

getHeaders [line 143]

array getHeaders(
)

Get all headers

Return: Current headers to send
Access: public

[ Top ]

header [line 207]

void header(
string
$header)

Header

Access: protected

Parameters:

string $header — Header to add

[ Top ]

headersSent [line 195]

bool headersSent(
)

Headers sent

Return: If the headers have been sent
Access: protected

[ Top ]

prepareBody [line 219]

void prepareBody(
)

Prepare body

Sets the body if nesscary

Access: protected

[ Top ]

send [line 258]

void send(
)

Send response

Does a check whether or not headers have been sent in order to determine if it can send them.

Access: public

[ Top ]

setBody [line 235]

void setBody(
string
$body)

Set body

Access: public

Parameters:

string $body — Sets the body to send

[ Top ]

setHeader [line 117]

void setHeader(
string
$name, string
$value)

Set header

Access: public

Parameters:

string	`$name`	—	Name of the header
string	`$value`	—	Value of the header

[ Top ]

setHeaders [line 155]

void setHeaders(

$headers)

Set all headers

Access: public

Parameters:

array $headers — Sets all headers to this name/value array

[ Top ]

setRealm [line 103]

void setRealm(
string
$realm)

Set realm

Access: public

Parameters:

string $realm — Realm for the WWW-Authenticate header

[ Top ]

setStatus [line 167]

void setStatus(
int
$status)

Set status

Access: public

Parameters:

int $status — Status constant

[ Top ]