Docs For Class Zend_Auth

Description

copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Auth/Result.php (line 30)

Class Constant Summary

FAILURE = 0

FAILURE_CREDENTIAL_INVALID = -3

FAILURE_IDENTITY_AMBIGUOUS = -2

FAILURE_IDENTITY_NOT_FOUND = -1

FAILURE_UNCATEGORIZED = -4

SUCCESS = 1

Variable Summary

int $_code

mixed $_identity

array $_messages

Method Summary

void __construct (int $code, mixed $identity, [ $messages = array()])

int getCode ()

mixed getIdentity ()

array getMessages ()

boolean isValid ()

Variables

int $_code (line 67)

Authentication result code

access: protected

mixed $_identity (line 74)

The identity used in the authentication attempt

access: protected

array $_messages (line 83)

An array of string reasons why the authentication attempt was unsuccessful

If authentication was successful, this should be an empty array.

access: protected

Methods

Constructor __construct (line 93)

Sets the result code, identity, and failure messages

access: public

void __construct (int $code, mixed $identity, [ $messages = array()])

int $code
mixed $identity
array $messages

getCode (line 123)

getCode() - Get the result code for this authentication attempt

access: public

int getCode ()

getIdentity (line 133)

Returns the identity used in the authentication attempt

access: public

mixed getIdentity ()

getMessages (line 145)

Returns an array of string reasons why the authentication attempt was unsuccessful

If authentication was successful, this method returns an empty array.

access: public

array getMessages ()

isValid (line 113)

Returns whether the result represents a successful authentication attempt

access: public

boolean isValid ()

Class Constants

FAILURE = 0 (line 35)

General Failure

FAILURE_CREDENTIAL_INVALID = -3 (line 50)

Failure due to invalid credential being supplied.

FAILURE_IDENTITY_AMBIGUOUS = -2 (line 45)

Failure due to identity being ambiguous.

FAILURE_IDENTITY_NOT_FOUND = -1 (line 40)

Failure due to identity not being found.

FAILURE_UNCATEGORIZED = -4 (line 55)

Failure due to uncategorized reasons.

SUCCESS = 1 (line 60)

Authentication success.

Zend_Auth_Result