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
neos-bot committed Apr 1, 2024
1 parent c28840b commit c9d7531
Show file tree
Hide file tree
Showing 8 changed files with 72 additions and 255 deletions.
83 changes: 19 additions & 64 deletions flow/9.0/Neos/Flow/Composer/ComposerUtility.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,17 @@ <h1>ComposerUtility




<table>
<tr>
<td><span class="label label-warning">internal</span></td>
<td>&nbsp;Only meant to be used only inside the Flow package management code.</td>
</tr>
</table>
&nbsp;


<div class="description">
<p><p>Utility to access composer information like composer manifests (composer.json) and the lock file.</p></p> <p><p>Meant to be used only inside the Flow package management code.</p></p> </div>
<p><p>Utility to access composer information like composer manifests (composer.json) and the lock file.</p></p> </div>



Expand Down Expand Up @@ -168,23 +175,13 @@ <h2>Methods</h2>

<p><p>Checks if the given (composer) package type is a type native to the neos project.</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_getComposerPackageNameFromPackageKey">getComposerPackageNameFromPackageKey</a>(string $packageKey)

<p><p>Determines the composer package name (&quot;vendor/foo-bar&quot;) from the Flow package key (&quot;Vendor.Foo.Bar&quot;)</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static&nbsp;array
</div>
<div class="col-md-8">
<a href="#method_writeComposerManifest">writeComposerManifest</a>(string $manifestPath, string $packageKey, array $composerManifestData = [])
<a href="#method_writeComposerManifest">writeComposerManifest</a>(string $manifestPath, <abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr> $packageKey, array $composerManifestData = [])

<p><p>Write a composer manifest for the package.</p></p> </div>
<div class="col-md-2"></div>
Expand Down Expand Up @@ -218,7 +215,7 @@ <h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_getComposerManifest">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L46">at line 46</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L47">at line 47</a></div>
<code> static array|mixed
<strong>getComposerManifest</strong>(string $manifestPath, string $configurationPath = null)
</code>
Expand Down Expand Up @@ -265,7 +262,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_readComposerLock">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L64">at line 64</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L65">at line 65</a></div>
<code> static array
<strong>readComposerLock</strong>()
</code>
Expand Down Expand Up @@ -297,7 +294,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_readComposerManifest">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L90">at line 90</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L91">at line 91</a></div>
<code> static protected array
<strong>readComposerManifest</strong>(string $manifestPath)
</code>
Expand Down Expand Up @@ -348,7 +345,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_isFlowPackageType">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L117">at line 117</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L118">at line 118</a></div>
<code> static bool
<strong>isFlowPackageType</strong>(string $packageType)
</code>
Expand Down Expand Up @@ -384,57 +381,15 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_getComposerPackageNameFromPackageKey">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L134">at line 134</a></div>
<code> static string
<strong>getComposerPackageNameFromPackageKey</strong>(string $packageKey)
</code>
</h3>
<div class="details">



<div class="method-description">
<p><p>Determines the composer package name (&quot;vendor/foo-bar&quot;) from the Flow package key (&quot;Vendor.Foo.Bar&quot;)</p></p>
</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td>$packageKey</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_writeComposerManifest">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L149">at line 149</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L137">at line 137</a></div>
<code> static array
<strong>writeComposerManifest</strong>(string $manifestPath, string $packageKey, array $composerManifestData = [])
<strong>writeComposerManifest</strong>(string $manifestPath, <abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr> $packageKey, array $composerManifestData = [])
</code>
</h3>
<div class="details">
Expand All @@ -454,7 +409,7 @@ <h4>Parameters</h4>
<td></td>
</tr>
<tr>
<td>string</td>
<td><abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr></td>
<td>$packageKey</td>
<td></td>
</tr>
Expand Down Expand Up @@ -484,7 +439,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getPackageVersion">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L190">at line 190</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L178">at line 178</a></div>
<code> static string
<strong>getPackageVersion</strong>(string $composerName)
</code>
Expand Down Expand Up @@ -538,7 +493,7 @@ <h4>See also</h4>
</div>
<div class="method-item">
<h3 id="method_flushCaches">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L209">at line 209</a></div>
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Composer/ComposerUtility.php#L197">at line 197</a></div>
<code> static void
<strong>flushCaches</strong>()
</code>
Expand Down
12 changes: 6 additions & 6 deletions flow/9.0/Neos/Flow/Package/FlowPackageInterface.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ <h2>Details</h2>
<div class="method-item">
<h3 id="method_getClassFiles">
<div class="location">in <a href="../../../Neos/Flow/Package/PackageInterface.html#method_getClassFiles">
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L30">at line 30</a></div>
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L31">at line 31</a></div>
<code> <abbr title="Neos\Flow\Package\iterable">iterable</abbr>
<strong>getClassFiles</strong>()
</code>
Expand Down Expand Up @@ -314,7 +314,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_getComposerName">
<div class="location">in <a href="../../../Neos/Flow/Package/PackageInterface.html#method_getComposerName">
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L38">at line 38</a></div>
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L39">at line 39</a></div>
<code> string
<strong>getComposerName</strong>()
</code>
Expand Down Expand Up @@ -347,7 +347,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_getNamespaces">
<div class="location">in <a href="../../../Neos/Flow/Package/PackageInterface.html#method_getNamespaces">
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L46">at line 46</a></div>
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L47">at line 47</a></div>
<code> array
<strong>getNamespaces</strong>()
</code>
Expand Down Expand Up @@ -380,7 +380,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_getPackagePath">
<div class="location">in <a href="../../../Neos/Flow/Package/PackageInterface.html#method_getPackagePath">
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L54">at line 54</a></div>
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L55">at line 55</a></div>
<code> string
<strong>getPackagePath</strong>()
</code>
Expand Down Expand Up @@ -413,7 +413,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_getInstalledVersion">
<div class="location">in <a href="../../../Neos/Flow/Package/PackageInterface.html#method_getInstalledVersion">
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L63">at line 63</a></div>
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L64">at line 64</a></div>
<code> string
<strong>getInstalledVersion</strong>()
</code>
Expand Down Expand Up @@ -446,7 +446,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_getComposerManifest">
<div class="location">in <a href="../../../Neos/Flow/Package/PackageInterface.html#method_getComposerManifest">
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L73">at line 73</a></div>
<abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a> <a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageInterface.php#L74">at line 74</a></div>
<code> mixed
<strong>getComposerManifest</strong>(string $key = null)
</code>
Expand Down
20 changes: 10 additions & 10 deletions flow/9.0/Neos/Flow/Package/PackageFactory.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,10 @@ <h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
<a href="../../../Neos/Flow/Package/PackageInterface.html"><abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a>|<a href="../../../Neos/Flow/Package/PackageKeyAwareInterface.html"><abbr title="Neos\Flow\Package\PackageKeyAwareInterface">PackageKeyAwareInterface</abbr></a>
<a href="../../../Neos/Flow/Package/PackageInterface.html"><abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a>
</div>
<div class="col-md-8">
<a href="#method_create">create</a>(string $packagesBasePath, string $packagePath, string $packageKey, string $composerName, array $autoloadConfiguration = [], array $packageClassInformation = null)
<a href="#method_create">create</a>(string $packagesBasePath, string $packagePath, <abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr> $packageKey, string $composerName, array $autoloadConfiguration = [], array $packageClassInformation = null)

<p><p>Returns a package instance.</p></p> </div>
<div class="col-md-2"></div>
Expand All @@ -121,7 +121,7 @@ <h2>Methods</h2>
array
</div>
<div class="col-md-8">
<a href="#method_detectFlowPackageFilePath">detectFlowPackageFilePath</a>(string $packageKey, string $absolutePackagePath)
<a href="#method_detectFlowPackageFilePath">detectFlowPackageFilePath</a>(<abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr> $packageKey, string $absolutePackagePath)

<p><p>Detects if the package contains a package file and returns the path and classname.</p></p> </div>
<div class="col-md-2"></div>
Expand All @@ -135,8 +135,8 @@ <h2>Details</h2>
<div class="method-item">
<h3 id="method_create">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageFactory.php#L35">at line 35</a></div>
<code> <a href="../../../Neos/Flow/Package/PackageInterface.html"><abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a>|<a href="../../../Neos/Flow/Package/PackageKeyAwareInterface.html"><abbr title="Neos\Flow\Package\PackageKeyAwareInterface">PackageKeyAwareInterface</abbr></a>
<strong>create</strong>(string $packagesBasePath, string $packagePath, string $packageKey, string $composerName, array $autoloadConfiguration = [], array $packageClassInformation = null)
<code> <a href="../../../Neos/Flow/Package/PackageInterface.html"><abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a>
<strong>create</strong>(string $packagesBasePath, string $packagePath, <abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr> $packageKey, string $composerName, array $autoloadConfiguration = [], array $packageClassInformation = null)
</code>
</h3>
<div class="details">
Expand All @@ -161,7 +161,7 @@ <h4>Parameters</h4>
<td><p>path to package, relative to base path</p></td>
</tr>
<tr>
<td>string</td>
<td><abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr></td>
<td>$packageKey</td>
<td><p>key / name of the package</p></td>
</tr>
Expand All @@ -187,7 +187,7 @@ <h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td><a href="../../../Neos/Flow/Package/PackageInterface.html"><abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a>|<a href="../../../Neos/Flow/Package/PackageKeyAwareInterface.html"><abbr title="Neos\Flow\Package\PackageKeyAwareInterface">PackageKeyAwareInterface</abbr></a></td>
<td><a href="../../../Neos/Flow/Package/PackageInterface.html"><abbr title="Neos\Flow\Package\PackageInterface">PackageInterface</abbr></a></td>
<td></td>
</tr>
</table>
Expand All @@ -212,7 +212,7 @@ <h4>Exceptions</h4>
<h3 id="method_detectFlowPackageFilePath">
<div class="location"><a href="https://github.com/neos/flow-development-collection/blob/9.0/Neos.Flow/Classes/Package/PackageFactory.php#L70">at line 70</a></div>
<code> array
<strong>detectFlowPackageFilePath</strong>(string $packageKey, string $absolutePackagePath)
<strong>detectFlowPackageFilePath</strong>(<abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr> $packageKey, string $absolutePackagePath)
</code>
</h3>
<div class="details">
Expand All @@ -227,7 +227,7 @@ <h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td><abbr title="Neos\Flow\Package\FlowPackageKey">FlowPackageKey</abbr></td>
<td>$packageKey</td>
<td><p>The package key</p></td>
</tr>
Expand All @@ -244,7 +244,7 @@ <h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>array</td>
<td><p>The path to the package file and classname for this package or an empty array if none was found.</p></td>
<td></td>
</tr>
</table>

Expand Down
Loading

0 comments on commit c9d7531

Please sign in to comment.