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 Jun 14, 2024
1 parent 427278c commit b95e028
Show file tree
Hide file tree
Showing 4 changed files with 156 additions and 10 deletions.
154 changes: 148 additions & 6 deletions flow/8.4/Neos/FluidAdaptor/Core/ViewHelper/TemplateVariableContainer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,18 @@ <h1>TemplateVariableContainer
<p><p>Provides the variables inside fluid template. Adds TemplateObjectAccessInterface functionality.</p></p> </div>


<h2>Constants</h2> <table class="table table-condensed">
<tr>
<td>
ACCESSOR_OBJECT_ACCESS
</td>
<td class="last">
<p><em></em></p>
<p></p>
</td>
</tr>
</table>



<h2>Methods</h2>
Expand All @@ -111,7 +123,7 @@ <h2>Methods</h2>
mixed
</div>
<div class="col-md-8">
<a href="#method_getByPath">getByPath</a>(string $path)
<a href="#method_getByPath">getByPath</a>(string $path, array $accessors = [])

<p><p>Get a variable by dotted path expression, retrieving the
variable from nested arrays/objects one segment at a time.</p></p> </div>
Expand All @@ -129,6 +141,28 @@ <h2>Methods</h2>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
null|string
</div>
<div class="col-md-8">
<a href="#method_detectAccessor">detectAccessor</a>(mixed $subject, string $propertyName)

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed|null
</div>
<div class="col-md-8">
<a href="#method_extractWithAccessor">extractWithAccessor</a>(mixed $subject, string $propertyName, string $accessor)

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool|null
</div>
Expand All @@ -146,9 +180,9 @@ <h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_getByPath">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.FluidAdaptor/Classes/Core/ViewHelper/TemplateVariableContainer.php#L32">at line 32</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.FluidAdaptor/Classes/Core/ViewHelper/TemplateVariableContainer.php#L40">at line 40</a></div>
<code> mixed
<strong>getByPath</strong>(string $path)
<strong>getByPath</strong>(string $path, array $accessors = [])
</code>
</h3>
<div class="details">
Expand All @@ -157,7 +191,9 @@ <h3 id="method_getByPath">

<div class="method-description">
<p><p>Get a variable by dotted path expression, retrieving the
variable from nested arrays/objects one segment at a time.</p></p>
variable from nested arrays/objects one segment at a time.</p></p> <p><p>If the second argument is provided, it must be an array of
accessor names which can be used to extract each value in
the dotted path.</p></p>
</div>
<div class="tags">
<h4>Parameters</h4>
Expand All @@ -167,6 +203,11 @@ <h4>Parameters</h4>
<td>string</td>
<td>$path</td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$accessors</td>
<td></td>
</tr>
</table>

Expand All @@ -189,7 +230,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_resolveSubVariableReferences">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.FluidAdaptor/Classes/Core/ViewHelper/TemplateVariableContainer.php#L51">at line 51</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.FluidAdaptor/Classes/Core/ViewHelper/TemplateVariableContainer.php#L55">at line 55</a></div>
<code> protected string
<strong>resolveSubVariableReferences</strong>(string $propertyPath)
</code>
Expand Down Expand Up @@ -226,13 +267,114 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_detectAccessor">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.FluidAdaptor/Classes/Core/ViewHelper/TemplateVariableContainer.php#L74">at line 74</a></div>
<code> protected null|string
<strong>detectAccessor</strong>(mixed $subject, string $propertyName)
</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>mixed</td>
<td>$subject</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$propertyName</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

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




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_extractWithAccessor">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.FluidAdaptor/Classes/Core/ViewHelper/TemplateVariableContainer.php#L85">at line 85</a></div>
<code> protected mixed|null
<strong>extractWithAccessor</strong>(mixed $subject, string $propertyName, string $accessor)
</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>mixed</td>
<td>$subject</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$propertyName</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$accessor</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>mixed|null</td>
<td></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_getBooleanValue">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.FluidAdaptor/Classes/Core/ViewHelper/TemplateVariableContainer.php#L70">at line 70</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.FluidAdaptor/Classes/Core/ViewHelper/TemplateVariableContainer.php#L110">at line 110</a></div>
<code> protected bool|null
<strong>getBooleanValue</strong>($path)
</code>
Expand Down
8 changes: 6 additions & 2 deletions flow/8.4/doc-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2581,7 +2581,9 @@ <h2 id="letterA">A</h2>
<dd><p>The default package key to use when rendering resource links without a
package key in the source URL.</p></dd><dt>$<a href="Neos/FluidAdaptor/Core/Parser/SyntaxTree/Expression/LegacyNamespaceExpressionNode.html#property_detectionExpression">
<abbr title="Neos\FluidAdaptor\Core\Parser\SyntaxTree\Expression\LegacyNamespaceExpressionNode">LegacyNamespaceExpressionNode</abbr>#detectionExpression</a> &mdash; <em>Property in class <a href="Neos/FluidAdaptor/Core/Parser/SyntaxTree/Expression/LegacyNamespaceExpressionNode.html"><abbr title="Neos\FluidAdaptor\Core\Parser\SyntaxTree\Expression\LegacyNamespaceExpressionNode">LegacyNamespaceExpressionNode</abbr></a></em></dt>
<dd><p>Pattern which detects namespace declarations made inline.</p></dd><dt>$<a href="Neos/FluidAdaptor/Core/Widget/AjaxWidgetMiddleware.html#property_dispatcher">
<dd><p>Pattern which detects namespace declarations made inline.</p></dd><dt><a href="Neos/FluidAdaptor/Core/ViewHelper/TemplateVariableContainer.html#method_detectAccessor">
<abbr title="Neos\FluidAdaptor\Core\ViewHelper\TemplateVariableContainer">TemplateVariableContainer</abbr>::detectAccessor</a>() &mdash; <em>Method in class <a href="Neos/FluidAdaptor/Core/ViewHelper/TemplateVariableContainer.html"><abbr title="Neos\FluidAdaptor\Core\ViewHelper\TemplateVariableContainer">TemplateVariableContainer</abbr></a></em></dt>
<dd></dd><dt>$<a href="Neos/FluidAdaptor/Core/Widget/AjaxWidgetMiddleware.html#property_dispatcher">
<abbr title="Neos\FluidAdaptor\Core\Widget\AjaxWidgetMiddleware">AjaxWidgetMiddleware</abbr>#dispatcher</a> &mdash; <em>Property in class <a href="Neos/FluidAdaptor/Core/Widget/AjaxWidgetMiddleware.html"><abbr title="Neos\FluidAdaptor\Core\Widget\AjaxWidgetMiddleware">AjaxWidgetMiddleware</abbr></a></em></dt>
<dd></dd><dt>$<a href="Neos/FluidAdaptor/Service/AbstractGenerator.html#property_docCommentParser">
<abbr title="Neos\FluidAdaptor\Service\AbstractGenerator">AbstractGenerator</abbr>#docCommentParser</a> &mdash; <em>Property in class <a href="Neos/FluidAdaptor/Service/AbstractGenerator.html"><abbr title="Neos\FluidAdaptor\Service\AbstractGenerator">AbstractGenerator</abbr></a></em></dt>
Expand Down Expand Up @@ -3083,7 +3085,9 @@ <h2 id="letterA">A</h2>
<dd></dd><dt>$<a href="Neos/FluidAdaptor/Core/ViewHelper/AbstractTagBasedViewHelper.html#property_escapeOutput">
<abbr title="Neos\FluidAdaptor\Core\ViewHelper\AbstractTagBasedViewHelper">AbstractTagBasedViewHelper</abbr>#escapeOutput</a> &mdash; <em>Property in class <a href="Neos/FluidAdaptor/Core/ViewHelper/AbstractTagBasedViewHelper.html"><abbr title="Neos\FluidAdaptor\Core\ViewHelper\AbstractTagBasedViewHelper">AbstractTagBasedViewHelper</abbr></a></em></dt>
<dd><p>Disable escaping of tag based ViewHelpers so that the rendered tag is not htmlspecialchar'd</p></dd><dt><a href="Neos/FluidAdaptor/Core/ViewHelper/Exception.html"><abbr title="Neos\FluidAdaptor\Core\ViewHelper\Exception">Exception</abbr></a> &mdash; <em>Class in namespace <a href="Neos/FluidAdaptor/Core/ViewHelper.html">Neos\FluidAdaptor\Core\ViewHelper</a></em></dt>
<dd><p>A ViewHelper Exception</p></dd><dt>$<a href="Neos/FluidAdaptor/Core/Widget/AbstractWidgetViewHelper.html#property_escapeOutput">
<dd><p>A ViewHelper Exception</p></dd><dt><a href="Neos/FluidAdaptor/Core/ViewHelper/TemplateVariableContainer.html#method_extractWithAccessor">
<abbr title="Neos\FluidAdaptor\Core\ViewHelper\TemplateVariableContainer">TemplateVariableContainer</abbr>::extractWithAccessor</a>() &mdash; <em>Method in class <a href="Neos/FluidAdaptor/Core/ViewHelper/TemplateVariableContainer.html"><abbr title="Neos\FluidAdaptor\Core\ViewHelper\TemplateVariableContainer">TemplateVariableContainer</abbr></a></em></dt>
<dd></dd><dt>$<a href="Neos/FluidAdaptor/Core/Widget/AbstractWidgetViewHelper.html#property_escapeOutput">
<abbr title="Neos\FluidAdaptor\Core\Widget\AbstractWidgetViewHelper">AbstractWidgetViewHelper</abbr>#escapeOutput</a> &mdash; <em>Property in class <a href="Neos/FluidAdaptor/Core/Widget/AbstractWidgetViewHelper.html"><abbr title="Neos\FluidAdaptor\Core\Widget\AbstractWidgetViewHelper">AbstractWidgetViewHelper</abbr></a></em></dt>
<dd></dd><dt><a href="Neos/FluidAdaptor/Core/Widget/AjaxWidgetMiddleware.html#method_extractWidgetContext">
<abbr title="Neos\FluidAdaptor\Core\Widget\AjaxWidgetMiddleware">AjaxWidgetMiddleware</abbr>::extractWidgetContext</a>() &mdash; <em>Method in class <a href="Neos/FluidAdaptor/Core/Widget/AjaxWidgetMiddleware.html"><abbr title="Neos\FluidAdaptor\Core\Widget\AjaxWidgetMiddleware">AjaxWidgetMiddleware</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 b95e028

Please sign in to comment.