Skip to content

Commit

Permalink
TASK: Update API docs from 8.4
Browse files Browse the repository at this point in the history
  • Loading branch information
@neos-bot
neos-bot committed Nov 19, 2024
1 parent 22fa159 commit 6ae0e15
Show file tree
Hide file tree
Showing 5 changed files with 126 additions and 14 deletions.
2 changes: 1 addition & 1 deletion flow/8.4/Neos/Flow.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h2>Functions</h2>
var_dump(mixed $variable, string $title = null, bool $return = false, bool $plaintext = null)<br>
<p><p>A var_dump function optimized for Flow's object structures</p></p> </div>
<div class="col-md-2">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L640">at line 640</a>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L665">at line 665</a>
</div>
</div>
</div>
Expand Down
128 changes: 118 additions & 10 deletions flow/8.4/Neos/Flow/Error/Debugger.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,17 @@ <h2>Methods</h2>

<p><p>Renders some backtrace</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static&nbsp;string
</div>
<div class="col-md-8">
<a href="#method_renderCallArgumentsHtml">renderCallArgumentsHtml</a>(array $callArguments)

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
Expand All @@ -258,6 +269,17 @@ <h2>Methods</h2>
<div class="col-md-2 type">
static&nbsp;string
</div>
<div class="col-md-8">
<a href="#method_renderCallArgumentsPlaintext">renderCallArgumentsPlaintext</a>(array $callArguments)

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static&nbsp;string
</div>
<div class="col-md-8">
<a href="#method_getCodeSnippet">getCodeSnippet</a>(string $filePathAndName, int $lineNumber, bool $plaintext = false)

Expand Down Expand Up @@ -656,13 +678,56 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_renderCallArgumentsHtml">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L352">at line 352</a></div>
<code> static protected string
<strong>renderCallArgumentsHtml</strong>(array $callArguments)
</code>
</h3>
<div class="details">



<div class="method-description">
<p class="no-description">No description</p>

</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>array</td>
<td>$callArguments</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_getBacktraceCodePlaintext">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L383">at line 383</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L397">at line 397</a></div>
<code> static protected string
<strong>getBacktraceCodePlaintext</strong>(array $trace, bool $includeCode = true)
</code>
Expand Down Expand Up @@ -704,13 +769,56 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_renderCallArgumentsPlaintext">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L418">at line 418</a></div>
<code> static protected string
<strong>renderCallArgumentsPlaintext</strong>(array $callArguments)
</code>
</h3>
<div class="details">



<div class="method-description">
<p class="no-description">No description</p>

</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>array</td>
<td>$callArguments</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_getCodeSnippet">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L429">at line 429</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L454">at line 454</a></div>
<code> static string
<strong>getCodeSnippet</strong>(string $filePathAndName, int $lineNumber, bool $plaintext = false)
</code>
Expand Down Expand Up @@ -762,7 +870,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getObjectSnippetPlaintext">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L467">at line 467</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L492">at line 492</a></div>
<code> static protected string
<strong>getObjectSnippetPlaintext</strong>(object $object)
</code>
Expand Down Expand Up @@ -805,7 +913,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getObjectShortName">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L485">at line 485</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L510">at line 510</a></div>
<code> static protected string
<strong>getObjectShortName</strong>(object $object)
</code>
Expand Down Expand Up @@ -848,7 +956,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_truncateObjectOutput">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L491">at line 491</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L516">at line 516</a></div>
<code> static protected string
<strong>truncateObjectOutput</strong>(string $stringifiedObject)
</code>
Expand Down Expand Up @@ -891,7 +999,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getCodeSnippetPlaintext">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L496">at line 496</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L521">at line 521</a></div>
<code> static protected string
<strong>getCodeSnippetPlaintext</strong>(string $filePathAndName, int $lineNumber)
</code>
Expand Down Expand Up @@ -939,7 +1047,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_findProxyAndShortFilePath">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L524">at line 524</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L549">at line 549</a></div>
<code> static array
<strong>findProxyAndShortFilePath</strong>(string $file)
</code>
Expand Down Expand Up @@ -982,7 +1090,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_ansiEscapeWrap">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L551">at line 551</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L576">at line 576</a></div>
<code> static protected string
<strong>ansiEscapeWrap</strong>(string $string, string $ansiColors, bool $enable = true)
</code>
Expand Down Expand Up @@ -1034,7 +1142,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getIgnoredClassesRegex">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L567">at line 567</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L592">at line 592</a></div>
<code> static string
<strong>getIgnoredClassesRegex</strong>()
</code>
Expand Down Expand Up @@ -1068,7 +1176,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getRecursionLimit">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L604">at line 604</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Error/Debugger.php#L629">at line 629</a></div>
<code> static int
<strong>getRecursionLimit</strong>()
</code>
Expand Down
6 changes: 5 additions & 1 deletion flow/8.4/doc-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10830,7 +10830,11 @@ <h2 id="letterA">A</h2>
<abbr title="Neos\Flow\Error\Debugger">Debugger</abbr>::renderArrayDump</a>() &mdash; <em>Method in class <a href="Neos/Flow/Error/Debugger.html"><abbr title="Neos\Flow\Error\Debugger">Debugger</abbr></a></em></dt>
<dd><p>Renders a dump of the given array</p></dd><dt><a href="Neos/Flow/Error/Debugger.html#method_renderObjectDump">
<abbr title="Neos\Flow\Error\Debugger">Debugger</abbr>::renderObjectDump</a>() &mdash; <em>Method in class <a href="Neos/Flow/Error/Debugger.html"><abbr title="Neos\Flow\Error\Debugger">Debugger</abbr></a></em></dt>
<dd><p>Renders a dump of the given object</p></dd><dt><a href="Neos/Flow/Error/ProductionExceptionHandler.html#method_renderStatically">
<dd><p>Renders a dump of the given object</p></dd><dt><a href="Neos/Flow/Error/Debugger.html#method_renderCallArgumentsHtml">
<abbr title="Neos\Flow\Error\Debugger">Debugger</abbr>::renderCallArgumentsHtml</a>() &mdash; <em>Method in class <a href="Neos/Flow/Error/Debugger.html"><abbr title="Neos\Flow\Error\Debugger">Debugger</abbr></a></em></dt>
<dd></dd><dt><a href="Neos/Flow/Error/Debugger.html#method_renderCallArgumentsPlaintext">
<abbr title="Neos\Flow\Error\Debugger">Debugger</abbr>::renderCallArgumentsPlaintext</a>() &mdash; <em>Method in class <a href="Neos/Flow/Error/Debugger.html"><abbr title="Neos\Flow\Error\Debugger">Debugger</abbr></a></em></dt>
<dd></dd><dt><a href="Neos/Flow/Error/ProductionExceptionHandler.html#method_renderStatically">
<abbr title="Neos\Flow\Error\ProductionExceptionHandler">ProductionExceptionHandler</abbr>::renderStatically</a>() &mdash; <em>Method in class <a href="Neos/Flow/Error/ProductionExceptionHandler.html"><abbr title="Neos\Flow\Error\ProductionExceptionHandler">ProductionExceptionHandler</abbr></a></em></dt>
<dd><p>Returns the statically rendered exception message</p></dd><dt>$<a href="Neos/Flow/Exception.html#property_referenceCode">
<abbr title="Neos\Flow\Exception">Exception</abbr>#referenceCode</a> &mdash; <em>Property in class <a href="Neos/Flow/Exception.html"><abbr title="Neos\Flow\Exception">Exception</abbr></a></em></dt>
Expand Down
2 changes: 1 addition & 1 deletion flow/8.4/doctum-search.json
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion flow/8.4/renderer.index
View file

Large diffs are not rendered by default.

0 comments on commit 6ae0e15

Please sign in to comment.