Skip to content

Commit 44f1deb

Browse files
committed
docs: add method docblocks
1 parent 6bbdf8d commit 44f1deb

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/Authentication/Authenticators/Session.php

+8
Original file line numberDiff line numberDiff line change
@@ -347,13 +347,21 @@ private function getActionTypes(): array
347347
return $types;
348348
}
349349

350+
/**
351+
* Checks if the user is currently in pending login state.
352+
* They need to do an auth action.
353+
*/
350354
public function isPending(): bool
351355
{
352356
$this->checkUserState();
353357

354358
return $this->userState === self::STATE_PENDING;
355359
}
356360

361+
/**
362+
* Checks if the visitor is anonymous. The user's id is unknown.
363+
* They are not logged in, are not in pending login state.
364+
*/
357365
public function isAnonymous(): bool
358366
{
359367
$this->checkUserState();

0 commit comments

Comments
 (0)