YuCheng Hu
1ec191d88b
+YUCHENG HU+ git-svn-id: https://svn.code.sf.net/p/hawebs/svn@423 a2543c7e-f6e9-4f8a-8bff-1ffc34733512
79 lines
1.6 KiB
PHP
79 lines
1.6 KiB
PHP
<?php
|
|
/**
|
|
* Piwik - Open source web analytics
|
|
*
|
|
* @link http://piwik.org
|
|
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
|
|
* @version $Id: Auth.php 1434 2009-08-23 15:55:35Z vipsoft $
|
|
*
|
|
* @category Piwik
|
|
* @package Piwik
|
|
*/
|
|
|
|
/**
|
|
* Interface for authentication modules
|
|
*
|
|
* @package Piwik
|
|
* @subpackage Piwik_Auth
|
|
*/
|
|
interface Piwik_Auth {
|
|
/**
|
|
* Authentication module's name, e.g., "Login"
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getName();
|
|
|
|
/**
|
|
* @return Piwik_Auth_Result
|
|
*/
|
|
public function authenticate();
|
|
}
|
|
|
|
/**
|
|
* Authentication result
|
|
*
|
|
* @package Piwik
|
|
* @subpackage Piwik_Auth
|
|
* @see Zend_Auth_Result, libs/Zend/Auth/Result.php
|
|
* @link http://framework.zend.com/manual/en/zend.auth.html
|
|
*/
|
|
class Piwik_Auth_Result extends Zend_Auth_Result
|
|
{
|
|
/**
|
|
* token_auth parameter used to authenticate in the API
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $_token_auth = null;
|
|
|
|
const SUCCESS_SUPERUSER_AUTH_CODE = 42;
|
|
|
|
/**
|
|
* Constructor for Piwik_Auth_Result
|
|
*
|
|
* @param int $code
|
|
* @param string $login identity
|
|
* @param string $token_auth
|
|
* @param array $messages
|
|
*/
|
|
public function __construct($code, $login, $token_auth, array $messages = array())
|
|
{
|
|
// Piwik_Auth_Result::SUCCESS_SUPERUSER_AUTH_CODE, Piwik_Auth_Result::SUCCESS, Piwik_Auth_Result::FAILURE
|
|
$this->_code = (int)$code;
|
|
$this->_identity = $login;
|
|
$this->_messages = $messages;
|
|
$this->_token_auth = $token_auth;
|
|
}
|
|
|
|
/**
|
|
* Returns the token_auth to authenticate the current user in the API
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getTokenAuth()
|
|
{
|
|
return $this->_token_auth;
|
|
}
|
|
}
|