interface/modules/zend_modules/library/Zend/Authentication/Result.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Authentication;
  11
  12 class Result
  13 {
  14     /**
  15      * General Failure
  16      */
  17     const FAILURE                        =  0;
  18
  19     /**
  20      * Failure due to identity not being found.
  21      */
  22     const FAILURE_IDENTITY_NOT_FOUND     = -1;
  23
  24     /**
  25      * Failure due to identity being ambiguous.
  26      */
  27     const FAILURE_IDENTITY_AMBIGUOUS     = -2;
  28
  29     /**
  30      * Failure due to invalid credential being supplied.
  31      */
  32     const FAILURE_CREDENTIAL_INVALID     = -3;
  33
  34     /**
  35      * Failure due to uncategorized reasons.
  36      */
  37     const FAILURE_UNCATEGORIZED          = -4;
  38
  39     /**
  40      * Authentication success.
  41      */
  42     const SUCCESS                        =  1;
  43
  44     /**
  45      * Authentication result code
  46      *
  47      * @var int
  48      */
  49     protected $code;
  50
  51     /**
  52      * The identity used in the authentication attempt
  53      *
  54      * @var mixed
  55      */
  56     protected $identity;
  57
  58     /**
  59      * An array of string reasons why the authentication attempt was unsuccessful
  60      *
  61      * If authentication was successful, this should be an empty array.
  62      *
  63      * @var array
  64      */
  65     protected $messages;
  66
  67     /**
  68      * Sets the result code, identity, and failure messages
  69      *
  70      * @param  int     $code
  71      * @param  mixed   $identity
  72      * @param  array   $messages
  73      */
  74     public function __construct($code, $identity, array $messages = array())
  75     {
  76         $this->code     = (int) $code;
  77         $this->identity = $identity;
  78         $this->messages = $messages;
  79     }
  80
  81     /**
  82      * Returns whether the result represents a successful authentication attempt
  83      *
  84      * @return bool
  85      */
  86     public function isValid()
  87     {
  88         return ($this->code > 0) ? true : false;
  89     }
  90
  91     /**
  92      * getCode() - Get the result code for this authentication attempt
  93      *
  94      * @return int
  95      */
  96     public function getCode()
  97     {
  98         return $this->code;
  99     }
 100
 101     /**
 102      * Returns the identity used in the authentication attempt
 103      *
 104      * @return mixed
 105      */
 106     public function getIdentity()
 107     {
 108         return $this->identity;
 109     }
 110
 111     /**
 112      * Returns an array of string reasons why the authentication attempt was unsuccessful
 113      *
 114      * If authentication was successful, this method returns an empty array.
 115      *
 116      * @return array
 117      */
 118     public function getMessages()
 119     {
 120         return $this->messages;
 121     }
 122 }