HTTP_OAuth
[ class tree: HTTP_OAuth ] [ index: HTTP_OAuth ] [ all elements ]

Class: HTTP_OAuth_Message

Source Location: /HTTP_OAuth-0.1.6/HTTP/OAuth/Message.php

Class Overview

HTTP_OAuth
   |
   --HTTP_OAuth_Message

HTTP_OAuth_Message


Author(s):

Copyright:

  • 2009 Jeff Hodsdon <jeffhodsdon@gmail.com>

Variables

Methods


Child classes:

HTTP_OAuth_Consumer_Response
HTTP_OAuth_Consumer_Response
HTTP_OAuth_Consumer_Request
HTTP_OAuth_Consumer_Request
HTTP_OAuth_Provider_Response
HTTP_OAuth_Provider_Response
HTTP_OAuth_Provider_Request
HTTP_OAuth_Provider_Request

Inherited Variables

Inherited Methods

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 42]
HTTP_OAuth_Message

Main message class for Request and Response classes to extend from. Provider and Consumer packages use this class as there parent for the request/response classes. This contains specification parameters handling and ArrayAccess, Countable, IteratorAggregate features.



[ Top ]


Class Variables

$oauthParams = array(
        'consumer_key',
        'token',
        'token_secret',
        'signature_method',
        'signature',
        'timestamp',
        'nonce',
        'verifier',
        'version',
        'callback'
    )

[line 52]

OAuth Parameters
  • Var: OAuth parameters
  • Access: protected

Type:   string


[ Top ]

$parameters = array()

[line 70]

Parameters
  • Var: Parameters
  • Access: protected

Type:   array


[ Top ]



Method Detail

count   [line 218]

int count( )

Count
  • Return: Amount of parameters
  • Access: public

[ Top ]

getIterator   [line 228]

ArrayIterator getIterator( )

Get iterator
  • Return: Iterator for self::$parameters
  • Access: public

[ Top ]

getOAuthParameters   [line 77]

array getOAuthParameters( )

Get OAuth specific parameters
  • Return: OAuth specific parameters
  • Access: public

[ Top ]

getParameters   [line 96]

array getParameters( )

Get parameters
  • Return: Request's parameters
  • Access: public

[ Top ]

getSignatureMethod   [line 120]

string getSignatureMethod( )

Get signature method
  • Return: Signature method
  • Access: public

[ Top ]

offsetExists   [line 171]

bool offsetExists( string $offset)

Offset exists
  • Return: Offset exists or not
  • Access: public

Parameters:

string   $offset     Name of the offset

[ Top ]

offsetGet   [line 183]

string offsetGet( string $offset)

Offset get
  • Return: Offset value
  • Access: public

Parameters:

string   $offset     Name of the offset

[ Top ]

offsetSet   [line 196]

void offsetSet( string $offset, string $value)

Offset set
  • Access: public

Parameters:

string   $offset     Name of the offset
string   $value     Value of the offset

[ Top ]

offsetUnset   [line 208]

void offsetUnset( string $offset)

Offset unset
  • Access: public

Parameters:

string   $offset     Name of the offset

[ Top ]

prefixParameter   [line 242]

string prefixParameter( string $param)

Prefix parameter

Prefixes a parameter name with oauth_ if it is a valid oauth paramter

  • Return: Prefix parameter
  • Access: protected

Parameters:

string   $param     Name of the parameter

[ Top ]

setParameters   [line 108]

void setParameters( $params)

Set parameters
  • Access: public

Parameters:

array   $params     Name => value pair array of parameters

[ Top ]

__get   [line 136]

mixed __get( string $var)

Get
  • Return: Parameter if exists, else null
  • Access: public

Parameters:

string   $var     Variable to get

[ Top ]

__set   [line 159]

void __set( string $var, mixed $val)

Set
  • Access: public

Parameters:

string   $var     Name of the variable
mixed   $val     Value of the variable

[ Top ]


Documentation generated on Mon, 30 Nov 2009 23:00:04 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.