From b031ade73ab78371fa7b3a1a685de483b950b045 Mon Sep 17 00:00:00 2001
From: Thomas Portelange <thomas@lekoala.be>
Date: Tue, 12 Mar 2024 22:08:56 +0100
Subject: [PATCH] ENH update some docblock types (#11168)

---
 src/Control/HTTPRequest.php      | 12 ++++++------
 src/Forms/FileUploadReceiver.php |  4 ++--
 src/Forms/Form.php               |  6 +++---
 src/ORM/DataList.php             |  2 +-
 4 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/Control/HTTPRequest.php b/src/Control/HTTPRequest.php
index 7dfb4721f..8cc1ab915 100644
--- a/src/Control/HTTPRequest.php
+++ b/src/Control/HTTPRequest.php
@@ -463,9 +463,9 @@ class HTTPRequest implements ArrayAccess
      * <code>$this->setResponse(HTTPRequest::send_file('the content', 'filename.txt'));</code>
      *
      * @static
-     * @param $fileData
-     * @param $fileName
-     * @param null $mimeType
+     * @param string $fileData
+     * @param string $fileName
+     * @param string|null $mimeType
      * @return HTTPResponse
      */
     public static function send_file($fileData, $fileName, $mimeType = null)
@@ -497,7 +497,7 @@ class HTTPRequest implements ArrayAccess
      * The pattern can optionally start with an HTTP method and a space.  For example, "POST $Controller/$Action".
      * This is used to define a rule that only matches on a specific HTTP method.
      *
-     * @param $pattern
+     * @param string $pattern
      * @param bool $shiftOnSuccess
      * @return array|bool
      */
@@ -679,7 +679,7 @@ class HTTPRequest implements ArrayAccess
     }
 
     /**
-     * @param $params
+     * @param array $params
      * @return HTTPRequest $this
      */
     public function setRouteParams($params)
@@ -805,7 +805,7 @@ class HTTPRequest implements ArrayAccess
      * Sets the client IP address which originated this request.
      * Use setIPFromHeaderValue if assigning from header value.
      *
-     * @param $ip string
+     * @param string $ip
      * @return $this
      */
     public function setIP($ip)
diff --git a/src/Forms/FileUploadReceiver.php b/src/Forms/FileUploadReceiver.php
index 02c0e839d..19ed57d23 100644
--- a/src/Forms/FileUploadReceiver.php
+++ b/src/Forms/FileUploadReceiver.php
@@ -46,7 +46,7 @@ trait FileUploadReceiver
     /**
      * Parent data record. Will be inferred from parent form or controller if blank.
      *
-     * @var DataObject
+     * @var ?DataObject
      */
     protected $record;
 
@@ -78,7 +78,7 @@ trait FileUploadReceiver
      * Get the record to use as "Parent" for uploaded Files (eg a Page with a has_one to File) If none is set, it will
      * use Form->getRecord() or Form->Controller()->data()
      *
-     * @return DataObject
+     * @return ?DataObject
      */
     public function getRecord()
     {
diff --git a/src/Forms/Form.php b/src/Forms/Form.php
index 96b9d1ee4..ccea1e787 100644
--- a/src/Forms/Form.php
+++ b/src/Forms/Form.php
@@ -371,7 +371,7 @@ class Form extends ViewableData implements HasRequestHandler
     /**
      * Helper to get current request for this form
      *
-     * @return HTTPRequest
+     * @return HTTPRequest|null
      */
     protected function getRequest()
     {
@@ -426,7 +426,7 @@ class Form extends ViewableData implements HasRequestHandler
     /**
      * Return any ValidationResult instance stored for this object
      *
-     * @return ValidationResult The ValidationResult object stored in the session
+     * @return ValidationResult|null The ValidationResult object stored in the session
      */
     public function getSessionValidationResult()
     {
@@ -1612,7 +1612,7 @@ class Form extends ViewableData implements HasRequestHandler
      * Return the default button that should be clicked when another one isn't
      * available.
      *
-     * @return FormAction
+     * @return FormAction|null
      */
     public function defaultAction()
     {
diff --git a/src/ORM/DataList.php b/src/ORM/DataList.php
index c7cfc745d..ef7d12bf7 100644
--- a/src/ORM/DataList.php
+++ b/src/ORM/DataList.php
@@ -350,7 +350,7 @@ class DataList extends ViewableData implements SS_List, Filterable, Sortable, Li
      *
      * Raw SQL is not accepted, only actual field names can be passed
      *
-     * @param string|array $args
+     * @param string|array|null $args
      * @example $list = $list->sort('Name'); // default ASC sorting
      * @example $list = $list->sort('"Name"'); // field names can have double quotes around them
      * @example $list = $list->sort('Name ASC, Age DESC');