ENH Add generic types (#67)

silverstripe · Jan 18, 2024 · 8c847f5 · 8c847f5
1 parent 8b0c8f5
commit 8c847f5
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 1 deletion.
diff --git a/code/AuditHook.php b/code/AuditHook.php
@@ -2,6 +2,8 @@
 
 namespace SilverStripe\Auditor;
 
+use SilverStripe\CMS\Model\SiteTree;
+use SilverStripe\Control\Controller;
 use SilverStripe\Control\Email\Email;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\ORM\DataExtension;
@@ -16,6 +18,8 @@
 
 /**
  * Provides logging hooks that are inserted into Framework objects.
+ *
+ * @extends DataExtension<Member|SiteTree|Controller>
  */
 class AuditHook extends DataExtension
 {
@@ -38,7 +42,6 @@ public static function handle_manipulation($manipulation)
             return false;
         }
 
-        /** @var DataObjectSchema $schema */
         $schema = DataObject::getSchema();
 
         // The tables that we watch for manipulation on

diff --git a/code/AuditHookMFA.php b/code/AuditHookMFA.php
@@ -4,12 +4,16 @@
 
 use Psr\Log\LoggerInterface;
 use SilverStripe\Core\Injector\Injector;
+use SilverStripe\MFA\Authenticator\LoginHandler;
 use SilverStripe\MFA\Method\MethodInterface;
+use SilverStripe\MFA\Service\RegisteredMethodManager;
 use SilverStripe\ORM\DataExtension;
 use SilverStripe\Security\Member;
 
 /**
  * Provides logging actions on extension hooks from certain silverstripe/mfa actions.
+ *
+ * @extends DataExtension<LoginHandler|RegisteredMethodManager>
  */
 class AuditHookMFA extends DataExtension
 {

diff --git a/code/AuditHookManyManyList.php b/code/AuditHookManyManyList.php
@@ -3,6 +3,7 @@
 namespace SilverStripe\Auditor;
 
 use SilverStripe\Core\Injector\Injector;
+use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\ManyManyList;
 use SilverStripe\Security\Group;
 use SilverStripe\Security\Member;
@@ -11,6 +12,9 @@
 /**
  * AuditHookManyManyList is meant to override ManyManyList. When a Member is
  * removed from a Group, it logs the event.
+ *
+ * @template T of DataObject
+ * @extends ManyManyList<T>
  */
 class AuditHookManyManyList extends ManyManyList
 {

diff --git a/code/AuditHookSessionManager.php b/code/AuditHookSessionManager.php
@@ -6,10 +6,13 @@
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\ORM\DataExtension;
 use SilverStripe\Security\Security;
+use SilverStripe\SessionManager\Controllers\LoginSessionController;
 use SilverStripe\SessionManager\Models\LoginSession;
 
 /**
  * Provides logging actions on extension hooks from certain silverstripe/session-manager actions.
+ *
+ * @extends DataExtension<LoginSessionController>
  */
 class AuditHookSessionManager extends DataExtension
 {

diff --git a/code/Extensions/ProxyDBExtension.php b/code/Extensions/ProxyDBExtension.php
@@ -5,7 +5,11 @@
 use SilverStripe\Auditor\AuditHook;
 use SilverStripe\Core\Extension;
 use TractorCow\ClassProxy\Generators\ProxyGenerator;
+use TractorCow\SilverStripeProxyDB\ProxyDBFactory;
 
+/**
+ * @extends Extension<ProxyDBFactory>
+ */
 class ProxyDBExtension extends Extension
 {
     /**