Skip to content

Commit

Permalink
TASK: Update API docs from 8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
neos-bot committed Feb 16, 2024
1 parent a881b23 commit cc35000
Show file tree
Hide file tree
Showing 20 changed files with 114 additions and 146 deletions.
8 changes: 3 additions & 5 deletions flow/8.0/Neos/Flow/Configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,15 @@ <h2>Classes</h2>
<a href="../../Neos/Flow/Configuration/ConfigurationSchemaValidator.html"><abbr title="Neos\Flow\Configuration\ConfigurationSchemaValidator">ConfigurationSchemaValidator</abbr></a> </div>
<div class="col-md-6"><p>A validator for all configuration entries using Schema</p></div>
</div>
</div>


<h2>Exceptions</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/Configuration/Exception.html"><abbr title="Neos\Flow\Configuration\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic Configuration Exception</p></div>
</div>
</div>



</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
</div>
Expand Down
10 changes: 5 additions & 5 deletions flow/8.0/Neos/Flow/Http/Client.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ <h2>Classes</h2>
<a href="../../../Neos/Flow/Http/Client/CurlEngine.html"><abbr title="Neos\Flow\Http\Client\CurlEngine">CurlEngine</abbr></a> </div>
<div class="col-md-6"><p>A Request Engine which uses cURL in order to send requests to external
HTTP servers.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/Http/Client/CurlEngineException.html"><abbr title="Neos\Flow\Http\Client\CurlEngineException">CurlEngineException</abbr></a> </div>
<div class="col-md-6"><p>An exception for the Curl Engine</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand All @@ -122,11 +127,6 @@ <h2>Interfaces</h2>
<h2>Exceptions</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/Http/Client/CurlEngineException.html"><abbr title="Neos\Flow\Http\Client\CurlEngineException">CurlEngineException</abbr></a> </div>
<div class="col-md-6"><p>An exception for the Curl Engine</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/Http/Client/Exception.html"><abbr title="Neos\Flow\Http\Client\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic HTTP exception</p></div>
Expand Down
14 changes: 6 additions & 8 deletions flow/8.0/Neos/Flow/Http/Middleware.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@ <h1>Neos\Flow\Http\Middleware</h1>
<h2>Classes</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/Http/Middleware/Exception.html"><abbr title="Neos\Flow\Http\Middleware\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A HTTP middleware exception</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/Http/Middleware/MethodOverrideMiddleware.html"><abbr title="Neos\Flow\Http\Middleware\MethodOverrideMiddleware">MethodOverrideMiddleware</abbr></a> </div>
<div class="col-md-6"><p>Allows to override the request HTTP Method via different overrides in this order:</p>
Expand Down Expand Up @@ -147,14 +152,7 @@ <h2>Classes</h2>
</div>


<h2>Exceptions</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/Http/Middleware/Exception.html"><abbr title="Neos\Flow\Http\Middleware\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A HTTP middleware exception</p></div>
</div>
</div>

</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
</div>
Expand Down
22 changes: 11 additions & 11 deletions flow/8.0/Neos/Flow/Mvc/Controller/Arguments.html
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_offsetExists">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L93">at line 93</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L90">at line 90</a></div>
<code> bool
<strong>offsetExists</strong>(mixed $offset)
</code>
Expand Down Expand Up @@ -463,7 +463,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_offsetGet">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L107">at line 107</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L104">at line 104</a></div>
<code> mixed
<strong>offsetGet</strong>(mixed $offset)
</code>
Expand Down Expand Up @@ -514,7 +514,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_addNewArgument">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L129">at line 129</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L126">at line 126</a></div>
<code> <a href="../../../../Neos/Flow/Mvc/Controller/Argument.html"><abbr title="Neos\Flow\Mvc\Controller\Argument">Argument</abbr></a>
<strong>addNewArgument</strong>(string $name, string $dataType = &#039;string&#039;, bool $isRequired = true, mixed $defaultValue = null, bool $mapRequestBody = false)
</code>
Expand Down Expand Up @@ -577,7 +577,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_addArgument">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L151">at line 151</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L148">at line 148</a></div>
<code> void
<strong>addArgument</strong>(<a href="../../../../Neos/Flow/Mvc/Controller/Argument.html"><abbr title="Neos\Flow\Mvc\Controller\Argument">Argument</abbr></a> $argument)
</code>
Expand Down Expand Up @@ -621,7 +621,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getArgument">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L164">at line 164</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L161">at line 161</a></div>
<code> <a href="../../../../Neos/Flow/Mvc/Controller/Argument.html"><abbr title="Neos\Flow\Mvc\Controller\Argument">Argument</abbr></a>
<strong>getArgument</strong>(string $argumentName)
</code>
Expand Down Expand Up @@ -672,7 +672,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_hasArgument">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L177">at line 177</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L174">at line 174</a></div>
<code> bool
<strong>hasArgument</strong>(string $argumentName)
</code>
Expand Down Expand Up @@ -725,7 +725,7 @@ <h4>See also</h4>
</div>
<div class="method-item">
<h3 id="method_getArgumentNames">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L188">at line 188</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L185">at line 185</a></div>
<code> array
<strong>getArgumentNames</strong>()
</code>
Expand Down Expand Up @@ -757,7 +757,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method___call">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L202">at line 202</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L199">at line 199</a></div>
<code> void
<strong>__call</strong>(string $methodName, array $arguments)
</code>
Expand Down Expand Up @@ -814,7 +814,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_validateArgumentExistence">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L229">at line 229</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L226">at line 226</a></div>
<code> protected string
<strong>validateArgumentExistence</strong>(string $argumentName)
</code>
Expand Down Expand Up @@ -858,7 +858,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_removeAll">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L243">at line 243</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L240">at line 240</a></div>
<code> void
<strong>removeAll</strong>()
</code>
Expand Down Expand Up @@ -890,7 +890,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getValidationResults">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L256">at line 256</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.0/Neos.Flow/Classes/Mvc/Controller/Arguments.php#L253">at line 253</a></div>
<code> <a href="../../../../Neos/Error/Messages/Result.html"><abbr title="Neos\Error\Messages\Result">Result</abbr></a>
<strong>getValidationResults</strong>()
</code>
Expand Down
8 changes: 4 additions & 4 deletions flow/8.0/Neos/Flow/Mvc/Routing/Exception.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,7 @@ <h1>Neos\Flow\Mvc\Routing\Exception</h1>
</div>





<h2>Exceptions</h2>
<h2>Classes</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
Expand All @@ -104,6 +101,9 @@ <h2>Exceptions</h2>
<div class="col-md-6"><p>A Missing actionName Exception.</p></div>
</div>
</div>



</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
</div>
Expand Down
14 changes: 6 additions & 8 deletions flow/8.0/Neos/Flow/ObjectManagement.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ <h2>Classes</h2>
<div class="col-md-6"><p>A specialized Object Manager which is able to do some basic dependency injection for
singleton scoped objects. This Object Manager is used during compile time when the proxy
class based DI mechanism is not yet available.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/ObjectManagement/Exception.html"><abbr title="Neos\Flow\ObjectManagement\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic Object Exception</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand All @@ -117,14 +122,7 @@ <h2>Interfaces</h2>
</div>
</div>

<h2>Exceptions</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/ObjectManagement/Exception.html"><abbr title="Neos\Flow\ObjectManagement\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic Object Exception</p></div>
</div>
</div>

</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
</div>
Expand Down
14 changes: 6 additions & 8 deletions flow/8.0/Neos/Flow/ObjectManagement/Proxy.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@ <h2>Classes</h2>
<a href="../../../Neos/Flow/ObjectManagement/Proxy/Compiler.html"><abbr title="Neos\Flow\ObjectManagement\Proxy\Compiler">Compiler</abbr></a> </div>
<div class="col-md-6"><p>Builder for proxy classes which are used to implement Dependency Injection and
Aspect-Oriented Programming</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/ObjectManagement/Proxy/Exception.html"><abbr title="Neos\Flow\ObjectManagement\Proxy\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic Proxy Exception</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down Expand Up @@ -127,14 +132,7 @@ <h2>Interfaces</h2>
</div>
</div>

<h2>Exceptions</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/ObjectManagement/Proxy/Exception.html"><abbr title="Neos\Flow\ObjectManagement\Proxy\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic Proxy Exception</p></div>
</div>
</div>

</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
</div>
Expand Down
14 changes: 6 additions & 8 deletions flow/8.0/Neos/Flow/Persistence.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,11 @@ <h2>Classes</h2>
<div class="col-md-6">
<a href="../../Neos/Flow/Persistence/EmptyQueryResult.html"><abbr title="Neos\Flow\Persistence\EmptyQueryResult">EmptyQueryResult</abbr></a> </div>
<div class="col-md-6"><p>An empty result list</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/Persistence/Exception.html"><abbr title="Neos\Flow\Persistence\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic Persistence exception</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down Expand Up @@ -142,14 +147,7 @@ <h2>Interfaces</h2>
</div>
</div>

<h2>Exceptions</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/Persistence/Exception.html"><abbr title="Neos\Flow\Persistence\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic Persistence exception</p></div>
</div>
</div>

</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
</div>
Expand Down
14 changes: 6 additions & 8 deletions flow/8.0/Neos/Flow/Property.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ <h2>Namespaces</h2>
<h2>Classes</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/Property/Exception.html"><abbr title="Neos\Flow\Property\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>An generic Property related exception</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/Property/PropertyMapper.html"><abbr title="Neos\Flow\Property\PropertyMapper">PropertyMapper</abbr></a> </div>
<div class="col-md-6"><p>The Property Mapper transforms simple types (arrays, strings, integers, floats, booleans) to objects or other simple types.</p></div>
Expand Down Expand Up @@ -123,14 +128,7 @@ <h2>Interfaces</h2>
</div>
</div>

<h2>Exceptions</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/Property/Exception.html"><abbr title="Neos\Flow\Property\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>An generic Property related exception</p></div>
</div>
</div>

</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
</div>
Expand Down
Loading

0 comments on commit cc35000

Please sign in to comment.