Skip to content

Commit

Permalink
TASK: Update API docs from 8.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@neos-bot
neos-bot committed Jan 15, 2025
1 parent ff9a928 commit e360077
Show file tree
Hide file tree
Showing 23 changed files with 173 additions and 153 deletions.
24 changes: 11 additions & 13 deletions flow/8.3/Neos/Eel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@ <h2>Classes</h2>
<div class="col-md-6">
<a href="../Neos/Eel/EvaluationException.html"><abbr title="Neos\Eel\EvaluationException">EvaluationException</abbr></a> </div>
<div class="col-md-6"><p>Some exception that occurred during evaluation of an expression</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Neos/Eel/Exception.html"><abbr title="Neos\Eel\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A general Eel exception</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand All @@ -143,6 +148,11 @@ <h2>Classes</h2>
<div class="col-md-6">
<a href="../Neos/Eel/Package.html"><abbr title="Neos\Eel\Package">Package</abbr></a> </div>
<div class="col-md-6"><p>Package base class of the Eel package.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Neos/Eel/ParserException.html"><abbr title="Neos\Eel\ParserException">ParserException</abbr></a> </div>
<div class="col-md-6"><p>Some exception that occurred during parsing of an expression</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down Expand Up @@ -171,19 +181,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/Eel/Exception.html"><abbr title="Neos\Eel\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A general Eel exception</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Neos/Eel/ParserException.html"><abbr title="Neos\Eel\ParserException">ParserException</abbr></a> </div>
<div class="col-md-6"><p>Some exception that occurred during parsing of an expression</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
24 changes: 11 additions & 13 deletions flow/8.3/Neos/Eel/FlowQuery.html
View file
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/Eel/FlowQuery/FizzleException.html"><abbr title="Neos\Eel\FlowQuery\FizzleException">FizzleException</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Eel/FlowQuery/FizzleParser.html"><abbr title="Neos\Eel\FlowQuery\FizzleParser">FizzleParser</abbr></a> </div>
<div class="col-md-6"><p>Fizzle parser</p></div>
Expand All @@ -102,6 +107,11 @@ <h2>Classes</h2>
<div class="col-md-6">
<a href="../../Neos/Eel/FlowQuery/FlowQuery.html"><abbr title="Neos\Eel\FlowQuery\FlowQuery">FlowQuery</abbr></a> </div>
<div class="col-md-6"><p>FlowQuery is jQuery for PHP, a selector and traversal engine for object sets.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Eel/FlowQuery/FlowQueryException.html"><abbr title="Neos\Eel\FlowQuery\FlowQueryException">FlowQueryException</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
Expand All @@ -125,19 +135,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/Eel/FlowQuery/FizzleException.html"><abbr title="Neos\Eel\FlowQuery\FizzleException">FizzleException</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Eel/FlowQuery/FlowQueryException.html"><abbr title="Neos\Eel\FlowQuery\FlowQueryException">FlowQueryException</abbr></a> </div>
<div class="col-md-6"></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
8 changes: 4 additions & 4 deletions flow/8.3/Neos/Flow/Core/Booting/Exception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,17 @@ <h1>Neos\Flow\Core\Booting\Exception</h1>
</div>


<h2>Classes</h2>



<h2>Exceptions</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../../../Neos/Flow/Core/Booting/Exception/SubProcessException.html"><abbr title="Neos\Flow\Core\Booting\Exception\SubProcessException">SubProcessException</abbr></a> </div>
<div class="col-md-6"><p>A Sub Process 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: 8 additions & 6 deletions flow/8.3/Neos/Flow/Http.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,6 @@ <h2>Classes</h2>
<div class="col-md-6">
<a href="../../Neos/Flow/Http/Cookie.html"><abbr title="Neos\Flow\Http\Cookie">Cookie</abbr></a> </div>
<div class="col-md-6"><p>Represents a HTTP Cookie as of RFC 6265</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/Http/Exception.html"><abbr title="Neos\Flow\Http\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic HTTP exception</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down Expand Up @@ -160,7 +155,14 @@ <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/Http/Exception.html"><abbr title="Neos\Flow\Http\Exception">Exception</abbr></a> </div>
<div class="col-md-6"><p>A generic HTTP 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
24 changes: 13 additions & 11 deletions flow/8.3/Neos/Flow/Http/Client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,16 +105,6 @@ <h2>Classes</h2>
<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>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/Http/Client/InfiniteRedirectionException.html"><abbr title="Neos\Flow\Http\Client\InfiniteRedirectionException">InfiniteRedirectionException</abbr></a> </div>
<div class="col-md-6"><p>An HTTP exception occuring if an endless Location: redirect is suspect to happen</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand All @@ -134,7 +124,19 @@ <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/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>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../../Neos/Flow/Http/Client/InfiniteRedirectionException.html"><abbr title="Neos\Flow\Http\Client\InfiniteRedirectionException">InfiniteRedirectionException</abbr></a> </div>
<div class="col-md-6"><p>An HTTP exception occuring if an endless Location: redirect is suspect to happen</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
18 changes: 9 additions & 9 deletions flow/8.3/Neos/Flow/I18n/Service.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getConfiguration">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L101">at line 101</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L103">at line 103</a></div>
<code> <a href="../../../Neos/Flow/I18n/Configuration.html"><abbr title="Neos\Flow\I18n\Configuration">Configuration</abbr></a>
<strong>getConfiguration</strong>()
</code>
Expand Down Expand Up @@ -402,7 +402,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getLocalizedFilename">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L127">at line 127</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L129">at line 129</a></div>
<code> array
<strong>getLocalizedFilename</strong>(string $pathAndFilename, <abbr title="Neos\Flow\I18n\Neos\Flow\I18n\Locale">Locale</abbr>|null $locale = null, bool $strict = false)
</code>
Expand Down Expand Up @@ -473,7 +473,7 @@ <h4>See also</h4>
</div>
<div class="method-item">
<h3 id="method_getXliffFilenameAndPath">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L180">at line 180</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L182">at line 182</a></div>
<code> array
<strong>getXliffFilenameAndPath</strong>(string $path, string $sourceName, <abbr title="Neos\Flow\I18n\Neos\Flow\I18n\Locale">Locale</abbr>|null $locale = null)
</code>
Expand Down Expand Up @@ -544,7 +544,7 @@ <h4>See also</h4>
</div>
<div class="method-item">
<h3 id="method_getLocaleChain">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L201">at line 201</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L203">at line 203</a></div>
<code> array
<strong>getLocaleChain</strong>(<a href="../../../Neos/Flow/I18n/Locale.html"><abbr title="Neos\Flow\I18n\Locale">Locale</abbr></a> $locale)
</code>
Expand Down Expand Up @@ -587,7 +587,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getParentLocaleOf">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L238">at line 238</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L240">at line 240</a></div>
<code> <a href="../../../Neos/Flow/I18n/Locale.html"><abbr title="Neos\Flow\I18n\Locale">Locale</abbr></a>
<strong>getParentLocaleOf</strong>(<a href="../../../Neos/Flow/I18n/Locale.html"><abbr title="Neos\Flow\I18n\Locale">Locale</abbr></a> $locale)
</code>
Expand Down Expand Up @@ -629,7 +629,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_findBestMatchingLocale">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L252">at line 252</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L254">at line 254</a></div>
<code> mixed
<strong>findBestMatchingLocale</strong>(<a href="../../../Neos/Flow/I18n/Locale.html"><abbr title="Neos\Flow\I18n\Locale">Locale</abbr></a> $locale)
</code>
Expand Down Expand Up @@ -673,7 +673,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_generateAvailableLocalesCollectionFromSettings">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L265">at line 265</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L267">at line 267</a></div>
<code> protected void
<strong>generateAvailableLocalesCollectionFromSettings</strong>()
</code>
Expand Down Expand Up @@ -706,7 +706,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getScanExcludePattern">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L278">at line 278</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L280">at line 280</a></div>
<code> protected string
<strong>getScanExcludePattern</strong>()
</code>
Expand Down Expand Up @@ -739,7 +739,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_generateAvailableLocalesCollectionByScanningFilesystem">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L305">at line 305</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.3/Neos.Flow/Classes/I18n/Service.php#L307">at line 307</a></div>
<code> protected void
<strong>generateAvailableLocalesCollectionByScanningFilesystem</strong>()
</code>
Expand Down
14 changes: 8 additions & 6 deletions flow/8.3/Neos/Flow/ObjectManagement.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,6 @@ <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 @@ -122,7 +117,14 @@ <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: 8 additions & 6 deletions flow/8.3/Neos/Flow/ObjectManagement/Proxy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,6 @@ <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 @@ -132,7 +127,14 @@ <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
Loading

0 comments on commit e360077

Please sign in to comment.