VuFind API Documentation

PermissionTest extends TestCase
in package
Uses ViewTrait

Permission view helper Test Class

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

author

Oliver Goldschmidt o.goldschmidt@tuhh.de

license

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

link

Wiki

Table of Contents

$permissionDeniedConfig  : array<string|int, mixed>
Sample configuration with various config options.
testExistingTemplateDisplay()  : void
Test the template display with an existing template
testMessageDisplay()  : void
Test the message display
testTemplateDisplay()  : void
Test the template display
getMockContext()  : Context
Get mock context helper.
getMockPm()  : PermissionManager
Get mock permission manager
getMockPmd()  : PermissionDeniedManager
Get mock driver that returns a deniedTemplateBehavior.
getMockView()  : PhpRenderer
Return a view object populated for these test cases.
getPathForTheme()  : string
Get the directory for a given theme.
getPhpRenderer()  : PhpRenderer
Get a working renderer.
getSearchMemoryViewHelper()  : SearchMemory
Get mock SearchMemory view helper

Properties

$permissionDeniedConfig

Sample configuration with various config options.

protected array<string|int, mixed> $permissionDeniedConfig = ['permissionDeniedTemplate' => ['deniedTemplateBehavior' => 'showTemplate:record/displayLogicTest:param1=noValue', 'deniedControllerBehavior' => 'showTemplate:record/ActionTest:param1=noValue'], 'permissionDeniedTemplateNoParams' => ['deniedTemplateBehavior' => 'showTemplate:record/displayLogicTest', 'deniedControllerBehavior' => 'showTemplate:record/ActionTest'], 'permissionDeniedMessage' => ['deniedTemplateBehavior' => 'showMessage:dl_translatable_test', 'deniedControllerBehavior' => 'showTemplate:action_translatable_test'], 'permissionDeniedLogin' => ['deniedControllerBehavior' => 'promptLogin'], 'permissionDeniedException' => ['deniedControllerBehavior' => 'exception:ForbiddenException:exception_message'], 'permissionDeniedNonExistentException' => ['deniedControllerBehavior' => 'exception:NonExistentException:exception_message'], 'permissionDeniedNothing' => []]

Methods

testExistingTemplateDisplay()

Test the template display with an existing template

public testExistingTemplateDisplay() : void
Return values
void —

testMessageDisplay()

Test the message display

public testMessageDisplay() : void
Return values
void —

testTemplateDisplay()

Test the template display

public testTemplateDisplay() : void
Return values
void —

getMockPm()

Get mock permission manager

protected getMockPm([array<string|int, mixed> $isAuthorized = false ]) : PermissionManager
Parameters
$isAuthorized : array<string|int, mixed> = false

isAuthorized value to return

Return values
PermissionManager —

getMockPmd()

Get mock driver that returns a deniedTemplateBehavior.

protected getMockPmd([array<string|int, mixed> $config = false ]) : PermissionDeniedManager
Parameters
$config : array<string|int, mixed> = false

Config containing DeniedTemplateBehavior to return

Return values
PermissionDeniedManager —

getMockView()

Return a view object populated for these test cases.

protected getMockView() : PhpRenderer
Return values
PhpRenderer —

getPathForTheme()

Get the directory for a given theme.

protected getPathForTheme(string $theme) : string
Parameters
$theme : string

Theme directory name

Return values
string —

getPhpRenderer()

Get a working renderer.

protected getPhpRenderer([array<string|int, mixed> $plugins = [] ][, string $theme = 'bootstrap3' ]) : PhpRenderer
Parameters
$plugins : array<string|int, mixed> = []

Custom VuFind plug-ins to register

$theme : string = 'bootstrap3'

Theme directory to load from

Return values
PhpRenderer —

getSearchMemoryViewHelper()

Get mock SearchMemory view helper

protected getSearchMemoryViewHelper([Memory|null $memory = null ]) : SearchMemory
Parameters
$memory : Memory|null = null

Optional search memory

Return values
SearchMemory —

Search results