ENH Add generic types (#95)

silverstripe · Jan 17, 2024 · 93f6715 · 93f6715
1 parent 67e0e1c
commit 93f6715
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/src/ErrorPage.php b/src/ErrorPage.php
@@ -110,7 +110,6 @@ public function canAddChildren($member = null)
     public static function response_for($statusCode, $errorMessage = null)
     {
         // first attempt to dynamically generate the error page
-        /** @var ErrorPage $errorPage */
         $errorPage = ErrorPage::get()
             ->filter([
                 "ErrorCode" => $statusCode
@@ -185,7 +184,6 @@ protected function requireDefaultRecordFixture($defaultData)
     {
         $code = $defaultData['ErrorCode'];
 
-        /** @var ErrorPage $page */
         $page = ErrorPage::get()->find('ErrorCode', $code);
         if (!$page) {
             $page = static::create();

diff --git a/src/ErrorPageController.php b/src/ErrorPageController.php
@@ -8,6 +8,8 @@
 
 /**
  * Controller for ErrorPages.
+ *
+ * @extends PageController<ErrorPage>
  */
 class ErrorPageController extends PageController
 {
@@ -30,7 +32,6 @@ protected function init()
      */
     public function handleRequest(HTTPRequest $request): HTTPResponse
     {
-        /** @var ErrorPage $page */
         $page = $this->data();
         $response = parent::handleRequest($request);
         $response->setStatusCode($page->ErrorCode);

diff --git a/src/ErrorPageControllerExtension.php b/src/ErrorPageControllerExtension.php
@@ -9,13 +9,15 @@
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Control\HTTPResponse_Exception;
 use SilverStripe\Core\Extension;
+use SilverStripe\Forms\Form;
 
 /**
  * Enhances error handling for a controller with ErrorPage generated output
+ *
+ * @extends Extension<Controller|Form>
  */
 class ErrorPageControllerExtension extends Extension
 {
-
     /**
      * Used by {@see RequestHandler::httpError}
      *

diff --git a/src/ErrorPageFileExtension.php b/src/ErrorPageFileExtension.php
@@ -2,15 +2,17 @@
 
 namespace SilverStripe\ErrorPage;
 
+use SilverStripe\Assets\Shortcodes\FileShortcodeProvider;
 use SilverStripe\ORM\DataExtension;
 use SilverStripe\ORM\DataObject;
 
 /**
  * Decorates {@see File} with ErrorPage support
+ *
+ * @extends DataExtension<FileShortcodeProvider>
  */
 class ErrorPageFileExtension extends DataExtension
 {
-
     /**
      * Used by {@see File::handle_shortcode}
      *