summaryrefslogtreecommitdiff
path: root/applications/core/lib/Zend/Auth/Result.php
diff options
Diffstat (limited to 'applications/core/lib/Zend/Auth/Result.php')
-rw-r--r--applications/core/lib/Zend/Auth/Result.php148
1 files changed, 148 insertions, 0 deletions
diff --git a/applications/core/lib/Zend/Auth/Result.php b/applications/core/lib/Zend/Auth/Result.php
new file mode 100644
index 0000000..a6c4ca4
--- /dev/null
+++ b/applications/core/lib/Zend/Auth/Result.php
@@ -0,0 +1,148 @@
+<?php
+/**
+ * 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 [email protected] so we can send you a copy immediately.
+ *
+ * @category Zend
+ * @package Zend_Auth
+ * @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license http://framework.zend.com/license/new-bsd New BSD License
+ * @version $Id: Result.php 8862 2008-03-16 15:36:00Z thomas $
+ */
+
+
+/**
+ * @category Zend
+ * @package Zend_Auth
+ * @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license http://framework.zend.com/license/new-bsd New BSD License
+ */
+class Zend_Auth_Result
+{
+ /**
+ * General Failure
+ */
+ const FAILURE = 0;
+
+ /**
+ * Failure due to identity not being found.
+ */
+ const FAILURE_IDENTITY_NOT_FOUND = -1;
+
+ /**
+ * Failure due to identity being ambiguous.
+ */
+ const FAILURE_IDENTITY_AMBIGUOUS = -2;
+
+ /**
+ * Failure due to invalid credential being supplied.
+ */
+ const FAILURE_CREDENTIAL_INVALID = -3;
+
+ /**
+ * Failure due to uncategorized reasons.
+ */
+ const FAILURE_UNCATEGORIZED = -4;
+
+ /**
+ * Authentication success.
+ */
+ const SUCCESS = 1;
+
+ /**
+ * Authentication result code
+ *
+ * @var int
+ */
+ protected $_code;
+
+ /**
+ * The identity used in the authentication attempt
+ *
+ * @var mixed
+ */
+ protected $_identity;
+
+ /**
+ * An array of string reasons why the authentication attempt was unsuccessful
+ *
+ * If authentication was successful, this should be an empty array.
+ *
+ * @var array
+ */
+ protected $_messages;
+
+ /**
+ * Sets the result code, identity, and failure messages
+ *
+ * @param int $code
+ * @param mixed $identity
+ * @param array $messages
+ * @return void
+ */
+ public function __construct($code, $identity, array $messages = array())
+ {
+ $code = (int) $code;
+
+ if ($code < self::FAILURE_UNCATEGORIZED) {
+ $code = self::FAILURE;
+ } elseif ($code > self::SUCCESS ) {
+ $code = 1;
+ }
+
+ $this->_code = $code;
+ $this->_identity = $identity;
+ $this->_messages = $messages;
+ }
+
+ /**
+ * Returns whether the result represents a successful authentication attempt
+ *
+ * @return boolean
+ */
+ public function isValid()
+ {
+ return ($this->_code > 0) ? true : false;
+ }
+
+ /**
+ * getCode() - Get the result code for this authentication attempt
+ *
+ * @return int
+ */
+ public function getCode()
+ {
+ return $this->_code;
+ }
+
+ /**
+ * Returns the identity used in the authentication attempt
+ *
+ * @return mixed
+ */
+ public function getIdentity()
+ {
+ return $this->_identity;
+ }
+
+ /**
+ * Returns an array of string reasons why the authentication attempt was unsuccessful
+ *
+ * If authentication was successful, this method returns an empty array.
+ *
+ * @return array
+ */
+ public function getMessages()
+ {
+ return $this->_messages;
+ }
+}