PHP Class SimpleHttpHeaders, simpletest

Mostra file Open project: simpletest/simpletest Class Usage Examples

Public Methods

Method Description
__construct ( string $headers ) Parses the incoming header block.
getAuthentication ( ) : string Accessor for authentication type.
getHttpVersion ( ) : integer Accessor for parsed HTTP protocol version.
getLocation ( ) : string Returns the redirected URL or false if no redirection.
getMimeType ( ) : string Accessor for MIME type header information.
getRaw ( ) : string Accessor for raw header block.
getRealm ( ) : string Accessor for security realm.
getResponseCode ( ) : integer Accessor for parsed HTTP error code.
isChallenge ( ) : boolean Test to see if the response is an authentication challenge.
isRedirect ( ) : boolean Test to see if the response is a valid redirect.
writeCookiesToJar ( SimpleCookieJar $jar, SimpleUrl $url ) Writes new cookies to the cookie jar.

Protected Methods

Method Description
parseCookie ( string $cookie_line ) : SimpleCookie Parse the Set-cookie content.
parseHeaderLine ( string $header_line ) Called on each header line to accumulate the held data within the class.

Method Details

__construct() public method

Parses the incoming header block.
public __construct ( string $headers )
$headers string Header block.

getAuthentication() public method

Accessor for authentication type.
public getAuthentication ( ) : string
return string Type.

getHttpVersion() public method

Accessor for parsed HTTP protocol version.
public getHttpVersion ( ) : integer
return integer HTTP error code.

getLocation() public method

Returns the redirected URL or false if no redirection.
public getLocation ( ) : string
return string URL or false for none.

getMimeType() public method

Accessor for MIME type header information.
public getMimeType ( ) : string
return string MIME type.

getRaw() public method

Accessor for raw header block.
public getRaw ( ) : string
return string All headers as raw string.

getRealm() public method

Accessor for security realm.
public getRealm ( ) : string
return string Realm.

getResponseCode() public method

Accessor for parsed HTTP error code.
public getResponseCode ( ) : integer
return integer HTTP error code.

isChallenge() public method

Test to see if the response is an authentication challenge.
public isChallenge ( ) : boolean
return boolean True if challenge.

isRedirect() public method

Test to see if the response is a valid redirect.
public isRedirect ( ) : boolean
return boolean True if valid redirect.

parseCookie() protected method

Parse the Set-cookie content.
protected parseCookie ( string $cookie_line ) : SimpleCookie
$cookie_line string Text after "Set-cookie:"
return SimpleCookie New cookie object.

parseHeaderLine() protected method

Called on each header line to accumulate the held data within the class.
protected parseHeaderLine ( string $header_line )
$header_line string One line of header.

writeCookiesToJar() public method

Writes new cookies to the cookie jar.
public writeCookiesToJar ( SimpleCookieJar $jar, SimpleUrl $url )
$jar SimpleCookieJar Jar to write to.
$url SimpleUrl Host and path to write under.