API
3 years ago
Access
3 years ago
Application
4 years ago
Archive
3 years ago
ArchiveProcessor
3 years ago
Archiver
5 years ago
AssetManager
3 years ago
Auth
3 years ago
Category
5 years ago
Changes
4 years ago
CliMulti
4 years ago
Columns
3 years ago
Concurrency
3 years ago
Config
4 years ago
Container
4 years ago
CronArchive
3 years ago
DataAccess
3 years ago
DataFiles
5 years ago
DataTable
3 years ago
Db
3 years ago
DeviceDetector
3 years ago
Email
5 years ago
Exception
3 years ago
Http
4 years ago
Intl
4 years ago
Mail
3 years ago
Measurable
5 years ago
Menu
3 years ago
Metrics
4 years ago
Notification
4 years ago
Period
4 years ago
Plugin
3 years ago
ProfessionalServices
4 years ago
Report
5 years ago
ReportRenderer
3 years ago
Scheduler
4 years ago
Segment
3 years ago
Session
4 years ago
Settings
3 years ago
Tracker
3 years ago
Translation
4 years ago
UpdateCheck
5 years ago
Updater
3 years ago
Updates
3 years ago
Validators
4 years ago
View
4 years ago
ViewDataTable
3 years ago
Visualization
4 years ago
Widget
5 years ago
.htaccess
6 years ago
Access.php
4 years ago
Archive.php
4 years ago
ArchiveProcessor.php
4 years ago
AssetManager.php
4 years ago
Auth.php
5 years ago
AuthResult.php
5 years ago
BaseFactory.php
5 years ago
Cache.php
5 years ago
CacheId.php
5 years ago
CliMulti.php
4 years ago
Common.php
3 years ago
Config.php
3 years ago
Console.php
3 years ago
Context.php
5 years ago
Cookie.php
3 years ago
CronArchive.php
3 years ago
DataArray.php
4 years ago
DataTable.php
3 years ago
Date.php
4 years ago
Db.php
4 years ago
DbHelper.php
3 years ago
Development.php
5 years ago
ErrorHandler.php
5 years ago
EventDispatcher.php
3 years ago
ExceptionHandler.php
3 years ago
FileIntegrity.php
5 years ago
Filechecks.php
4 years ago
Filesystem.php
3 years ago
FrontController.php
3 years ago
Http.php
3 years ago
IP.php
4 years ago
Log.php
4 years ago
LogDeleter.php
4 years ago
Mail.php
4 years ago
Metrics.php
3 years ago
NoAccessException.php
5 years ago
Nonce.php
3 years ago
Notification.php
5 years ago
NumberFormatter.php
4 years ago
Option.php
4 years ago
Period.php
5 years ago
Piwik.php
3 years ago
Plugin.php
4 years ago
Profiler.php
4 years ago
ProxyHeaders.php
5 years ago
ProxyHttp.php
3 years ago
QuickForm2.php
5 years ago
RankingQuery.php
3 years ago
ReportRenderer.php
4 years ago
Segment.php
3 years ago
Sequence.php
5 years ago
Session.php
3 years ago
SettingsPiwik.php
3 years ago
SettingsServer.php
5 years ago
Singleton.php
5 years ago
Site.php
3 years ago
SiteContentDetector.php
3 years ago
SupportedBrowser.php
3 years ago
TCPDF.php
5 years ago
Theme.php
5 years ago
Timer.php
5 years ago
Tracker.php
4 years ago
Twig.php
4 years ago
Unzip.php
5 years ago
UpdateCheck.php
5 years ago
Updater.php
4 years ago
UpdaterErrorException.php
5 years ago
Updates.php
5 years ago
Url.php
3 years ago
UrlHelper.php
3 years ago
Version.php
3 years ago
View.php
3 years ago
bootstrap.php
3 years ago
dispatch.php
5 years ago
testMinimumPhpVersion.php
3 years ago
AuthResult.php
108 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Matomo - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | * |
| 8 | */ |
| 9 | namespace Piwik; |
| 10 | |
| 11 | /** |
| 12 | * Authentication result. This is what is returned by authentication attempts using {@link Auth} |
| 13 | * implementations. |
| 14 | * |
| 15 | * @api |
| 16 | */ |
| 17 | class AuthResult |
| 18 | { |
| 19 | const FAILURE = 0; |
| 20 | const SUCCESS = 1; |
| 21 | const SUCCESS_SUPERUSER_AUTH_CODE = 42; |
| 22 | |
| 23 | /** |
| 24 | * token_auth parameter used to authenticate in the API |
| 25 | * |
| 26 | * @var string |
| 27 | */ |
| 28 | protected $tokenAuth = null; |
| 29 | |
| 30 | /** |
| 31 | * The login used to authenticate. |
| 32 | * |
| 33 | * @var string |
| 34 | */ |
| 35 | protected $login = null; |
| 36 | |
| 37 | /** |
| 38 | * The authentication result code. Can be self::FAILURE, self::SUCCESS, or |
| 39 | * self::SUCCESS_SUPERUSER_AUTH_CODE. |
| 40 | * |
| 41 | * @var int |
| 42 | */ |
| 43 | protected $code = null; |
| 44 | |
| 45 | /** |
| 46 | * Constructor for AuthResult |
| 47 | * |
| 48 | * @param int $code |
| 49 | * @param string $login identity |
| 50 | * @param string $tokenAuth |
| 51 | */ |
| 52 | public function __construct($code, $login, $tokenAuth) |
| 53 | { |
| 54 | $this->code = (int)$code; |
| 55 | $this->login = $login; |
| 56 | $this->tokenAuth = $tokenAuth; |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * Returns the login used to authenticate. |
| 61 | * |
| 62 | * @return string |
| 63 | */ |
| 64 | public function getIdentity() |
| 65 | { |
| 66 | return $this->login; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Returns the token_auth to authenticate the current user in the API |
| 71 | * |
| 72 | * @return string |
| 73 | */ |
| 74 | public function getTokenAuth() |
| 75 | { |
| 76 | return $this->tokenAuth; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * Returns the authentication result code. |
| 81 | * |
| 82 | * @return int |
| 83 | */ |
| 84 | public function getCode() |
| 85 | { |
| 86 | return $this->code; |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Returns true if the user has Super User access, false otherwise. |
| 91 | * |
| 92 | * @return bool |
| 93 | */ |
| 94 | public function hasSuperUserAccess() |
| 95 | { |
| 96 | return $this->getCode() == self::SUCCESS_SUPERUSER_AUTH_CODE; |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Returns true if this result was successfully authentication. |
| 101 | * |
| 102 | * @return bool |
| 103 | */ |
| 104 | public function wasAuthenticationSuccessful() |
| 105 | { |
| 106 | return $this->code > self::FAILURE; |
| 107 | } |
| 108 | } |