Class Sam
Sam base class.
Copyright 2002-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.
Methods summary
public static
array
|
#
getPreferredBackend( )
Determines the backend to use.
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.
Returns
array
The backend entry.
Throws
|
public static
array
|
#
getAttributes( )
Find a list of configured attributes.
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.
|
public static
boolean
|
#
infoAttribute( string $type = '' )
Find out whether the given attribute type is informational only.
Find out whether the given attribute type is informational only.
Parameters
- $type
- $attribute The attribute type to check.
Returns
booleanReturns true if the given type is known to be
informational only.
|
public static
string
|
#
mapUser( string|boolean $hordeauth )
Converts the current user's name, optionally removing the domain part or
applying any configured hooks.
Converts the current user's name, optionally removing the domain part or
applying any configured hooks.
Parameters
- $hordeauth
- <p>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.</p>
Returns
string
The converted username.
|