TASK: Update API docs from 9.0

neos · Sep 12, 2024 · 3a1c752 · 3a1c752
1 parent 28d7f3c
commit 3a1c752
Show file tree

Hide file tree

Showing 23 changed files with 137 additions and 704 deletions.
diff --git a/flow/9.0/Neos/Flow/Mvc.html b/flow/9.0/Neos/Flow/Mvc.html
@@ -133,15 +133,7 @@ <h2>Classes</h2>
                 <div class="col-md-6"><p>A View Configuration Manager</p></div>
             </div>
             </div>
-            <h2>Interfaces</h2>
-    <div class="container-fluid underlined">
-                    <div class="row">
-                <div class="col-md-6">
-                                            <em><a href="../../Neos/Flow/Mvc/RequestInterface.html"><abbr title="Neos\Flow\Mvc\RequestInterface">RequestInterface</abbr></a></em>
-                        </div>
-                <div class="col-md-6"><p>Contract for a dispatchable request.</p></div>
-            </div>
-            </div>
+
 
             <h2>Exceptions</h2>
     <div class="container-fluid underlined">

diff --git a/flow/9.0/Neos/Flow/Mvc/ActionRequest.html b/flow/9.0/Neos/Flow/Mvc/ActionRequest.html
diff --git a/flow/9.0/Neos/Flow/Mvc/Controller/AbstractController.html b/flow/9.0/Neos/Flow/Mvc/Controller/AbstractController.html
@@ -338,7 +338,7 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getControllerContext">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L143">at line 143</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L141">at line 141</a></div>
         <code>                    <a href="../../../../Neos/Flow/Mvc/Controller/ControllerContext.html"><abbr title="Neos\Flow\Mvc\Controller\ControllerContext">ControllerContext</abbr></a>
     <strong>getControllerContext</strong>()
         </code>
@@ -370,7 +370,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_addFlashMessage">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L163">at line 163</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L161">at line 161</a></div>
         <code>                    void
     <strong>addFlashMessage</strong>(string $messageBody, string $messageTitle = &#039;&#039;, string $severity = Error\Message::SEVERITY_OK, array $messageArguments = [], int $messageCode = null)
         </code>
@@ -452,7 +452,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_forward">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L204">at line 204</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L202">at line 202</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>forward</strong>(string $actionName, string $controllerName = null, string $packageKey = null, array $arguments = [])
         </code>
@@ -549,7 +549,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_forwardToRequest">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L246">at line 246</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L244">at line 244</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>forwardToRequest</strong>(<a href="../../../../Neos/Flow/Mvc/ActionRequest.html"><abbr title="Neos\Flow\Mvc\ActionRequest">ActionRequest</abbr></a> $request)
         </code>
@@ -611,7 +611,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_redirect">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L274">at line 274</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L272">at line 272</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>redirect</strong>(string $actionName, string|null $controllerName = null, string|null $packageKey = null, array $arguments = [], int $delay = 0, int $statusCode = 303, string $format = null)
         </code>
@@ -713,7 +713,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_redirectToRequest">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L307">at line 307</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L305">at line 305</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>redirectToRequest</strong>(<a href="../../../../Neos/Flow/Mvc/ActionRequest.html"><abbr title="Neos\Flow\Mvc\ActionRequest">ActionRequest</abbr></a> $request, int $delay = 0, int $statusCode = 303)
         </code>
@@ -793,7 +793,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_redirectToUri">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L326">at line 326</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L324">at line 324</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>redirectToUri</strong>(<abbr title="string|Psr\Http\Message\UriInterface">UriInterface</abbr> $uri, int $delay = 0, int $statusCode = 303)
         </code>
@@ -854,7 +854,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_throwStatus">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L356">at line 356</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L354">at line 354</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>throwStatus</strong>(int $statusCode, string $statusMessage = null, string $content = null)
         </code>
@@ -915,7 +915,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_mapRequestArgumentsToControllerArguments">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L382">at line 382</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L380">at line 380</a></div>
         <code>            protected        void
     <strong>mapRequestArgumentsToControllerArguments</strong>(<a href="../../../../Neos/Flow/Mvc/ActionRequest.html"><abbr title="Neos\Flow\Mvc\ActionRequest">ActionRequest</abbr></a> $request, <a href="../../../../Neos/Flow/Mvc/Controller/Arguments.html"><abbr title="Neos\Flow\Mvc\Controller\Arguments">Arguments</abbr></a> $arguments)
         </code>

diff --git a/flow/9.0/Neos/Flow/Mvc/Controller/ActionController.html b/flow/9.0/Neos/Flow/Mvc/Controller/ActionController.html
@@ -773,7 +773,7 @@ <h4>Parameters</h4>
                     <div class="method-item">
                     <h3 id="method_getControllerContext">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_getControllerContext">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L143">at line 143</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L141">at line 141</a></div>
         <code>                    <a href="../../../../Neos/Flow/Mvc/Controller/ControllerContext.html"><abbr title="Neos\Flow\Mvc\Controller\ControllerContext">ControllerContext</abbr></a>
     <strong>getControllerContext</strong>()
         </code>
@@ -806,7 +806,7 @@ <h4>Return Value</h4>
                     <div class="method-item">
                     <h3 id="method_addFlashMessage">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_addFlashMessage">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L163">at line 163</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L161">at line 161</a></div>
         <code>                    void
     <strong>addFlashMessage</strong>(string $messageBody, string $messageTitle = &#039;&#039;, string $severity = Error\Message::SEVERITY_OK, array $messageArguments = [], int $messageCode = null)
         </code>
@@ -889,7 +889,7 @@ <h4>See also</h4>
                     <div class="method-item">
                     <h3 id="method_forward">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_forward">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L204">at line 204</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L202">at line 202</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>forward</strong>(string $actionName, string $controllerName = null, string $packageKey = null, array $arguments = [])
         </code>
@@ -987,7 +987,7 @@ <h4>See also</h4>
                     <div class="method-item">
                     <h3 id="method_forwardToRequest">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_forwardToRequest">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L246">at line 246</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L244">at line 244</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>forwardToRequest</strong>(<a href="../../../../Neos/Flow/Mvc/ActionRequest.html"><abbr title="Neos\Flow\Mvc\ActionRequest">ActionRequest</abbr></a> $request)
         </code>
@@ -1050,7 +1050,7 @@ <h4>See also</h4>
                     <div class="method-item">
                     <h3 id="method_redirect">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_redirect">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L274">at line 274</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L272">at line 272</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>redirect</strong>(string $actionName, string|null $controllerName = null, string|null $packageKey = null, array $arguments = [], int $delay = 0, int $statusCode = 303, string $format = null)
         </code>
@@ -1153,7 +1153,7 @@ <h4>See also</h4>
                     <div class="method-item">
                     <h3 id="method_redirectToRequest">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_redirectToRequest">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L307">at line 307</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L305">at line 305</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>redirectToRequest</strong>(<a href="../../../../Neos/Flow/Mvc/ActionRequest.html"><abbr title="Neos\Flow\Mvc\ActionRequest">ActionRequest</abbr></a> $request, int $delay = 0, int $statusCode = 303)
         </code>
@@ -1234,7 +1234,7 @@ <h4>See also</h4>
                     <div class="method-item">
                     <h3 id="method_redirectToUri">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_redirectToUri">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L326">at line 326</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L324">at line 324</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>redirectToUri</strong>(<abbr title="string|Psr\Http\Message\UriInterface">UriInterface</abbr> $uri, int $delay = 0, int $statusCode = 303)
         </code>
@@ -1296,7 +1296,7 @@ <h4>Exceptions</h4>
                     <div class="method-item">
                     <h3 id="method_throwStatus">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_throwStatus">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L356">at line 356</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L354">at line 354</a></div>
         <code>            protected        <abbr title="Neos\Flow\Mvc\Controller\never">never</abbr>
     <strong>throwStatus</strong>(int $statusCode, string $statusMessage = null, string $content = null)
         </code>
@@ -1358,7 +1358,7 @@ <h4>Exceptions</h4>
                     <div class="method-item">
                     <h3 id="method_mapRequestArgumentsToControllerArguments">
         <div class="location">in <a href="../../../../Neos/Flow/Mvc/Controller/AbstractController.html#method_mapRequestArgumentsToControllerArguments">
-<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L382">at line 382</a></div>
+<abbr title="Neos\Flow\Mvc\Controller\AbstractController">AbstractController</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/AbstractController.php#L380">at line 380</a></div>
         <code>            protected        void
     <strong>mapRequestArgumentsToControllerArguments</strong>(<a href="../../../../Neos/Flow/Mvc/ActionRequest.html"><abbr title="Neos\Flow\Mvc\ActionRequest">ActionRequest</abbr></a> $request, <a href="../../../../Neos/Flow/Mvc/Controller/Arguments.html"><abbr title="Neos\Flow\Mvc\Controller\Arguments">Arguments</abbr></a> $arguments)
         </code>

diff --git a/flow/9.0/Neos/Flow/Mvc/Controller/ControllerInterface.html b/flow/9.0/Neos/Flow/Mvc/Controller/ControllerInterface.html
@@ -127,7 +127,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method_processRequest">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/ControllerInterface.php#L51">at line 51</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Mvc/Controller/ControllerInterface.php#L50">at line 50</a></div>
         <code>                    <abbr title="Psr\Http\Message\ResponseInterface">ResponseInterface</abbr>
     <strong>processRequest</strong>(<a href="../../../../Neos/Flow/Mvc/ActionRequest.html"><abbr title="Neos\Flow\Mvc\ActionRequest">ActionRequest</abbr></a> $request)
         </code>
@@ -140,16 +140,15 @@ <h3 id="method_processRequest">
                             <p><p>Processes a general request.</p></p>                <p><p>The contract to the MVC Dispatcher is as follows.</p>
 <ul>
 <li>
-<p>If a request can be handled it must be set to <code>dispatched</code> {<a href="../../../../Neos/Flow/Mvc/ActionRequest.html">\Neos\Flow\Mvc\ActionRequest::setDispatched()}
--</a> The repose should be returned directly.</p>
+<p>The response should be returned directly.</p>
 </li>
 <li>
 <p>For outer ordinary control flow a {\Neos\Flow\Mvc\Exception\StopActionException} with response attached
 can be thrown which will be handled by the Dispatcher accordingly.</p>
 </li>
 <li>
 <p>To forward the request to another controller, a {\Neos\Flow\Mvc\Exception\ForwardException} might be thrown
-wich the Dispatcher will catch and handle its attached next-request.</p>
+which the Dispatcher will catch and handle its attached next-request.</p>
 </li>
 </ul></p>        
         </div>