Class: SecurityUser

Source Location: /user/SecurityUser.class.php

Class Overview

ParameterHolder
   |
   --User
      |
      --SecurityUser

SecurityUser provides advanced security manipulation methods.

Author(s):

Sean Kerr (skerr@mojavi.org)

Version:

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

Copyright:

Methods

Child classes:

BasicSecurityUser: BasicSecurityUser will handle any type of data as a credential.

Inherited Constants

Class: User

User::ATTRIBUTE_NAMESPACE

Inherited Variables

Class: ParameterHolder

ParameterHolder::$parameters

Inherited Methods

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]
SecurityUser provides advanced security manipulation methods.

Tags:

abstract:
version:	$Id: SecurityUser.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 Methods

method addCredential [line 40]

void addCredential(
mixed
$credential)

Add a credential to this user.

Tags:

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

Overridden in child classes as:

BasicSecurityUser::addCredential(): Add a credential to this user.

Parameters:

mixed

$credential

Credential data.

[ Top ]

method clearCredentials [line 52]

void clearCredentials(
)

Clear all credentials associated with this user.

Tags:

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

Overridden in child classes as:

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

[ Top ]

method hasCredential [line 66]

bool hasCredential(
mixed
$credential)

Indicates whether or not this user has a credential.

Tags:

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

Overridden in child classes as:

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

Parameters:

mixed

$credential

Credential data.

[ Top ]

method isAuthenticated [line 78]

bool isAuthenticated(
)

Indicates whether or not this user is authenticated.

Tags:

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

Overridden in child classes as:

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

[ Top ]

method removeCredential [line 92]

void removeCredential(
mixed
$credential)

Remove a credential from this user.

Tags:

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

Overridden in child classes as:

BasicSecurityUser::removeCredential(): Remove a credential from this user.

Parameters:

mixed

$credential

Credential data.

[ Top ]

method setAuthenticated [line 106]

void setAuthenticated(
bool
$authenticated)

Set the authenticated status of this user.

Tags:

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

Overridden in child classes as:

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

Parameters:

bool

$authenticated

A flag indicating the authenticated status of this user.

[ Top ]

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