Skip to content

Commit

Permalink
TASK: Update API docs from 9.0
Browse files Browse the repository at this point in the history
  • Loading branch information
neos-bot committed Mar 28, 2024
1 parent 1965d3f commit 3143e46
Show file tree
Hide file tree
Showing 12 changed files with 205 additions and 12 deletions.
5 changes: 5 additions & 0 deletions flow/9.0/Neos/Flow/Http.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,11 @@ <h2>Classes</h2>
<div class="col-md-6">
<a href="../../Neos/Flow/Http/UploadedFile.html"><abbr title="Neos\Flow\Http\UploadedFile">UploadedFile</abbr></a> </div>
<div class="col-md-6"><p>Generic implementation of the PSR-7 UploadedFileInterface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Flow/Http/UriHelper.html"><abbr title="Neos\Flow\Http\UriHelper">UriHelper</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down
178 changes: 178 additions & 0 deletions flow/9.0/Neos/Flow/Http/UriHelper.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Neos\Flow\Http\UriHelper | Flow Framework</title>

<link rel="stylesheet" type="text/css" href="../../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../../css/doctum.css">
<link rel="stylesheet" type="text/css" href="../../../fonts/doctum-font.css">
<script src="../../../js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="../../../doctum.js"></script>
<script async defer src="../../../js/bootstrap.min.js"></script>
<script async defer src="../../../js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="shortcut icon" href="https://www.neos.io/favicon-32x32.png" />
<link rel="search"
type="application/opensearchdescription+xml"
href="https://neos.github.io/opensearch.xml"
title="Flow Framework (9.0)" />
</head>

<body id="class" data-name="class:Neos_Flow_Http_UriHelper" data-root-path="../../../" data-search-index-url="../../../doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="../../../search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>

<div id="api-tree"></div>

</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../../index.html">Flow Framework</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../../classes.html">Classes</a></li>
<li><a href="../../../namespaces.html">Namespaces</a></li>
<li><a href="../../../interfaces.html">Interfaces</a></li>
<li><a href="../../../traits.html">Traits</a></li>
<li><a href="../../../doc-index.html">Index</a></li>
<li><a href="../../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>

<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../../Neos.html">Neos</a></li><li class="backslash">\</li><li><a href="../../../Neos/Flow.html">Flow</a></li><li class="backslash">\</li><li><a href="../../../Neos/Flow/Http.html">Http</a></li><li class="backslash">\</li><li>UriHelper</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>UriHelper
</h1>
</div>


<p>final class
<strong>UriHelper</strong> (<a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Http/UriHelper.php">View source</a>)
</p>









<h2>Methods</h2>

<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
static&nbsp;<abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr>
</div>
<div class="col-md-8">
<a href="#method_withAdditionalQueryParameters">withAdditionalQueryParameters</a>(<abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr> $uri, array $queryParameters)

<p><p>Merges recursively into the current {UriInterface::getQuery} these additional query parameters.</p></p> </div>
<div class="col-md-2"></div>
</div>
</div>


<h2>Details</h2>

<div id="method-details">
<div class="method-item">
<h3 id="method_withAdditionalQueryParameters">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Http/UriHelper.php#L23">at line 23</a></div>
<code> static <abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr>
<strong>withAdditionalQueryParameters</strong>(<abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr> $uri, array $queryParameters)
</code>
</h3>
<div class="details">



<div class="method-description">
<p><p>Merges recursively into the current {UriInterface::getQuery} these additional query parameters.</p></p>
</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td><abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr></td>
<td>$uri</td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$queryParameters</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td><abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr></td>
<td><p>A new instance with the additional query.</p></td>
</tr>
</table>




</div>
</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>
</body>

</html>
2 changes: 1 addition & 1 deletion flow/9.0/Neos/Http/Factories.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2>Classes</h2>
<div class="row">
<div class="col-md-6">
<a href="../../Neos/Http/Factories/PsrHttpFactory.html"><abbr title="Neos\Http\Factories\PsrHttpFactory">PsrHttpFactory</abbr></a> </div>
<div class="col-md-6"></div>
<div class="col-md-6"><p>A factory that implements all interfaces of PSR 17</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down
4 changes: 3 additions & 1 deletion flow/9.0/Neos/Http/Factories/PsrHttpFactory.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ <h1>PsrHttpFactory



<div class="description">
<p><p>A factory that implements all interfaces of PSR 17</p></p> <p><p>This factory can be used to simply create Requests, Uris and Streams without having to inject the traits yourself.</p></p> </div>

<h2>Traits</h2>

Expand Down Expand Up @@ -501,7 +503,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_createUri">
<div class="location">in <a href="../../../Neos/Http/Factories/UriFactoryTrait.html#method_createUri">
<abbr title="Neos\Http\Factories\UriFactoryTrait">UriFactoryTrait</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Http.Factories/Classes/UriFactoryTrait.php#L18">at line 18</a></div>
<abbr title="Neos\Http\Factories\UriFactoryTrait">UriFactoryTrait</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Http.Factories/Classes/UriFactoryTrait.php#L17">at line 17</a></div>
<code> <abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr>
<strong>createUri</strong>(string $uri = &#039;&#039;)
</code>
Expand Down
2 changes: 1 addition & 1 deletion flow/9.0/Neos/Http/Factories/UriFactory.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h2>Details</h2>
<div class="method-item">
<h3 id="method_createUri">
<div class="location">in <a href="../../../Neos/Http/Factories/UriFactoryTrait.html#method_createUri">
<abbr title="Neos\Http\Factories\UriFactoryTrait">UriFactoryTrait</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Http.Factories/Classes/UriFactoryTrait.php#L18">at line 18</a></div>
<abbr title="Neos\Http\Factories\UriFactoryTrait">UriFactoryTrait</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Http.Factories/Classes/UriFactoryTrait.php#L17">at line 17</a></div>
<code> <abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr>
<strong>createUri</strong>(string $uri = &#039;&#039;)
</code>
Expand Down
2 changes: 1 addition & 1 deletion flow/9.0/Neos/Http/Factories/UriFactoryTrait.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_createUri">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Http.Factories/Classes/UriFactoryTrait.php#L18">at line 18</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Http.Factories/Classes/UriFactoryTrait.php#L17">at line 17</a></div>
<code> <abbr title="Psr\Http\Message\UriInterface">UriInterface</abbr>
<strong>createUri</strong>(string $uri = &#039;&#039;)
</code>
Expand Down
7 changes: 6 additions & 1 deletion flow/9.0/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -1585,6 +1585,11 @@ <h1>Classes</h1>
<div class="col-md-6">
<a href="Neos/Flow/Http/UploadedFile.html"><abbr title="Neos\Flow\Http\UploadedFile">UploadedFile</abbr></a> </div>
<div class="col-md-6"><p>Generic implementation of the PSR-7 UploadedFileInterface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="Neos/Flow/Http/UriHelper.html"><abbr title="Neos\Flow\Http\UriHelper">UriHelper</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down Expand Up @@ -4935,7 +4940,7 @@ <h1>Classes</h1>
<div class="row">
<div class="col-md-6">
<a href="Neos/Http/Factories/PsrHttpFactory.html"><abbr title="Neos\Http\Factories\PsrHttpFactory">PsrHttpFactory</abbr></a> </div>
<div class="col-md-6"></div>
<div class="col-md-6"><p>A factory that implements all interfaces of PSR 17</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down
9 changes: 6 additions & 3 deletions flow/9.0/doc-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10472,7 +10472,7 @@ <h2 id="letterA">A</h2>
<dd><p>A map of key =&gt; values to be replaced in path patterns.</p></dd><dt>$<a href="Neos/FluidAdaptor/View/TemplatePaths.html#property_packageManager">
<abbr title="Neos\FluidAdaptor\View\TemplatePaths">TemplatePaths</abbr>#packageManager</a> &mdash; <em>Property in class <a href="Neos/FluidAdaptor/View/TemplatePaths.html"><abbr title="Neos\FluidAdaptor\View\TemplatePaths">TemplatePaths</abbr></a></em></dt>
<dd></dd><dt><a href="Neos/Http/Factories/PsrHttpFactory.html"><abbr title="Neos\Http\Factories\PsrHttpFactory">PsrHttpFactory</abbr></a> &mdash; <em>Class in namespace <a href="Neos/Http/Factories.html">Neos\Http\Factories</a></em></dt>
<dd></dd><dt>$<a href="Neos/Kickstarter/Command/KickstartCommandController.html#property_packageManager">
<dd><p>A factory that implements all interfaces of PSR 17</p></dd><dt>$<a href="Neos/Kickstarter/Command/KickstartCommandController.html#property_packageManager">
<abbr title="Neos\Kickstarter\Command\KickstartCommandController">KickstartCommandController</abbr>#packageManager</a> &mdash; <em>Property in class <a href="Neos/Kickstarter/Command/KickstartCommandController.html"><abbr title="Neos\Kickstarter\Command\KickstartCommandController">KickstartCommandController</abbr></a></em></dt>
<dd></dd><dt><a href="Neos/Kickstarter/Command/KickstartCommandController.html#method_packageCommand">
<abbr title="Neos\Kickstarter\Command\KickstartCommandController">KickstartCommandController</abbr>::packageCommand</a>() &mdash; <em>Method in class <a href="Neos/Kickstarter/Command/KickstartCommandController.html"><abbr title="Neos\Kickstarter\Command\KickstartCommandController">KickstartCommandController</abbr></a></em></dt>
Expand Down Expand Up @@ -13556,7 +13556,8 @@ <h2 id="letterA">A</h2>
<dd><p>Returns an Uri object with the query string being generated from the array of arguments given</p></dd><dt><a href="Neos/Flow/Http/Middleware/TrustedProxiesMiddleware.html#method_unquoteArray">
<abbr title="Neos\Flow\Http\Middleware\TrustedProxiesMiddleware">TrustedProxiesMiddleware</abbr>::unquoteArray</a>() &mdash; <em>Method in class <a href="Neos/Flow/Http/Middleware/TrustedProxiesMiddleware.html"><abbr title="Neos\Flow\Http\Middleware\TrustedProxiesMiddleware">TrustedProxiesMiddleware</abbr></a></em></dt>
<dd></dd><dt><a href="Neos/Flow/Http/UploadedFile.html"><abbr title="Neos\Flow\Http\UploadedFile">UploadedFile</abbr></a> &mdash; <em>Class in namespace <a href="Neos/Flow/Http.html">Neos\Flow\Http</a></em></dt>
<dd><p>Generic implementation of the PSR-7 UploadedFileInterface.</p></dd><dt><a href="Neos/Flow/Http/UriTemplate.html"><abbr title="Neos\Flow\Http\UriTemplate">UriTemplate</abbr></a> &mdash; <em>Class in namespace <a href="Neos/Flow/Http.html">Neos\Flow\Http</a></em></dt>
<dd><p>Generic implementation of the PSR-7 UploadedFileInterface.</p></dd><dt><a href="Neos/Flow/Http/UriHelper.html"><abbr title="Neos\Flow\Http\UriHelper">UriHelper</abbr></a> &mdash; <em>Class in namespace <a href="Neos/Flow/Http.html">Neos\Flow\Http</a></em></dt>
<dd></dd><dt><a href="Neos/Flow/Http/UriTemplate.html"><abbr title="Neos\Flow\Http\UriTemplate">UriTemplate</abbr></a> &mdash; <em>Class in namespace <a href="Neos/Flow/Http.html">Neos\Flow\Http</a></em></dt>
<dd><p>Represents a URI Template as per <a href="http://tools.ietf.org/html/rfc6570">http://tools.ietf.org/html/rfc6570</a></p></dd><dt><a href="Neos/Flow/I18n/Cldr/Reader/Exception/UnableToFindFormatException.html"><abbr title="Neos\Flow\I18n\Cldr\Reader\Exception\UnableToFindFormatException">UnableToFindFormatException</abbr></a> &mdash; <em>Class in namespace <a href="Neos/Flow/I18n/Cldr/Reader/Exception.html">Neos\Flow\I18n\Cldr\Reader\Exception</a></em></dt>
<dd><p>The &quot;Unable To Find Format&quot; exception</p></dd><dt><a href="Neos/Flow/I18n/Cldr/Reader/Exception/UnsupportedNumberFormatException.html"><abbr title="Neos\Flow\I18n\Cldr\Reader\Exception\UnsupportedNumberFormatException">UnsupportedNumberFormatException</abbr></a> &mdash; <em>Class in namespace <a href="Neos/Flow/I18n/Cldr/Reader/Exception.html">Neos\Flow\I18n\Cldr\Reader\Exception</a></em></dt>
<dd><p>The &quot;Unsupported Number Format&quot; exception</p></dd><dt><a href="Neos/Flow/I18n/Exception/UnknownFormatterException.html"><abbr title="Neos\Flow\I18n\Exception\UnknownFormatterException">UnknownFormatterException</abbr></a> &mdash; <em>Class in namespace <a href="Neos/Flow/I18n/Exception.html">Neos\Flow\I18n\Exception</a></em></dt>
Expand Down Expand Up @@ -13934,7 +13935,9 @@ <h2 id="letterA">A</h2>
<abbr title="Neos\Flow\Http\ContentStream">ContentStream</abbr>::write</a>() &mdash; <em>Method in class <a href="Neos/Flow/Http/ContentStream.html"><abbr title="Neos\Flow\Http\ContentStream">ContentStream</abbr></a></em></dt>
<dd><p>Write data to the stream.</p></dd><dt><a href="Neos/Flow/Http/UploadedFile.html#method_writeFile">
<abbr title="Neos\Flow\Http\UploadedFile">UploadedFile</abbr>::writeFile</a>() &mdash; <em>Method in class <a href="Neos/Flow/Http/UploadedFile.html"><abbr title="Neos\Flow\Http\UploadedFile">UploadedFile</abbr></a></em></dt>
<dd><p>Write the uploaded file to the given path.</p></dd><dt>$<a href="Neos/Flow/Mvc/RequestMatcher.html#property_weight">
<dd><p>Write the uploaded file to the given path.</p></dd><dt><a href="Neos/Flow/Http/UriHelper.html#method_withAdditionalQueryParameters">
<abbr title="Neos\Flow\Http\UriHelper">UriHelper</abbr>::withAdditionalQueryParameters</a>() &mdash; <em>Method in class <a href="Neos/Flow/Http/UriHelper.html"><abbr title="Neos\Flow\Http\UriHelper">UriHelper</abbr></a></em></dt>
<dd><p>Merges recursively into the current {UriInterface::getQuery} these additional query parameters.</p></dd><dt>$<a href="Neos/Flow/Mvc/RequestMatcher.html#property_weight">
<abbr title="Neos\Flow\Mvc\RequestMatcher">RequestMatcher</abbr>#weight</a> &mdash; <em>Property in class <a href="Neos/Flow/Mvc/RequestMatcher.html"><abbr title="Neos\Flow\Mvc\RequestMatcher">RequestMatcher</abbr></a></em></dt>
<dd><p>The weight is a value that's added up through
various matching functions in here. This is
Expand Down
2 changes: 1 addition & 1 deletion flow/9.0/doctum-search.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion flow/9.0/doctum.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion flow/9.0/renderer.index

Large diffs are not rendered by default.

0 comments on commit 3143e46

Please sign in to comment.