Auth/Result.php

Show:

inherited

Classes
- \Zend_Auth_Result

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Auth
Version: $Id$

\Zend_Auth_Result
jump to top

Package: Zend_Auth

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

Constants

 
                FAILURE
                = 0

General Failure

 
                FAILURE_IDENTITY_NOT_FOUND
                = -1

Failure due to identity not being found.

 
                FAILURE_IDENTITY_AMBIGUOUS
                = -2

Failure due to identity being ambiguous.

 
                FAILURE_CREDENTIAL_INVALID
                = -3

Failure due to invalid credential being supplied.

 
                FAILURE_UNCATEGORIZED
                = -4

Failure due to uncategorized reasons.

 
                SUCCESS
                = 1

Authentication success.

Properties

int $_code

Authentication result code

Details

Type: int

mixed $_identity

The identity used in the authentication attempt

Details

Type: mixed

array $_messages

An array of string reasons why the authentication attempt was unsuccessful

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

Details

Type: array

Methods

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

Sets the result code, identity, and failure messages

Parameters

Name	Type	Description
$code	int
$identity	mixed
$messages	array

getCode() : int

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

Returns

Type	Description
int

getIdentity() : mixed

Returns the identity used in the authentication attempt

Returns

Type	Description
mixed

getMessages() : array

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

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

Returns

Type	Description
array

isValid() : boolean

Returns whether the result represents a successful authentication attempt

Returns

Type	Description
boolean

Auth/Result.php

\Zend_Auth_Resultjump to top

Constants

Properties

Methods

\Zend_Auth_Result
jump to top