06 Apr 2018

Namespaces

League
- OAuth2
  - Client
    - Provider
None

Classes

Interfaces

Exceptions

Functions

Class CAS_Request_AbstractRequest

Provides support for performing web-requests via curl

CAS_Request_AbstractRequest implements CAS_Request_RequestInterface

Direct known subclasses

CAS_Request_CurlRequest

Abstract
Package: PhpCAS
Category: Authentication
License: Apache License 2.0
Author: Adam Franco afranco@middlebury.edu
Link: https://wiki.jasig.org/display/CASC/phpCAS
Class: CAS_Request_AbstractRequest
Located at shared/cas/source/CAS/Request/AbstractRequest.php

Methods summary
`public`	# `setUrl( string $url )` Set the URL of the Request Set the URL of the Request Parameters `$url` Url to set Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_Request_RequestInterface::setUrl()`
`public`	# `addCookie( string $name, string $value )` Add a cookie to the request. Add a cookie to the request. Parameters `$name` Name of entry `$value` value of entry Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_Request_RequestInterface::addCookie()`
`public`	# `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') 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 `$cookies` cookies to add Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_Request_RequestInterface::addCookies()`
`public`	# `addHeader( string $header )` Add a header string to the request. Add a header string to the request. Parameters `$header` Header to add Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_Request_RequestInterface::addHeader()`
`public`	# `addHeaders( array $headers )` Add an array of header strings to the request. Add an array of header strings to the request. Parameters `$headers` headers to add Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_Request_RequestInterface::addHeaders()`
`public`	# `makePost( )` Make the request a POST request rather than the default GET request. Make the request a POST request rather than the default GET request. Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_Request_RequestInterface::makePost()`
`public`	# `setPostBody( string $body )` Add a POST body to the request Add a POST body to the request Parameters `$body` body to add Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_Request_RequestInterface::setPostBody()`
`public`	# `setSslCaCert( string $caCertPath, boolean $validate_cn = true )` Specify the path to an SSL CA certificate to validate the server with. Specify the path to an SSL CA certificate to validate the server with. Parameters `$caCertPath` path to cert `$validate_cn` valdiate CN of certificate Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_Request_RequestInterface::setSslCaCert()`
`public boolean`	# `send( )` Perform the request. Perform the request. Returns boolean TRUE on success, FALSE on failure. Throws `CAS_OutOfSequenceException` If called multiple times. Implementation of `CAS_Request_RequestInterface::send()`
`abstract protected boolean`	# `sendRequest( )` Send the request and store the results. Send the request and store the results. Returns boolean TRUE on success, FALSE on failure.
`protected`	# `storeResponseHeaders( array $headers )` Store the response headers. Store the response headers. Parameters `$headers` headers to store
`protected`	# `storeResponseHeader( string $header )` Store a single response header to our array. Store a single response header to our array. Parameters `$header` header to store
`protected`	# `storeResponseBody( string $body )` Store the response body. Store the response body. Parameters `$body` body to store
`protected`	# `storeErrorMessage( string $message )` Add a string to our error message. Add a string to our error message. Parameters `$message` message to add
`public array`	# `getResponseHeaders( )` Answer the headers of the response. Answer the headers of the response. Returns array An array of header strings. Throws `CAS_OutOfSequenceException` If called before the Request has been sent. Implementation of `CAS_Request_RequestInterface::getResponseHeaders()`
`public integer`	# `getResponseStatusCode( )` Answer HTTP status code of the response Answer HTTP status code of the response Returns integer Throws `CAS_OutOfSequenceException` If called before the Request has been sent. Implementation of `CAS_Request_RequestInterface::getResponseStatusCode()`
`public string`	# `getResponseBody( )` Answer the body of response. Answer the body of response. Returns string Throws `CAS_OutOfSequenceException` If called before the Request has been sent. Implementation of `CAS_Request_RequestInterface::getResponseBody()`
`public string`	# `getErrorMessage( )` Answer a message describing any errors if the request failed. Answer a message describing any errors if the request failed. Returns string Throws `CAS_OutOfSequenceException` If called before the Request has been sent. Implementation of `CAS_Request_RequestInterface::getErrorMessage()`

Properties summary
`protected`	`$url`	# `null`
`protected array`	`$cookies`	# `array()`
`protected array`	`$headers`	# `array()`
`protected boolean`	`$isPost`	# `false`
`protected`	`$postBody`	# `null`
`protected`	`$caCertPath`	# `null`
`protected boolean`	`$validateCN`	# `true`
`private boolean`	`$_sent`	# `false`
`private array`	`$_responseHeaders`	# `array()`
`private`	`$_responseBody`	# `null`
`private string`	`$_errorMessage`	# `''`

class-CAS_Request_AbstractRequest

Namespaces

Classes

Interfaces

Exceptions

Functions

Class CAS_Request_AbstractRequest

Direct known subclasses

Parameters

Throws

Implementation of

Parameters

Throws

Implementation of

Parameters

Throws

Implementation of

Parameters

Throws

Implementation of

Parameters

Throws

Implementation of

Throws

Implementation of

Parameters

Throws

Implementation of

Parameters

Throws

Implementation of

Returns

Throws

Implementation of

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Implementation of

Returns

Throws

Implementation of

Returns

Throws

Implementation of

Returns

Throws

Implementation of