Class: BasicSecurityUser

Source Location: /user/BasicSecurityUser.class.php

Class Overview

ParameterHolder
   |
   --User
      |
      --SecurityUser
         |
         --BasicSecurityUser

BasicSecurityUser will handle any type of data as a credential.

Author(s):

Sean Kerr (skerr@mojavi.org)

Version:

$Id: BasicSecurityUser.class.php 690 2004-12-21 20:47:50Z seank $

Copyright:

Variables

$credentials

Constants

Methods

Inherited Constants

Class: User

User::ATTRIBUTE_NAMESPACE

Inherited Variables

Class: ParameterHolder

ParameterHolder::$parameters

Inherited Methods

Class: SecurityUser

SecurityUser::addCredential(): Add a credential to this user.
SecurityUser::clearCredentials(): Clear all credentials associated with this user.
SecurityUser::hasCredential(): Indicates whether or not this user has a credential.
SecurityUser::isAuthenticated(): Indicates whether or not this user is authenticated.
SecurityUser::removeCredential(): Remove a credential from this user.
SecurityUser::setAuthenticated(): Set the authenticated status of this user.

Class: User

User::clearAttributes(): Clear all attributes associated with this user.
User::getAttribute(): Retrieve an attribute.
User::getAttributeNames(): Retrieve an array of attribute names.
User::getAttributeNamespace(): Retrieve all attributes within a namespace.
User::getAttributeNamespaces(): Retrieve an array of attribute namespaces.
User::getContext(): Retrieve the current application context.
User::hasAttribute(): Indicates whether or not an attribute exists.
User::hasAttributeNamespace(): Indicates whether or not an attribute namespace exists.
User::initialize(): Initialize this User.
User::newInstance(): Retrieve a new User implementation instance.
User::removeAttribute(): Remove an attribute.
User::removeAttributeNamespace(): Remove an attribute namespace and all of its associated attributes.
User::setAttribute(): Set an attribute.
User::setAttributeByRef(): Set an attribute by reference.
User::setAttributes(): Set an array of attributes.
User::setAttributesByRef(): Set an array of attributes by reference.
User::shutdown(): Execute the shutdown procedure.

Class: ParameterHolder

ParameterHolder::clearParameters(): Clear all parameters associated with this request.
ParameterHolder::getParameter(): Retrieve a parameter.
ParameterHolder::getParameterNames(): Retrieve an array of parameter names.
ParameterHolder::getParameters(): Retrieve an array of parameters.
ParameterHolder::hasParameter(): Indicates whether or not a parameter exists.
ParameterHolder::removeParameter(): Remove a parameter.
ParameterHolder::setParameter(): Set a parameter.
ParameterHolder::setParameterByRef(): Set a parameter by reference.
ParameterHolder::setParameters(): Set an array of parameters.
ParameterHolder::setParametersByRef(): Set an array of parameters by reference.

Class Details

[line 23]
BasicSecurityUser will handle any type of data as a credential.

Tags:

version:	$Id: BasicSecurityUser.class.php 690 2004-12-21 20:47:50Z seank $
since:	3.0.0
copyright:	(c) Sean Kerr, http://www.mojavi.org
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

Class Variables

$credentials = null

[line 46]

Type:

mixed

[ Top ]

Class Methods

method addCredential [line 62]

void addCredential(
mixed
$credential)

Add a credential to this user.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides SecurityUser::addCredential() (Add a credential to this user.)

Parameters:

mixed

$credential

Credential data.

[ Top ]

method clearCredentials [line 84]

void clearCredentials(
)

Clear all credentials associated with this user.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides SecurityUser::clearCredentials() (Clear all credentials associated with this user.)

[ Top ]

method hasCredential [line 104]

bool hasCredential(
mixed
$credential)

Indicates whether or not this user has a credential.

Tags:

return:	true, if this user has the credential, otherwise false.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides SecurityUser::hasCredential() (Indicates whether or not this user has a credential.)

Parameters:

mixed

$credential

Credential data.

[ Top ]

method initialize [line 128]

bool initialize(
Context
$context, [array
$parameters = null])

Initialize this User.

Tags:

return:	true, if initialization completes successfully, otherwise false.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	InitializationException If an error occurs while initializing this User.

Overrides User::initialize() (Initialize this User.)

Parameters:

Context	$context	A Context instance.
array	$parameters	An associative array of initialization parameters.

[ Top ]

method isAuthenticated [line 161]

bool isAuthenticated(
)

Indicates whether or not this user is authenticated.

Tags:

return:	true, if this user is authenticated, otherwise false.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides SecurityUser::isAuthenticated() (Indicates whether or not this user is authenticated.)

[ Top ]

method removeCredential [line 180]

void removeCredential(
mixed
$credential)

Remove a credential from this user.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides SecurityUser::removeCredential() (Remove a credential from this user.)

Parameters:

mixed

$credential

Credential data.

[ Top ]

method setAuthenticated [line 219]

void setAuthenticated(
bool
$authenticated)

Set the authenticated status of this user.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides SecurityUser::setAuthenticated() (Set the authenticated status of this user.)

Parameters:

bool

$authenticated

A flag indicating the authenticated status of this user.

[ Top ]

method shutdown [line 245]

void shutdown(
)

Execute the shutdown procedure.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides User::shutdown() (Execute the shutdown procedure.)

[ Top ]

Class Constants

AUTH_NAMESPACE = 'org/mojavi/user/BasicSecurityUser/authenticated'

[line 33]

The namespace under which authenticated status will be stored.

[ Top ]

CREDENTIAL_NAMESPACE = 'org/mojavi/user/BasicSecurityUser/credentials'

[line 38]

The namespace under which credentials will be stored.

[ Top ]

Documentation generated on Tue, 21 Feb 2006 01:45:10 +0900 by phpDocumentor 1.3.0RC5