Skip to content

Commit e3ef93a

Browse files
committed
Cleanup phpdoc
1 parent 31b37c8 commit e3ef93a

3 files changed

Lines changed: 2 additions & 28 deletions

File tree

src/Auth/Process/OTP.php

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,11 @@ class OTP extends Auth\ProcessingFilter
2323
{
2424
/**
2525
* The API client identifier.
26-
*
27-
* @var string
2826
*/
2927
private string $apiClient;
3028

3129
/**
3230
* The API key to use.
33-
*
34-
* @var string
3531
*/
3632
private string $apiKey;
3733

@@ -51,42 +47,32 @@ class OTP extends Auth\ProcessingFilter
5147

5248
/**
5349
* Whether to abort authentication if no yubikey is known for the user or not.
54-
*
55-
* @var bool
5650
*/
5751
private bool $abortIfMissing;
5852

5953
/**
6054
* The name of the attribute containing the yubikey ID.
6155
*
6256
* Defaults to "yubikey".
63-
*
64-
* @var string
6557
*/
6658
private string $keyIdAttr;
6759

6860
/**
6961
* The name of the attribute that expresses successful authentication with the yubikey.
7062
*
7163
* Defaults to "eduPersonAssurance".
72-
*
73-
* @var string
7464
*/
7565
private string $assuranceAttr;
7666

7767
/**
7868
* The value of the "assurance" attribute that conveys successful authentication with a yubikey.
7969
*
8070
* Defaults to "OTP".
81-
*
82-
* @var string
8371
*/
8472
private string $assuranceValue;
8573

8674
/**
8775
* The auth source associated with this authproc.
88-
*
89-
* @var string
9076
*/
9177
private string $authid;
9278

src/Controller/Yubikey.php

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,12 @@
2424
class Yubikey
2525
{
2626
/**
27-
* @var \SimpleSAML\Auth\State|string
28-
* @psalm-var \SimpleSAML\Auth\State|class-string
27+
* @var \SimpleSAML\Auth\State|class-string
2928
*/
3029
protected $authState = Auth\State::class;
3130

3231
/**
33-
* @var \SimpleSAML\Module\yubikey\Auth\Process\OTP|string
34-
* @psalm-var \SimpleSAML\Module\yubikey\Auth\Process\OTP|class-string
32+
* @var \SimpleSAML\Module\yubikey\Auth\Process\OTP|class-string
3533
*/
3634
protected $otp = OTP::class;
3735

tests/src/Controller/YubikeyTest.php

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ protected function setUp(): void
5353

5454
/**
5555
* Test that accessing the otp-endpoint without state results in an error-response
56-
*
57-
* @return void
5856
*/
5957
public function testOtpNoState(): void
6058
{
@@ -74,8 +72,6 @@ public function testOtpNoState(): void
7472

7573
/**
7674
* Test that accessing the otp-endpoint without otp results in a Template
77-
*
78-
* @return void
7975
*/
8076
public function testOtpNoOtp(): void
8177
{
@@ -101,8 +97,6 @@ public static function loadState(string $id, string $stage, bool $allowMissing =
10197

10298
/**
10399
* Test that accessing the otp-endpoint with invalid otp returns Template
104-
*
105-
* @return void
106100
*/
107101
public function testOtpFailed(): void
108102
{
@@ -134,8 +128,6 @@ public static function authenticate(array &$state, string $otp): bool
134128

135129
/**
136130
* Test that accessing the otp-endpoint with valid otp returns RunnableResponse
137-
*
138-
* @return void
139131
*/
140132
public function testOtpSucceeded(): void
141133
{
@@ -167,8 +159,6 @@ public static function authenticate(array &$state, string $otp): bool
167159

168160
/**
169161
* Test that accessing the otp-endpoint when an unexpected exception occurs returns a Template
170-
*
171-
* @return void
172162
*/
173163
public function testOtpUnexpectedException(): void
174164
{

0 commit comments

Comments
 (0)