VuFind API Documentation

CASTest extends TestCase
in package
Uses ReflectionTrait

CAS authentication test class.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Main Page

Table of Contents

configKeyProvider()  : void
Data provider for testWithMissingConfiguration.
fallbackUrlProvider()  : void
Data provider for testBaseUrlConfigFallback.
getAuthConfig()  : Config
Get a working configuration for the CAS object
getAuthObject()  : CAS
Get an authentication object.
testBaseUrlConfigFallback()  : void
Test service base URL configuration fallback to site URL.
testBaseUrlConfigInvalidFallback()  : void
Test service base URL configuration fallback to invalid site URL.
testConfigValidation()  : void
Verify that missing configuration keys cause failure.
testGetSessionInitiator()  : void
Test getSessionInitiator().
testLogout()  : void
Test logout().
testMissingBaseUrlConfig()  : void
Test missing service base URL configuration.
testWorkingBaseUrlConfig()  : void
Test working service base URL configuration.
callMethod()  : mixed
Call protected or private method for side-effect and result.
getProperty()  : mixed
Return protected or private property.
setProperty()  : void
Set protected or private property.

Methods

configKeyProvider()

Data provider for testWithMissingConfiguration.

public static configKeyProvider() : void
Return values
void

fallbackUrlProvider()

Data provider for testBaseUrlConfigFallback.

public static fallbackUrlProvider() : void
Return values
void

getAuthConfig()

Get a working configuration for the CAS object

public getAuthConfig([array<string|int, mixed> $extraCasConfig = [] ][, array<string|int, mixed> $extraTopConfig = [] ]) : Config
Parameters
$extraCasConfig : array<string|int, mixed> = []

Extra config parameters to include in [CAS] section

$extraTopConfig : array<string|int, mixed> = []

Extra top-level config settings to include

Return values
Config

getAuthObject()

Get an authentication object.

public getAuthObject([Config|null $config = null ]) : CAS
Parameters
$config : Config|null = null

Configuration to use (null for default)

Return values
CAS

testBaseUrlConfigFallback()

Test service base URL configuration fallback to site URL.

public testBaseUrlConfigFallback(string $url, string $host) : void
Parameters
$url : string

URL for configuration

$host : string

Expected hostname extracted from $url

Tags
dataProvider

fallbackUrlProvider

Return values
void

testBaseUrlConfigInvalidFallback()

Test service base URL configuration fallback to invalid site URL.

public testBaseUrlConfigInvalidFallback() : void
Return values
void

testConfigValidation()

Verify that missing configuration keys cause failure.

public testConfigValidation(string $key) : void
Parameters
$key : string

Key to omit

Tags
dataProvider

configKeyProvider

Return values
void

testGetSessionInitiator()

Test getSessionInitiator().

public testGetSessionInitiator() : void
Return values
void

testLogout()

Test logout().

public testLogout() : void
Return values
void

testMissingBaseUrlConfig()

Test missing service base URL configuration.

public testMissingBaseUrlConfig() : void
Return values
void

testWorkingBaseUrlConfig()

Test working service base URL configuration.

public testWorkingBaseUrlConfig() : void
Return values
void

callMethod()

Call protected or private method for side-effect and result.

protected callMethod(object|string $object, string $method[, array<string|int, mixed> $arguments = [] ]) : mixed

Uses PHP's reflection API in order to modify method accessibility.

Parameters
$object : object|string

Object or class name

$method : string

Method name

$arguments : array<string|int, mixed> = []

Method arguments

Tags
throws
ReflectionException

Method does not exist

Return values
mixed

getProperty()

Return protected or private property.

protected getProperty(object|string $object, string $property) : mixed

Uses PHP's reflection API in order to modify property accessibility.

Parameters
$object : object|string

Object or class name

$property : string

Property name

Tags
throws
ReflectionException

Property does not exist

Return values
mixed

setProperty()

Set protected or private property.

protected setProperty(object|string $object, string $property, mixed $value) : void

Uses PHP's reflection API in order to modify property accessibility.

Parameters
$object : object|string

Object or class name

$property : string

Property name

$value : mixed

Property value

Tags
throws
ReflectionException

Property does not exist

Return values
void

Search results