API Documentation
\

\Sam

Sam base class.

Copyright 2002-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Summary

Methods
Properties
Constants
getPreferredBackend()
getAttributes()
infoAttribute()
mapUser()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getPreferredBackend()

getPreferredBackend() : array

Determines the backend to use.

This decision is based on the global 'SERVER_NAME' and 'HTTP_HOST' server variables and the contents of the 'preferred' either field in the backend's definition. The 'preferred' field may take a single value or an array of multiple values.

Throws

\Sam_Exception

Returns

array —

The backend entry.

getAttributes()

getAttributes() : array

Find a list of configured attributes.

Load the attributes configuration file or uses an already-loaded cached copy. If loading for the first time, cache it for later use.

Returns

array —

The attributes list.

infoAttribute()

infoAttribute(  $type = '') : boolean

Find out whether the given attribute type is informational only.

Parameters

$type

Returns

boolean —

Returns true if the given type is known to be informational only.

mapUser()

mapUser(string|boolean  $hordeauth) : string

Converts the current user's name, optionally removing the domain part or applying any configured hooks.

Parameters

string|boolean $hordeauth

Defines how to use the authenticated Horde username. If set to 'full', will initialize the username to contain the @realm part. Otherwise, the username will initialize as a simple login.

Returns

string —

The converted username.