TASK: Update API docs from 9.0

neos · Jul 9, 2024 · 070c1b6 · 070c1b6
1 parent 96f2e85
commit 070c1b6
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 27 deletions.
diff --git a/flow/9.0/Neos/Flow/Persistence/Doctrine/DataTypes.html b/flow/9.0/Neos/Flow/Persistence/Doctrine/DataTypes.html
@@ -97,7 +97,7 @@ <h2>Classes</h2>
             </div>
                     <div class="row">
                 <div class="col-md-6">
-                    <a href="../../../../Neos/Flow/Persistence/Doctrine/DataTypes/ObjectArray.html"><abbr title="Neos\Flow\Persistence\Doctrine\DataTypes\ObjectArray">ObjectArray</abbr></a>    </div>
+                    <a href="../../../../Neos/Flow/Persistence/Doctrine/DataTypes/ObjectArray.html"><abbr title="Neos\Flow\Persistence\Doctrine\DataTypes\ObjectArray">ObjectArray</abbr></a>    <small><span class="label label-danger">deprecated</span></small></div>
                 <div class="col-md-6"><p>A datatype that replaces references to entities in arrays with a type/identifier tuple
 and strips singletons from the data to be stored.</p></div>
             </div>

diff --git a/flow/9.0/Neos/Flow/Persistence/Doctrine/DataTypes/ObjectArray.html b/flow/9.0/Neos/Flow/Persistence/Doctrine/DataTypes/ObjectArray.html
@@ -84,7 +84,7 @@
         </div>
                 <div id="page-content">
     <div class="page-header">
-        <h1>ObjectArray    
+        <h1>ObjectArray    <small><span class="label label-danger">deprecated</span></small>
             </h1>
     </div>
 
@@ -94,6 +94,14 @@ <h1>ObjectArray
 </p>
 
 
+            <p>
+                <small><span class="label label-danger">deprecated</span></small>
+                            <tr>
+                    <td>will</td>
+                    <td>be removed in Flow 9. Checkout {@see \Neos\Flow\Persistence\Doctrine\DataTypes\JsonArrayType}
+This hasn't been used in the Flow/Neos codebase for a long time and there are no tests.</td>
+                </tr>
+                    </p>
 
 
 
@@ -236,7 +244,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method_getName">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L32">at line 32</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L35">at line 35</a></div>
         <code>                    string
     <strong>getName</strong>()
         </code>
@@ -269,7 +277,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getSQLDeclaration">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L40">at line 40</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L43">at line 43</a></div>
         <code>                    string
     <strong>getSQLDeclaration</strong>(array $column, <abbr title="Doctrine\DBAL\Platforms\AbstractPlatform">AbstractPlatform</abbr> $platform)
         </code>
@@ -316,7 +324,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getBindingType">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L48">at line 48</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L51">at line 51</a></div>
         <code>                    int
     <strong>getBindingType</strong>()
         </code>
@@ -348,7 +356,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_convertToPHPValue">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L56">at line 56</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L59">at line 59</a></div>
         <code>                    array
     <strong>convertToPHPValue</strong>($value, <abbr title="Doctrine\DBAL\Platforms\AbstractPlatform">AbstractPlatform</abbr> $platform)
         </code>
@@ -405,7 +413,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_convertToDatabaseValue">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.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/Persistence/Doctrine/DataTypes/ObjectArray.php#L77">at line 77</a></div>
         <code>                    mixed
     <strong>convertToDatabaseValue</strong>($value, <abbr title="Doctrine\DBAL\Platforms\AbstractPlatform">AbstractPlatform</abbr> $platform)
         </code>
@@ -453,7 +461,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_initializeDependencies">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.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/Persistence/Doctrine/DataTypes/ObjectArray.php#L98">at line 98</a></div>
         <code>            protected        void
     <strong>initializeDependencies</strong>()
         </code>
@@ -485,7 +493,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_decodeObjectReferences">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L107">at line 107</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L110">at line 110</a></div>
         <code>            protected        void
     <strong>decodeObjectReferences</strong>(array $array)
         </code>
@@ -528,7 +536,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_encodeObjectReferences">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L130">at line 130</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/DataTypes/ObjectArray.php#L133">at line 133</a></div>
         <code>            protected        void
     <strong>encodeObjectReferences</strong>(array $array)
         </code>

diff --git a/flow/9.0/Neos/Flow/Persistence/Doctrine/Repository.html b/flow/9.0/Neos/Flow/Persistence/Doctrine/Repository.html
@@ -214,7 +214,7 @@ <h2>Methods</h2>
                 </div>
                 <div class="col-md-8">
                     <a href="#method_iterate">iterate</a>(<abbr title="Doctrine\ORM\Internal\Hydration\IterableResult">IterableResult</abbr> $iterator, callable $callback = null)
-
+        <small><span class="label label-danger">deprecated</span></small>
                                             <p><p>Iterate over an IterableResult and return a Generator</p></p>                </div>
                 <div class="col-md-2"></div>
             </div>
@@ -555,12 +555,19 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_iterate">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L166">at line 166</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L168">at line 168</a></div>
         <code>                    <abbr title="Neos\Flow\Persistence\Doctrine\Generator">Generator</abbr>|null
     <strong>iterate</strong>(<abbr title="Doctrine\ORM\Internal\Hydration\IterableResult">IterableResult</abbr> $iterator, callable $callback = null)
-        </code>
+        <small><span class="label label-danger">deprecated</span></small></code>
     </h3>
     <div class="details">    
+            <p>
+                <small><span class="label label-danger">deprecated</span></small>
+                            <tr>
+                    <td>Will</td>
+                    <td>be removed with Flow 9. The {@see \Neos\Flow\Persistence\Doctrine\findAllIterator} will return an \iterable directly</td>
+                </tr>
+                    </p>
 
 
 
@@ -602,7 +609,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_findByIdentifier">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L190">at line 190</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L192">at line 192</a></div>
         <code>                    object|null
     <strong>findByIdentifier</strong>(mixed $identifier)
         </code>
@@ -661,7 +668,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_createQuery">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L201">at line 201</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L203">at line 203</a></div>
         <code>                    <a href="../../../../Neos/Flow/Persistence/QueryInterface.html"><abbr title="Neos\Flow\Persistence\QueryInterface">QueryInterface</abbr></a>
     <strong>createQuery</strong>()
         </code>
@@ -693,7 +700,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_createDqlQuery">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L216">at line 216</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L218">at line 218</a></div>
         <code>                    <abbr title="Doctrine\ORM\Query">Query</abbr>
     <strong>createDqlQuery</strong>(string $dqlString)
         </code>
@@ -735,7 +742,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_countAll">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L229">at line 229</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L231">at line 231</a></div>
         <code>                    int
     <strong>countAll</strong>()
         </code>
@@ -780,7 +787,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_removeAll">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L244">at line 244</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L246">at line 246</a></div>
         <code>                    void
     <strong>removeAll</strong>()
         </code>
@@ -833,7 +840,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_setDefaultOrderings">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L262">at line 262</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L264">at line 264</a></div>
         <code>                    void
     <strong>setDefaultOrderings</strong>(array $defaultOrderings)
         </code>
@@ -879,7 +886,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_update">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L276">at line 276</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L278">at line 278</a></div>
         <code>                    void
     <strong>update</strong>(object $object)
         </code>
@@ -934,7 +941,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method___call">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L297">at line 297</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Repository.php#L299">at line 299</a></div>
         <code>                    mixed
     <strong>__call</strong>(string $method, array $arguments)
         </code>

diff --git a/flow/9.0/Neos/Flow/Persistence/Doctrine/Service.html b/flow/9.0/Neos/Flow/Persistence/Doctrine/Service.html
@@ -309,7 +309,7 @@ <h2>Methods</h2>
                 </div>
                 <div class="col-md-8">
                     <a href="#method_getDatabasePlatformName">getDatabasePlatformName</a>()
-
+        <small><span class="label label-danger">deprecated</span></small>
                                             <p><p>Get name of current database platform</p></p>                </div>
                 <div class="col-md-2"></div>
             </div>
@@ -999,12 +999,19 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getDatabasePlatformName">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Service.php#L634">at line 634</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Service.php#L635">at line 635</a></div>
         <code>                    string
     <strong>getDatabasePlatformName</strong>()
-        </code>
+        <small><span class="label label-danger">deprecated</span></small></code>
     </h3>
     <div class="details">    
+            <p>
+                <small><span class="label label-danger">deprecated</span></small>
+                            <tr>
+                    <td>will</td>
+                    <td>be removed in Flow 9. Compare the connection class name instead.</td>
+                </tr>
+                    </p>
 
 
 
@@ -1040,7 +1047,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getForeignKeyHandlingSql">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Service.php#L675">at line 675</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Persistence/Doctrine/Service.php#L676">at line 676</a></div>
         <code>        static            array
     <strong>getForeignKeyHandlingSql</strong>(<abbr title="Doctrine\DBAL\Schema\Schema">Schema</abbr> $schema, <abbr title="Doctrine\DBAL\Platforms\AbstractPlatform">AbstractPlatform</abbr> $platform, array $tableNames, string $search, string $replace)
         </code>

diff --git a/flow/9.0/classes.html b/flow/9.0/classes.html
@@ -2820,7 +2820,7 @@ <h1>Classes</h1>
             </div>
                     <div class="row">
                 <div class="col-md-6">
-                    <a href="Neos/Flow/Persistence/Doctrine/DataTypes/ObjectArray.html"><abbr title="Neos\Flow\Persistence\Doctrine\DataTypes\ObjectArray">ObjectArray</abbr></a>    </div>
+                    <a href="Neos/Flow/Persistence/Doctrine/DataTypes/ObjectArray.html"><abbr title="Neos\Flow\Persistence\Doctrine\DataTypes\ObjectArray">ObjectArray</abbr></a>    <small><span class="label label-danger">deprecated</span></small></div>
                 <div class="col-md-6"><p>A datatype that replaces references to entities in arrays with a type/identifier tuple
 and strips singletons from the data to be stored.</p></div>
             </div>

diff --git a/flow/9.0/renderer.index b/flow/9.0/renderer.index