API Documentation

Auth/Result.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Auth
version
$Id: Result.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Auth_Result

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Auth_Result
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Auth
Constants
FAILURE
FAILURE_IDENTITY_NOT_FOUND
FAILURE_IDENTITY_AMBIGUOUS
FAILURE_CREDENTIAL_INVALID
FAILURE_UNCATEGORIZED
SUCCESS
Properties
$_code
$_identity
$_messages
Methods
__construct
isValid
getCode
getIdentity
getMessages

Description

Constants

FAILURE
jump to class

 FAILURE = '0'

General Failure

Details

value
0

FAILURE_IDENTITY_NOT_FOUND
jump to class

 FAILURE_IDENTITY_NOT_FOUND = '1'

Failure due to identity not being found.

Details

value
1

FAILURE_IDENTITY_AMBIGUOUS
jump to class

 FAILURE_IDENTITY_AMBIGUOUS = '2'

Failure due to identity being ambiguous.

Details

value
2

FAILURE_CREDENTIAL_INVALID
jump to class

 FAILURE_CREDENTIAL_INVALID = '3'

Failure due to invalid credential being supplied.

Details

value
3

FAILURE_UNCATEGORIZED
jump to class

 FAILURE_UNCATEGORIZED = '4'

Failure due to uncategorized reasons.

Details

value
4

SUCCESS
jump to class

 SUCCESS = '1'

Authentication success.

Details

value
1

Properties

$_code
jump to class

int $_code = ''

Authentication result code

Details

$_code
int
visibility
protected
default
final
false
static
false

$_identity
jump to class

mixed $_identity = ''

The identity used in the authentication attempt

Details

$_identity
mixed
visibility
protected
default
final
false
static
false

$_messages
jump to class

array $_messages = ''

An array of string reasons why the authentication attempt was unsuccessful

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

Details

$_messages
array
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

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

Sets the result code, identity, and failure messages

Arguments
$code
int
$identity
mixed
$messages
array
Details
visibility
public
final
false
static
false

getCode
jump to class

getCode( ) : int

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

Output
int
Details
visibility
public
final
false
static
false

getIdentity
jump to class

getIdentity( ) : mixed

Returns the identity used in the authentication attempt

Output
mixed
Details
visibility
public
final
false
static
false

getMessages
jump to class

getMessages( ) : array

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

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

Output
array
Details
visibility
public
final
false
static
false

isValid
jump to class

isValid( ) : boolean

Returns whether the result represents a successful authentication attempt

Output
boolean
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.