CAS_Request_AbstractRequest Class Reference

Provides support for performing web-requests via curl. More...

Inheritance diagram for CAS_Request_AbstractRequest:

Collaboration diagram for CAS_Request_AbstractRequest:

Public Member Functions
	setUrl ($url)
	Set the URL of the Request. More...
	addCookie ($name, $value)
	Add a cookie to the request. More...
	addCookies (array $cookies)
	Add an array of cookies to the request. More...
	addHeader ($header)
	Add a header string to the request. More...
	addHeaders (array $headers)
	Add an array of header strings to the request. More...
	makePost ()
	Make the request a POST request rather than the default GET request. More...
	setPostBody ($body)
	Add a POST body to the request. More...
	setSslCaCert ($caCertPath, $validate_cn=true)
	Specify the path to an SSL CA certificate to validate the server with. More...
	send ()
	Perform the request. More...
	getResponseHeaders ()
	Answer the headers of the response. More...
	getResponseStatusCode ()
	Answer HTTP status code of the response. More...
	getResponseBody ()
	Answer the body of response. More...
	getErrorMessage ()
	Answer a message describing any errors if the request failed. More...
Public Member Functions inherited from CAS_Request_RequestInterface
	setUrl ($url)
	Set the URL of the Request. More...
	addCookie ($name, $value)
	Add a cookie to the request. More...
	addCookies (array $cookies)
	Add an array of cookies to the request. More...
	addHeader ($header)
	Add a header string to the request. More...
	addHeaders (array $headers)
	Add an array of header strings to the request. More...
	makePost ()
	Make the request a POST request rather than the default GET request. More...
	setPostBody ($body)
	Add a POST body to the request. More...
	setSslCaCert ($caCertPath, $validate_cn=true)
	Specify the path to an SSL CA certificate to validate the server with. More...
	send ()
	Perform the request. More...
	getResponseHeaders ()
	Answer the headers of the response. More...
	getResponseStatusCode ()
	Answer HTTP status code of the response. More...
	getResponseBody ()
	Answer the body of response. More...
	getErrorMessage ()
	Answer a message describing any errors if the request failed. More...

Protected Member Functions
	sendRequest ()
	Send the request and store the results. More...
	storeResponseHeaders (array $headers)
	Store the response headers. More...
	storeResponseHeader ($header)
	Store a single response header to our array. More...
	storeResponseBody ($body)
	Store the response body. More...
	storeErrorMessage ($message)
	Add a string to our error message. More...

Protected Attributes
	$url = null
	$cookies = array()
	$headers = array()
	$isPost = false
	$postBody = null
	$caCertPath = null
	$validateCN = true

Private Attributes
	$_sent = false
	$_responseHeaders = array()
	$_responseBody = null
	$_errorMessage = ''

Detailed Description

Provides support for performing web-requests via curl.

Definition at line 40 of file AbstractRequest.php.

Member Function Documentation

addCookie()

CAS_Request_AbstractRequest::addCookie	(		$name,
			$value
	)

Add a cookie to the request.

Parameters

string	$name	Name of entry
string	$value	value of entry

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the Request has been sent.

Definition at line 86 of file AbstractRequest.php.

References $name.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot ' . __METHOD__
            );
        }

        $this->cookies[$name] = $value;
    }

addCookies()

CAS_Request_AbstractRequest::addCookies

(

array

$cookies

)

Add an array of cookies to the request.

The cookie array is of the form array('cookie_name' => 'cookie_value', 'cookie_name2' => cookie_value2')

Parameters

array

$cookies

cookies to add

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the Request has been sent.

Definition at line 107 of file AbstractRequest.php.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot ' . __METHOD__
            );
        }

        $this->cookies = array_merge($this->cookies, $cookies);
    }

addHeader()

CAS_Request_AbstractRequest::addHeader

(

$header

)

Add a header string to the request.

Parameters

string

$header

Header to add

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the Request has been sent.

Definition at line 126 of file AbstractRequest.php.

References $header.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot ' . __METHOD__
            );
        }

        $this->headers[] = $header;
    }

addHeaders()

CAS_Request_AbstractRequest::addHeaders

(

array

$headers

)

Add an array of header strings to the request.

Parameters

array

$headers

headers to add

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the Request has been sent.

Definition at line 145 of file AbstractRequest.php.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot ' . __METHOD__
            );
        }

        $this->headers = array_merge($this->headers, $headers);
    }

getErrorMessage()

CAS_Request_AbstractRequest::getErrorMessage

(

)

Answer a message describing any errors if the request failed.

Returns

string

Exceptions

CAS_OutOfSequenceException

If called before the Request has been sent.

Definition at line 369 of file AbstractRequest.php.

References $_errorMessage.

    {
        if (!$this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has not been sent yet. Cannot ' . __METHOD__
            );
        }
        return $this->_errorMessage;
    }

getResponseBody()

CAS_Request_AbstractRequest::getResponseBody

(

)

Answer the body of response.

Returns

string

Exceptions

CAS_OutOfSequenceException

If called before the Request has been sent.

Definition at line 352 of file AbstractRequest.php.

References $_responseBody.

    {
        if (!$this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has not been sent yet. Cannot ' . __METHOD__
            );
        }

        return $this->_responseBody;
    }

getResponseHeaders()

CAS_Request_AbstractRequest::getResponseHeaders

(

)

Answer the headers of the response.

Returns

array An array of header strings.

Exceptions

CAS_OutOfSequenceException

If called before the Request has been sent.

Definition at line 308 of file AbstractRequest.php.

References $_responseHeaders.

    {
        if (!$this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has not been sent yet. Cannot ' . __METHOD__
            );
        }
        return $this->_responseHeaders;
    }

getResponseStatusCode()

CAS_Request_AbstractRequest::getResponseStatusCode

(

)

Answer HTTP status code of the response.

Returns

int

Exceptions

CAS_OutOfSequenceException

If called before the Request has been sent.

Definition at line 324 of file AbstractRequest.php.

    {
        if (!$this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has not been sent yet. Cannot ' . __METHOD__
            );
        }

        if (!preg_match(
            '/HTTP\/[0-9.]+\s+([0-9]+)\s*(.*)/',
            $this->_responseHeaders[0],
            $matches
        )
        ) {
            throw new CAS_Request_Exception(
                'Bad response, no status code was found in the first line.'
            );
        }

        return intval($matches[1]);
    }

makePost()

CAS_Request_AbstractRequest::makePost

(

)

Make the request a POST request rather than the default GET request.

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the Request has been sent.

Definition at line 162 of file AbstractRequest.php.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot ' . __METHOD__
            );
        }

        $this->isPost = true;
    }

send()

CAS_Request_AbstractRequest::send

(

)

Perform the request.

Returns

bool TRUE on success, FALSE on failure.

Exceptions

CAS_OutOfSequenceException

If called multiple times.

Definition at line 227 of file AbstractRequest.php.

References sendRequest().

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot send again.'
            );
        }
        if (is_null($this->url) || !$this->url) {
            throw new CAS_OutOfSequenceException(
                'A url must be specified via setUrl() before the request can be sent.'
            );
        }
        $this->_sent = true;
        return $this->sendRequest();
    }

Here is the call graph for this function:

sendRequest()

CAS_Request_AbstractRequest::sendRequest ( )

abstractprotected

Send the request and store the results.

Returns

bool TRUE on success, FALSE on failure.

Referenced by send().

Here is the caller graph for this function:

setPostBody()

CAS_Request_AbstractRequest::setPostBody

(

$body

)

Add a POST body to the request.

Parameters

string

$body

body to add

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the Request has been sent.

Definition at line 181 of file AbstractRequest.php.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot ' . __METHOD__
            );
        }
        if (!$this->isPost) {
            throw new CAS_OutOfSequenceException(
                'Cannot add a POST body to a GET request, use makePost() first.'
            );
        }

        $this->postBody = $body;
    }

setSslCaCert()

CAS_Request_AbstractRequest::setSslCaCert	(		$caCertPath,
			$validate_cn = true
	)

Specify the path to an SSL CA certificate to validate the server with.

Parameters

string	$caCertPath	path to cert
bool	$validate_cn	valdiate CN of certificate

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the Request has been sent.

Definition at line 206 of file AbstractRequest.php.

References $caCertPath.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot ' . __METHOD__
            );
        }
        $this->caCertPath = $caCertPath;
        $this->validateCN = $validate_cn;
    }

setUrl()

CAS_Request_AbstractRequest::setUrl

(

$url

)

Set the URL of the Request.

Parameters

string

$url

Url to set

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after the Request has been sent.

Definition at line 66 of file AbstractRequest.php.

References $url.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot ' . __METHOD__
            );
        }

        $this->url = $url;
    }

storeErrorMessage()

CAS_Request_AbstractRequest::storeErrorMessage (   $message )

protected

Add a string to our error message.

Parameters

string

$message

message to add

Returns

void

Definition at line 293 of file AbstractRequest.php.

References $message.

Referenced by CAS_Request_CurlRequest\sendRequest().

    {
        $this->_errorMessage .= $message;
    }

Here is the caller graph for this function:

storeResponseBody()

CAS_Request_AbstractRequest::storeResponseBody (   $body )

protected

Store the response body.

Parameters

string

$body

body to store

Returns

void

Definition at line 281 of file AbstractRequest.php.

Referenced by CAS_Request_CurlRequest\_storeResponseBody(), and CAS_Request_CurlRequest\sendRequest().

    {
        $this->_responseBody = $body;
    }

Here is the caller graph for this function:

storeResponseHeader()

CAS_Request_AbstractRequest::storeResponseHeader (   $header )

protected

Store a single response header to our array.

Parameters

string

$header

header to store

Returns

void

Definition at line 269 of file AbstractRequest.php.

References $header.

Referenced by CAS_Request_CurlRequest\_curlReadHeaders().

    {
        $this->_responseHeaders[] = $header;
    }

Here is the caller graph for this function:

storeResponseHeaders()

CAS_Request_AbstractRequest::storeResponseHeaders ( array  $headers )

protected

Store the response headers.

Parameters

array

$headers

headers to store

Returns

void

Definition at line 257 of file AbstractRequest.php.

    {
        $this->_responseHeaders = array_merge($this->_responseHeaders, $headers);
    }

Field Documentation

$_errorMessage

CAS_Request_AbstractRequest::$_errorMessage = ''

private

Definition at line 52 of file AbstractRequest.php.

Referenced by getErrorMessage().

$_responseBody

CAS_Request_AbstractRequest::$_responseBody = null

private

Definition at line 51 of file AbstractRequest.php.

Referenced by getResponseBody().

$_responseHeaders

CAS_Request_AbstractRequest::$_responseHeaders = array()

private

Definition at line 50 of file AbstractRequest.php.

Referenced by getResponseHeaders().

$_sent

CAS_Request_AbstractRequest::$_sent = false

private

Definition at line 49 of file AbstractRequest.php.

$caCertPath

CAS_Request_AbstractRequest::$caCertPath = null

protected

Definition at line 47 of file AbstractRequest.php.

Referenced by setSslCaCert().

$cookies

CAS_Request_AbstractRequest::$cookies = array()

protected

Definition at line 43 of file AbstractRequest.php.

$headers

CAS_Request_AbstractRequest::$headers = array()

protected

Definition at line 44 of file AbstractRequest.php.

$isPost

CAS_Request_AbstractRequest::$isPost = false

protected

Definition at line 45 of file AbstractRequest.php.

$postBody

CAS_Request_AbstractRequest::$postBody = null

protected

Definition at line 46 of file AbstractRequest.php.

$url

CAS_Request_AbstractRequest::$url = null

protected

Definition at line 42 of file AbstractRequest.php.

Referenced by setUrl().

$validateCN

CAS_Request_AbstractRequest::$validateCN = true

protected

Definition at line 48 of file AbstractRequest.php.

---

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

• Services/CAS/lib/CAS/Request/AbstractRequest.php