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