ENH Add generic types (#524)

src/Authenticator/LoginHandler.php

@@ -289,7 +289,6 @@ public function finishRegistration(HTTPRequest $request): HTTPResponse
         }
 
         // If we've completed registration and the member is not already logged in then we need to log them in
-        /** @var EnforcementManager $enforcementManager */
         $enforcementManager = EnforcementManager::create();
         $mustLogin = $request->getSession()->get(static::SESSION_KEY . '.mustLogin');
 
@@ -457,7 +456,6 @@ public function redirectAfterSuccessfulLogin(): HTTPResponse
         }
 
         $request = $this->getRequest();
-        /** @var EnforcementManager $enforcementManager */
         $enforcementManager = EnforcementManager::create();
 
         // Assert that the member has a valid registration.
@@ -469,7 +467,6 @@ public function redirectAfterSuccessfulLogin(): HTTPResponse
             && !$enforcementManager->hasCompletedRegistration($member)
         ) {
             // Log them out again
-            /** @var IdentityStore $identityStore */
             $identityStore = Injector::inst()->get(IdentityStore::class);
             $identityStore->logOut($request);
 

src/BackupCode/RegisterHandler.php

@@ -54,10 +54,8 @@ public function start(StoreInterface $store): array
         // Create or update the RegisteredMethod on the member. This breaks the normal flow as it's created on "start"
         // instead of after receiving a response from the user
 
-        /** @var MethodInterface $method */
         $method = Injector::inst()->get(Method::class);
 
-        /** @var BackupCodeGeneratorInterface $generator */
         $generator = Injector::inst()->get(BackupCodeGeneratorInterface::class);
         $codes = $generator->generate();
 

src/Extension/AccountReset/MFAResetExtension.php

@@ -13,7 +13,7 @@
  * resets the 'MFA Skipped' flag on the member so that they are prompted to
  * set up MFA again when they next log in.
  *
- * @package SilverStripe\MFA\Extension\AccountReset
+ * @extends Extension<SecurityExtension>
  */
 class MFAResetExtension extends Extension
 {

src/Extension/AccountReset/MemberExtension.php

@@ -14,10 +14,10 @@
 /**
  * Provides DB columns / methods for account resets on Members
  *
- * @package SilverStripe\MFA\Extension
- * @property Member&MemberExtension $owner
  * @property string $AccountResetHash
  * @property DBDatetime $AccountResetExpired
+ *
+ * @extends DataExtension<Member&static>
  */
 class MemberExtension extends DataExtension
 {

src/Extension/AccountReset/SecurityAdminExtension.php

@@ -23,8 +23,7 @@
  * This extension is applied to SecurityAdmin to provide an additional endpoint
  * for sending account reset requests.
  *
- * @package SilverStripe\MFA\Extension
- * @property SecurityAdmin $owner
+ * @extends Extension<SecurityAdmin>
  */
 class SecurityAdminExtension extends Extension
 {
@@ -84,7 +83,6 @@ public function reset(HTTPRequest $request): HTTPResponse
             );
         }
 
-        /** @var Member $memberToReset */
         $memberToReset = Member::get()->byID($request->param('ID'));
 
         if ($memberToReset === null) {

src/Extension/AccountReset/SecurityExtension.php

@@ -25,8 +25,7 @@
  * itself be extended to add procedures to the reset action (such as removing
  * additional authentication factors, sending alerts, etc.)
  *
- * @package SilverStripe\MFA\Extension
- * @property Security $owner
+ * @extends Extension<Security>
  */
 class SecurityExtension extends Extension
 {

src/Extension/MemberExtension.php

@@ -24,8 +24,9 @@
  * @property MethodInterface $DefaultRegisteredMethod
  * @property string $DefaultRegisteredMethodID
  * @property bool $HasSkippedMFARegistration
- * @property Member|MemberExtension $owner
  * @method HasManyList<RegisteredMethod> RegisteredMFAMethods()
+ *
+ * @extends DataExtension<Member&static>
  */
 class MemberExtension extends DataExtension implements PermissionProvider
 {

src/Extension/RequirementsExtension.php

@@ -6,6 +6,9 @@
 use SilverStripe\Core\Extension;
 use SilverStripe\MFA\RequestHandler\BaseHandlerTrait;
 
+/**
+ * @extends Extension<LeftAndMain>
+ */
 class RequirementsExtension extends Extension
 {
     use BaseHandlerTrait;

src/Extension/SiteConfigExtension.php

@@ -9,13 +9,16 @@
 use SilverStripe\Forms\OptionsetField;
 use SilverStripe\ORM\DataExtension;
 use SilverStripe\ORM\FieldType\DBField;
+use SilverStripe\SiteConfig\SiteConfig;
 use SilverStripe\View\Requirements;
 
 /**
  * Adds multi-factor authentication related settings to the SiteConfig "Access" tab
  *
  * @property bool $MFARequired
  * @property string $MFAGracePeriodExpires
+ *
+ * @extends DataExtension<SiteConfig>
  */
 class SiteConfigExtension extends DataExtension
 {

src/FormField/RegisteredMFAMethodListField.php

@@ -46,7 +46,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);
         }
 

src/Report/EnabledMembers.php

@@ -31,7 +31,7 @@ class EnabledMembers extends Report
      * Cached registered methods fetched for the current list of members. This should only be populated at render time
      * as methods will be fetched for the current "records" on the report
      *
-     * @var DataList|null
+     * @var ArrayList<RegisteredMethod>|null
      */
     private $registeredMethods = null;
 
@@ -49,7 +49,7 @@ public function description(): string
      * Supplies the list displayed in the report
      *
      * @param array $params
-     * @return DataList
+     * @return DataList<Member>
      */
     public function sourceRecords($params): DataList
     {
@@ -161,7 +161,7 @@ protected function getMethodClassToTitleMapping(): array
     }
 
     /**
-     * @return ArrayList
+     * @return ArrayList<RegisteredMethod>
      */
     protected function getRegisteredMethodsForRecords(): ArrayList
     {

src/Service/RegisteredMethodManager.php

@@ -161,7 +161,6 @@ public function deleteFromMember(Member $member, MethodInterface $method): bool
         $remainingMethods = $member->RegisteredMFAMethods()->count();
         if ($remainingMethods === 2) {
             // If there is only one other method (other than backup codes) then set that as the default method
-            /** @var RegisteredMethod|null $remainingMethodExceptBackup */
             $remainingMethodExceptBackup = $member->RegisteredMFAMethods()
                 ->filter('MethodClassName:Not', $backupMethod)
                 ->first();