ENH Add generic types (#177)

silverstripe · Jan 18, 2024 · 94c0603 · 94c0603
1 parent c1c6be9
commit 94c0603
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 4 deletions.
diff --git a/src/Extensions/MemberExtension.php b/src/Extensions/MemberExtension.php
@@ -10,7 +10,10 @@
 
 /**
  * Augment `Member` to allow relationship to the LoginSession DataObject
+ *
  * @method SilverStripe\ORM\HasManyList<LoginSession> LoginSessions()
+ *
+ * @extends DataExtension<Member>
  */
 class MemberExtension extends DataExtension
 {

diff --git a/src/Extensions/QueuedJobDescriptorExtension.php b/src/Extensions/QueuedJobDescriptorExtension.php
@@ -4,7 +4,11 @@
 
 use SilverStripe\Core\Extension;
 use SilverStripe\SessionManager\Jobs\GarbageCollectionJob;
+use Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor;
 
+/**
+ * @extends Extension<QueuedJobDescriptor>
+ */
 class QueuedJobDescriptorExtension extends Extension
 {
     /**

diff --git a/src/Extensions/RememberLoginHashExtension.php b/src/Extensions/RememberLoginHashExtension.php
@@ -5,11 +5,14 @@
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Core\Extension;
 use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Security\RememberLoginHash;
 use SilverStripe\SessionManager\Models\LoginSession;
 use SilverStripe\SessionManager\Security\LogInAuthenticationHandler;
 
 /**
  * @method LoginSession LoginSession()
+ *
+ * @extends Extension<RememberLoginHash>
  */
 class RememberLoginHashExtension extends Extension
 {

diff --git a/src/FormFields/SessionManagerField.php b/src/FormFields/SessionManagerField.php
@@ -102,7 +102,6 @@ public function getSchemaDataDefaults()
         if (!$this->value && $this->getForm() && $this->getForm()->getRecord() instanceof Member) {
             $member = $this->getForm()->getRecord();
         } else {
-            /** @var Member $member */
             $member = DataObject::get_by_id(Member::class, $this->value);
         }
 
@@ -122,7 +121,6 @@ protected function getLoginSessions(Member $member)
         $logOutEndpoint = LoginSessionController::singleton()->Link();
 
         $loginSessions = [];
-        /** @var LoginSession $loginSession */
         foreach (LoginSession::getCurrentSessions($member) as $loginSession) {
             if (!$loginSession->canView()) {
                 continue;

diff --git a/src/Middleware/LoginSessionMiddleware.php b/src/Middleware/LoginSessionMiddleware.php
@@ -32,7 +32,6 @@ public function process(HTTPRequest $request, callable $delegate)
 
         try {
             $loginSessionID = $request->getSession()->get($loginHandler->getSessionVariable());
-            /** @var LoginSession $loginSession */
             $loginSession = LoginSession::get_by_id($loginSessionID);
 
             // If the session has already been revoked, or we've got a mismatched

diff --git a/src/Models/LoginSession.php b/src/Models/LoginSession.php
@@ -292,7 +292,7 @@ public function isCurrent(?HTTPRequest $request = null): bool
 
     /**
      * @param Member $member
-     * @return DataList|LoginSession[]
+     * @return DataList<LoginSession>
      */
     public static function getCurrentSessions(Member $member)
     {