blob: 5e58eca14782213b57124a908c6951f59787723e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @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();
/**
* Authenticates user
*
* @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;
}
}
|
