Skip to content

Commit

Permalink
TASK: Update API docs from 8.1
Browse files Browse the repository at this point in the history
  • Loading branch information
neos-bot committed Oct 21, 2023
1 parent 35f9ca9 commit 950c378
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_discardNodes">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L207">at line 207</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L210">at line 210</a></div>
<code> void
<strong>discardNodes</strong>(array $nodes)
</code>
Expand Down Expand Up @@ -617,7 +617,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_discardAllNodes">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L225">at line 225</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L228">at line 228</a></div>
<code> void
<strong>discardAllNodes</strong>(<a href="../../../../Neos/ContentRepository/Domain/Model/Workspace.html"><abbr title="Neos\ContentRepository\Domain\Model\Workspace">Workspace</abbr></a> $workspace)
</code>
Expand Down Expand Up @@ -668,7 +668,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_sortNodesForPublishing">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L246">at line 246</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L249">at line 249</a></div>
<code> protected array
<strong>sortNodesForPublishing</strong>(array $nodes)
</code>
Expand Down Expand Up @@ -719,7 +719,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_emitNodePublished">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L264">at line 264</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L267">at line 267</a></div>
<code> void
<strong>emitNodePublished</strong>(<a href="../../../../Neos/ContentRepository/Domain/Model/NodeInterface.html"><abbr title="Neos\ContentRepository\Domain\Model\NodeInterface">NodeInterface</abbr></a> $node, <a href="../../../../Neos/ContentRepository/Domain/Model/Workspace.html"><abbr title="Neos\ContentRepository\Domain\Model\Workspace">Workspace</abbr></a> $targetWorkspace = null)
</code>
Expand Down Expand Up @@ -767,7 +767,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_emitNodeDiscarded">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L278">at line 278</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L281">at line 281</a></div>
<code> void
<strong>emitNodeDiscarded</strong>(<a href="../../../../Neos/ContentRepository/Domain/Model/NodeInterface.html"><abbr title="Neos\ContentRepository\Domain\Model\NodeInterface">NodeInterface</abbr></a> $node)
</code>
Expand Down Expand Up @@ -809,7 +809,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_createContext">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L290">at line 290</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L293">at line 293</a></div>
<code> protected <a href="../../../../Neos/ContentRepository/Domain/Service/Context.html"><abbr title="Neos\ContentRepository\Domain\Service\Context">Context</abbr></a>
<strong>createContext</strong>(<a href="../../../../Neos/ContentRepository/Domain/Model/Workspace.html"><abbr title="Neos\ContentRepository\Domain\Model\Workspace">Workspace</abbr></a> $workspace, array $dimensionValues, array $contextProperties = [])
</code>
Expand Down
44 changes: 44 additions & 0 deletions neos/8.1/Neos/Media/Domain/Model/Thumbnail.html
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,17 @@ <h2>Methods</h2>

<p><p>Refreshes this asset after the PersistentResource has been modified</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8">
<a href="#method_getConfigurationHash">getConfigurationHash</a>()

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
</div>

Expand Down Expand Up @@ -1326,6 +1337,39 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_getConfigurationHash">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Model/Thumbnail.php#L228">at line 228</a></div>
<code> string
<strong>getConfigurationHash</strong>()
</code>
</h3>
<div class="details">



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

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

<h4>Return Value</h4>

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




</div>
</div>

Expand Down
16 changes: 8 additions & 8 deletions neos/8.1/Neos/Media/Domain/Service/ThumbnailService.html
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_getPresets">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L167">at line 167</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L175">at line 175</a></div>
<code> array
<strong>getPresets</strong>()
</code>
Expand Down Expand Up @@ -375,7 +375,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getThumbnailConfigurationForPreset">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L178">at line 178</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L186">at line 186</a></div>
<code> <a href="../../../../Neos/Media/Domain/Model/ThumbnailConfiguration.html"><abbr title="Neos\Media\Domain\Model\ThumbnailConfiguration">ThumbnailConfiguration</abbr></a>
<strong>getThumbnailConfigurationForPreset</strong>(string $preset, bool $async = false)
</code>
Expand Down Expand Up @@ -432,7 +432,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_applyFormatToThumbnailConfiguration">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L205">at line 205</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L213">at line 213</a></div>
<code> protected <a href="../../../../Neos/Media/Domain/Model/ThumbnailConfiguration.html"><abbr title="Neos\Media\Domain\Model\ThumbnailConfiguration">ThumbnailConfiguration</abbr></a>
<strong>applyFormatToThumbnailConfiguration</strong>(<a href="../../../../Neos/Media/Domain/Model/ThumbnailConfiguration.html"><abbr title="Neos\Media\Domain\Model\ThumbnailConfiguration">ThumbnailConfiguration</abbr></a> $configuration, string $targetFormat)
</code>
Expand Down Expand Up @@ -480,7 +480,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_refreshThumbnail">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L231">at line 231</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L239">at line 239</a></div>
<code> void
<strong>refreshThumbnail</strong>(<a href="../../../../Neos/Media/Domain/Model/Thumbnail.html"><abbr title="Neos\Media\Domain\Model\Thumbnail">Thumbnail</abbr></a> $thumbnail)
</code>
Expand Down Expand Up @@ -531,7 +531,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_getUriForThumbnail">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L246">at line 246</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L254">at line 254</a></div>
<code> string
<strong>getUriForThumbnail</strong>(<a href="../../../../Neos/Media/Domain/Model/ImageInterface.html"><abbr title="Neos\Media\Domain\Model\ImageInterface">ImageInterface</abbr></a> $thumbnail)
</code>
Expand Down Expand Up @@ -583,7 +583,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_emitThumbnailRefreshed">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L271">at line 271</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L279">at line 279</a></div>
<code> void
<strong>emitThumbnailRefreshed</strong>(<a href="../../../../Neos/Media/Domain/Model/Thumbnail.html"><abbr title="Neos\Media\Domain\Model\Thumbnail">Thumbnail</abbr></a> $thumbnail)
</code>
Expand Down Expand Up @@ -625,7 +625,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_emitThumbnailPersisted">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L282">at line 282</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L290">at line 290</a></div>
<code> void
<strong>emitThumbnailPersisted</strong>(<a href="../../../../Neos/Media/Domain/Model/Thumbnail.html"><abbr title="Neos\Media\Domain\Model\Thumbnail">Thumbnail</abbr></a> $thumbnail)
</code>
Expand Down Expand Up @@ -667,7 +667,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_emitThumbnailCreated">
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L293">at line 293</a></div>
<div class="location"><a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.Media/Classes/Domain/Service/ThumbnailService.php#L301">at line 301</a></div>
<code> protected void
<strong>emitThumbnailCreated</strong>(<a href="../../../../Neos/Media/Domain/Model/Thumbnail.html"><abbr title="Neos\Media\Domain\Model\Thumbnail">Thumbnail</abbr></a> $thumbnail)
</code>
Expand Down
10 changes: 5 additions & 5 deletions neos/8.1/Neos/Neos/Service/PublishingService.html
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_discardAllNodes">
<div class="location">in <a href="../../../Neos/ContentRepository/Domain/Service/PublishingService.html#method_discardAllNodes">
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L225">at line 225</a></div>
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L228">at line 228</a></div>
<code> void
<strong>discardAllNodes</strong>(<a href="../../../Neos/ContentRepository/Domain/Model/Workspace.html"><abbr title="Neos\ContentRepository\Domain\Model\Workspace">Workspace</abbr></a> $workspace)
</code>
Expand Down Expand Up @@ -691,7 +691,7 @@ <h4>Exceptions</h4>
<div class="method-item">
<h3 id="method_sortNodesForPublishing">
<div class="location">in <a href="../../../Neos/ContentRepository/Domain/Service/PublishingService.html#method_sortNodesForPublishing">
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L246">at line 246</a></div>
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L249">at line 249</a></div>
<code> protected array
<strong>sortNodesForPublishing</strong>(array $nodes)
</code>
Expand Down Expand Up @@ -743,7 +743,7 @@ <h4>Exceptions</h4>
<div class="method-item">
<h3 id="method_emitNodePublished">
<div class="location">in <a href="../../../Neos/ContentRepository/Domain/Service/PublishingService.html#method_emitNodePublished">
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L264">at line 264</a></div>
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L267">at line 267</a></div>
<code> void
<strong>emitNodePublished</strong>(<a href="../../../Neos/ContentRepository/Domain/Model/NodeInterface.html"><abbr title="Neos\ContentRepository\Domain\Model\NodeInterface">NodeInterface</abbr></a> $node, <a href="../../../Neos/ContentRepository/Domain/Model/Workspace.html"><abbr title="Neos\ContentRepository\Domain\Model\Workspace">Workspace</abbr></a> $targetWorkspace = null)
</code>
Expand Down Expand Up @@ -792,7 +792,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_emitNodeDiscarded">
<div class="location">in <a href="../../../Neos/ContentRepository/Domain/Service/PublishingService.html#method_emitNodeDiscarded">
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L278">at line 278</a></div>
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L281">at line 281</a></div>
<code> void
<strong>emitNodeDiscarded</strong>(<a href="../../../Neos/ContentRepository/Domain/Model/NodeInterface.html"><abbr title="Neos\ContentRepository\Domain\Model\NodeInterface">NodeInterface</abbr></a> $node)
</code>
Expand Down Expand Up @@ -835,7 +835,7 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_createContext">
<div class="location">in <a href="../../../Neos/ContentRepository/Domain/Service/PublishingService.html#method_createContext">
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L290">at line 290</a></div>
<abbr title="Neos\ContentRepository\Domain\Service\PublishingService">PublishingService</abbr></a> <a href="https://github.com/neos/neos-development-collection/blob/8.1/Neos.ContentRepository/Classes/Domain/Service/PublishingService.php#L293">at line 293</a></div>
<code> protected <a href="../../../Neos/ContentRepository/Domain/Service/Context.html"><abbr title="Neos\ContentRepository\Domain\Service\Context">Context</abbr></a>
<strong>createContext</strong>(<a href="../../../Neos/ContentRepository/Domain/Model/Workspace.html"><abbr title="Neos\ContentRepository\Domain\Model\Workspace">Workspace</abbr></a> $workspace, array $dimensionValues, array $contextProperties = [])
</code>
Expand Down
Loading

0 comments on commit 950c378

Please sign in to comment.