TASK: Update API docs from 9.0

neos · Jul 5, 2024 · 86372d7 · 86372d7
1 parent 402b92b
commit 86372d7
Show file tree

Hide file tree

Showing 11 changed files with 113 additions and 52 deletions.
diff --git a/flow/9.0/Neos/Flow/Command/DatabaseCommandController.html b/flow/9.0/Neos/Flow/Command/DatabaseCommandController.html
@@ -1143,7 +1143,7 @@ <h4>Exceptions</h4>
 
                     <table class="table table-condensed">
                     <tr>
-                <td><abbr title="Doctrine\DBAL\DBALException">DBALException</abbr></td>
+                <td><abbr title="Doctrine\DBAL\Exception">Exception</abbr></td>
                 <td></td>
             </tr>
             </table>
@@ -1225,7 +1225,7 @@ <h4>Exceptions</h4>
                 <td></td>
             </tr>
                     <tr>
-                <td><abbr title="Doctrine\DBAL\DBALException">DBALException</abbr></td>
+                <td><abbr title="Doctrine\DBAL\Exception">Exception</abbr></td>
                 <td></td>
             </tr>
                     <tr>
@@ -1290,7 +1290,7 @@ <h4>Exceptions</h4>
                 <td></td>
             </tr>
                     <tr>
-                <td><abbr title="Doctrine\DBAL\DBALException">DBALException</abbr></td>
+                <td><abbr title="Doctrine\DBAL\Exception">Exception</abbr></td>
                 <td></td>
             </tr>
             </table>

diff --git a/flow/9.0/Neos/Flow/Command/DoctrineCommandController.html b/flow/9.0/Neos/Flow/Command/DoctrineCommandController.html
@@ -1275,7 +1275,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_injectSettings">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L74">at line 74</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L75">at line 75</a></div>
         <code>                    void
     <strong>injectSettings</strong>(array $settings)
         </code>
@@ -1317,7 +1317,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_injectLogger">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L82">at line 82</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L83">at line 83</a></div>
         <code>                    void
     <strong>injectLogger</strong>(<abbr title="Psr\Log\LoggerInterface">LoggerInterface</abbr> $logger)
         </code>
@@ -1360,7 +1360,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_compileProxiesCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L95">at line 95</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L96">at line 96</a></div>
         <code>                    void
     <strong>compileProxiesCommand</strong>()
         </code>
@@ -1405,7 +1405,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_validateCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L114">at line 114</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L115">at line 115</a></div>
         <code>                    void
     <strong>validateCommand</strong>()
         </code>
@@ -1461,7 +1461,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_createCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L147">at line 147</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L148">at line 148</a></div>
         <code>                    void
     <strong>createCommand</strong>(string $output = null)
         </code>
@@ -1535,7 +1535,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_updateCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L176">at line 176</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L177">at line 177</a></div>
         <code>                    void
     <strong>updateCommand</strong>(bool $unsafeMode = false, string $output = null)
         </code>
@@ -1609,7 +1609,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_entityStatusCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L205">at line 205</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L206">at line 206</a></div>
         <code>                    void
     <strong>entityStatusCommand</strong>(bool $dumpMappingData = false, string $entityClassName = null)
         </code>
@@ -1678,7 +1678,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_dqlCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L258">at line 258</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L259">at line 259</a></div>
         <code>                    void
     <strong>dqlCommand</strong>(int $depth = 3, string $hydrationMode = &#039;array&#039;, int $offset = null, int $limit = null)
         </code>
@@ -1745,7 +1745,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_migrationStatusCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L292">at line 292</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L293">at line 293</a></div>
         <code>                    void
     <strong>migrationStatusCommand</strong>(bool $showMigrations = false)
         </code>
@@ -1788,7 +1788,7 @@ <h4>Exceptions</h4>
                 <td></td>
             </tr>
                     <tr>
-                <td><abbr title="Doctrine\DBAL\DBALException">DBALException</abbr></td>
+                <td><abbr title="Doctrine\DBAL\Exception">Exception</abbr></td>
                 <td></td>
             </tr>
             </table>
@@ -1830,7 +1830,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_migrateCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L319">at line 319</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L320">at line 320</a></div>
         <code>                    void
     <strong>migrateCommand</strong>(string $version = &#039;latest&#039;, string $output = null, bool $dryRun = false, bool $quiet = false)
         </code>
@@ -1926,7 +1926,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_emitAfterDatabaseMigration">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L346">at line 346</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L347">at line 347</a></div>
         <code>            protected        void
     <strong>emitAfterDatabaseMigration</strong>()
         </code>
@@ -1959,7 +1959,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_migrationExecuteCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L366">at line 366</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L367">at line 367</a></div>
         <code>                    void
     <strong>migrationExecuteCommand</strong>(string $version, string $direction = &#039;up&#039;, string $output = null, bool $dryRun = false)
         </code>
@@ -2054,7 +2054,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_migrationVersionCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L401">at line 401</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L402">at line 402</a></div>
         <code>                    void
     <strong>migrationVersionCommand</strong>(string $version, bool $add = false, bool $delete = false)
         </code>
@@ -2149,7 +2149,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_migrationGenerateCommand">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L451">at line 451</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L452">at line 452</a></div>
         <code>                    void
     <strong>migrationGenerateCommand</strong>(bool $diffAgainstCurrent = true, string $filterExpression = null, bool $force = false)
         </code>
@@ -2206,7 +2206,7 @@ <h4>Exceptions</h4>
 
                     <table class="table table-condensed">
                     <tr>
-                <td><abbr title="Doctrine\DBAL\DBALException">DBALException</abbr></td>
+                <td><abbr title="Doctrine\DBAL\Exception">Exception</abbr></td>
                 <td></td>
             </tr>
                     <tr>
@@ -2256,7 +2256,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_handleException">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L522">at line 522</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L523">at line 523</a></div>
         <code>            protected        void
     <strong>handleException</strong>(<a target="_blank" rel="noopener" href="https://www.php.net/Exception">Exception</a> $exception)
         </code>
@@ -2307,7 +2307,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_isDatabaseConfigured">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L533">at line 533</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Command/DoctrineCommandController.php#L534">at line 534</a></div>
         <code>            protected        bool
     <strong>isDatabaseConfigured</strong>()
         </code>

diff --git a/flow/9.0/Neos/Flow/Persistence/Doctrine.html b/flow/9.0/Neos/Flow/Persistence/Doctrine.html
@@ -106,7 +106,7 @@ <h2>Classes</h2>
             </div>
                     <div class="row">
                 <div class="col-md-6">
-                    <a href="../../../Neos/Flow/Persistence/Doctrine/CacheAdapter.html"><abbr title="Neos\Flow\Persistence\Doctrine\CacheAdapter">CacheAdapter</abbr></a>    </div>
+                    <a href="../../../Neos/Flow/Persistence/Doctrine/CacheAdapter.html"><abbr title="Neos\Flow\Persistence\Doctrine\CacheAdapter">CacheAdapter</abbr></a>    <small><span class="label label-danger">deprecated</span></small></div>
                 <div class="col-md-6"><p>Cache adapter to use Flow caches as Doctrine cache</p></div>
             </div>
                     <div class="row">

diff --git a/flow/9.0/Neos/Flow/Persistence/Doctrine/AllowedObjectsListener.html b/flow/9.0/Neos/Flow/Persistence/Doctrine/AllowedObjectsListener.html
@@ -159,6 +159,16 @@ <h2>Methods</h2>
                                             <p><p>Doctrine onFlush listener that checks for only allowed objects and reconnects
 if the database connection was closed.</p></p>                </div>
                 <div class="col-md-2"></div>
+            </div>
+                    <div class="row">
+                <div class="col-md-2 type">
+                    bool
+                </div>
+                <div class="col-md-8">
+                    <a href="#method_ping">ping</a>(<abbr title="Doctrine\DBAL\Connection">Connection</abbr> $connection)
+
+                                            <p><p>Execute a dummy query on the given connection and return false if the connection is not open</p></p>                </div>
+                <div class="col-md-2"></div>
             </div>
                     <div class="row">
                 <div class="col-md-2 type">
@@ -178,7 +188,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method_onFlush">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/AllowedObjectsListener.php#L69">at line 69</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/AllowedObjectsListener.php#L70">at line 70</a></div>
         <code>                    
     <strong>onFlush</strong>(<abbr title="Doctrine\ORM\Event\OnFlushEventArgs">OnFlushEventArgs</abbr> $args)
         </code>
@@ -215,13 +225,55 @@ <h4>Exceptions</h4>
 
 
 
+                    </div>
+    </div>
+
+            </div>
+                    <div class="method-item">
+                    <h3 id="method_ping">
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/AllowedObjectsListener.php#L106">at line 106</a></div>
+        <code>            protected        bool
+    <strong>ping</strong>(<abbr title="Doctrine\DBAL\Connection">Connection</abbr> $connection)
+        </code>
+    </h3>
+    <div class="details">    
+
+
+
+        <div class="method-description">
+                            <p><p>Execute a dummy query on the given connection and return false if the connection is not open</p></p>                        
+        </div>
+        <div class="tags">
+                            <h4>Parameters</h4>
+
+                    <table class="table table-condensed">
+                    <tr>
+                <td><abbr title="Doctrine\DBAL\Connection">Connection</abbr></td>
+                <td>$connection</td>
+                <td></td>
+            </tr>
+            </table>
+
+
+                            <h4>Return Value</h4>
+
+                    <table class="table table-condensed">
+        <tr>
+            <td>bool</td>
+            <td></td>
+        </tr>
+    </table>
+
+
+
+
                     </div>
     </div>
 
             </div>
                     <div class="method-item">
                     <h3 id="method_throwExceptionIfObjectIsNotAllowed">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/AllowedObjectsListener.php#L109">at line 109</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/AllowedObjectsListener.php#L123">at line 123</a></div>
         <code>            protected        void
     <strong>throwExceptionIfObjectIsNotAllowed</strong>(object $object)
         </code>