VuFind API Documentation

User
in package
implements PermissionProviderInterface, LoggerAwareInterface Uses LoggerAwareTrait

LDAP permission provider for VuFind.

based on permission provider Username.php

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

Interfaces, Classes, Traits and Enums

PermissionProviderInterface
Permission provider interface
LoggerAwareInterface

Table of Contents

$auth  : AuthorizationService
Authorization object
__construct()  : mixed
Constructor
getPermissions()  : array<string|int, mixed>
Return an array of roles which may be granted the permission based on the options.
debug()  : void
Log a debug message.
log()  : void
Send a message to the logger.
logError()  : void
Log an error message.
logWarning()  : void
Log a warning message.

Properties

$auth

Authorization object

protected AuthorizationService $auth

Methods

__construct()

Constructor

public __construct(AuthorizationService $authorization) : mixed
Parameters
$authorization : AuthorizationService

Authorization service

Return values
mixed —

getPermissions()

Return an array of roles which may be granted the permission based on the options.

public getPermissions(mixed $options) : array<string|int, mixed>
Parameters
$options : mixed

Options provided from configuration.

Return values
array<string|int, mixed> —

debug()

Log a debug message.

protected debug(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void
Parameters
$msg : string

Log message

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

Log context

$prependClass : bool = true

Prepend class name to message?

Return values
void —

log()

Send a message to the logger.

protected log(string $level, string $message[, array<string|int, mixed> $context = [] ][, bool $prependClass = false ]) : void
Parameters
$level : string

Log level

$message : string

Log message

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

Log context

$prependClass : bool = false

Prepend class name to message?

Return values
void —

logError()

Log an error message.

protected logError(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void
Parameters
$msg : string

Log message

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

Log context

$prependClass : bool = true

Prepend class name to message?

Return values
void —

logWarning()

Log a warning message.

protected logWarning(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void
Parameters
$msg : string

Log message

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

Log context

$prependClass : bool = true

Prepend class name to message?

Return values
void —

Search results