CAS_Request_CurlRequest Class Reference

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

Inheritance diagram for CAS_Request_CurlRequest:

Collaboration diagram for CAS_Request_CurlRequest:

Public Member Functions
	setCurlOptions (array $options)
	Set additional curl options. More...
	initAndConfigure ()
	Internal method to initialize our cURL handle and configure the request. More...
Public Member Functions inherited from CAS_Request_AbstractRequest
	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...
Protected Member Functions inherited from CAS_Request_AbstractRequest
	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...

Private Member Functions
	_storeResponseBody ($body)
	Store the response body. More...
	_curlReadHeaders ($ch, $header)
	Internal method for capturing the headers from a curl request. More...

Private Attributes
	$_curlOptions = array()

Additional Inherited Members
Protected Attributes inherited from CAS_Request_AbstractRequest
	$url = null
	$cookies = array()
	$headers = array()
	$isPost = false
	$postBody = null
	$caCertPath = null
	$validateCN = true

Detailed Description

Provides support for performing web-requests via curl.

Definition at line 40 of file CurlRequest.php.

Member Function Documentation

_curlReadHeaders()

CAS_Request_CurlRequest::_curlReadHeaders (   $ch,   $header  )

private

Internal method for capturing the headers from a curl request.

Parameters

handle	$ch	handle of curl
string	$header	header

Returns

void

Definition at line 195 of file CurlRequest.php.

References $header, and CAS_Request_AbstractRequest\storeResponseHeader().

    {
        $this->storeResponseHeader($header);
        return strlen($header);
    }

Here is the call graph for this function:

_storeResponseBody()

CAS_Request_CurlRequest::_storeResponseBody (   $body )

private

Store the response body.

This method should NOT be used outside of the CurlRequest or the CurlMultiRequest.

Parameters

string

$body

body to stor

Returns

void

Definition at line 182 of file CurlRequest.php.

References CAS_Request_AbstractRequest\storeResponseBody().

    {
        $this->storeResponseBody($body);
    }

Here is the call graph for this function:

initAndConfigure()

CAS_Request_CurlRequest::initAndConfigure

(

)

Internal method to initialize our cURL handle and configure the request.

This method should NOT be used outside of the CurlRequest or the CurlMultiRequest.

Returns

resource The cURL handle on success, false on failure

Definition at line 102 of file CurlRequest.php.

References array, and phpCAS\trace().

Referenced by sendRequest().

    {
        /*********************************************************
         * initialize the CURL session
        *********************************************************/
        $ch = curl_init($this->url);

        if (version_compare(PHP_VERSION, '5.1.3', '>=')) {
            //only avaible in php5
            curl_setopt_array($ch, $this->_curlOptions);
        } else {
            foreach ($this->_curlOptions as $key => $value) {
                curl_setopt($ch, $key, $value);
            }
        }

        /*********************************************************
         * Set SSL configuration
        *********************************************************/
        if ($this->caCertPath) {
            if ($this->validateCN) {
                curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
            } else {
                curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
            }
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
            curl_setopt($ch, CURLOPT_CAINFO, $this->caCertPath);
            phpCAS::trace('CURL: Set CURLOPT_CAINFO ' . $this->caCertPath);
        } else {
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
            curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
        }

        /*********************************************************
         * Configure curl to capture our output.
        *********************************************************/
        // return the CURL output into a variable
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

        // get the HTTP header with a callback
        curl_setopt($ch, CURLOPT_HEADERFUNCTION, array($this, '_curlReadHeaders'));

        /*********************************************************
         * Add cookie headers to our request.
        *********************************************************/
        if (count($this->cookies)) {
            $cookieStrings = array();
            foreach ($this->cookies as $name => $val) {
                $cookieStrings[] = $name.'='.$val;
            }
            curl_setopt($ch, CURLOPT_COOKIE, implode(';', $cookieStrings));
        }

        /*********************************************************
         * Add any additional headers
        *********************************************************/
        if (count($this->headers)) {
            curl_setopt($ch, CURLOPT_HTTPHEADER, $this->headers);
        }

        /*********************************************************
         * Flag and Body for POST requests
        *********************************************************/
        if ($this->isPost) {
            curl_setopt($ch, CURLOPT_POST, 1);
            curl_setopt($ch, CURLOPT_POSTFIELDS, $this->postBody);
        }

        return $ch;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendRequest()

CAS_Request_CurlRequest::sendRequest ( )

protected

Send the request and store the results.

Returns

bool true on success, false on failure.

Definition at line 63 of file CurlRequest.php.

References $res, initAndConfigure(), CAS_Request_AbstractRequest\storeErrorMessage(), CAS_Request_AbstractRequest\storeResponseBody(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();

        /*********************************************************
         * initialize the CURL session
        *********************************************************/
        $ch = $this->initAndConfigure();

        /*********************************************************
         * Perform the query
        *********************************************************/
        $buf = curl_exec($ch);
        if ( $buf === false ) {
            phpCAS::trace('curl_exec() failed');
            $this->storeErrorMessage(
                'CURL error #'.curl_errno($ch).': '.curl_error($ch)
            );
            $res = false;
        } else {
            $this->storeResponseBody($buf);
            phpCAS::trace("Response Body: \n".$buf."\n");
            $res = true;

        }
        // close the CURL session
        curl_close($ch);

        phpCAS::traceEnd($res);
        return $res;
    }

Here is the call graph for this function:

setCurlOptions()

CAS_Request_CurlRequest::setCurlOptions

(

array

$options

)

Set additional curl options.

Parameters

array

$options

option to set

Returns

void

Definition at line 52 of file CurlRequest.php.

References $options.

    {
        $this->_curlOptions = $options;
    }

Field Documentation

$_curlOptions

CAS_Request_CurlRequest::$_curlOptions = array()

private

Definition at line 56 of file CurlRequest.php.

---

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

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