Class Zend_Auth_Result

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

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


	
			
Class Constant Summary
Variable Summary
 const $_code
 mixed $_identity
 array $_messages
Method Summary
 void __construct ( $code, mixed $identity, [ $messages = array()], boolean $resultCode)
 int|const getCode ()
 mixed getIdentity ()
 array getMessages ()
 boolean isValid ()
Variables
const $_code (line 67)

Whether the result represents a successful authentication attempt

  • 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)
  • todo:
  • access: public
void __construct ( $code, mixed $identity, [ $messages = array()], boolean $resultCode)
  • boolean $resultCode
  • mixed $identity
  • array $messages
  • $code
getCode (line 123)

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

  • access: public
int|const 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_IDENTITY_NOT_FOUND = -1 (line 40)

Failure due to identity not being found.

FAILURE_IDENTITY_TOO_AMBIGIOUS = -2 (line 45)

Failure due to identity being too ambigious.

FAILURE_INVALID_CREDENTIAL = -3 (line 50)

Failure due to invalid credential being supplied.

FAILURE_UNCATEGORIZED = -4 (line 55)

Failure due to uncategorized reasons.

SUCCESS = 1 (line 60)

Authentication success.

Documentation generated on Sun, 27 May 2007 23:29:36 -0700 by phpDocumentor 1.3.2