Skip to content

Commit

Permalink
[TASK] Update codesnippets (TYPO3-Documentation#4819)
Browse files Browse the repository at this point in the history
Releases: main
  • Loading branch information
linawolf authored Oct 12, 2024
1 parent bc15c93 commit d85cac9
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
:caption: EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript
@import 'EXT:site_package/Configuration/TypoScript/Setup/*.typoscript'
@import 'EXT:site_package/Configuration/TypoScript/Setup/Navigation/*.typoscript'
8 changes: 8 additions & 0 deletions Documentation/CodeSnippets/Extbase/Api/Repository.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
:param $persistenceManager: the persistenceManager

.. php:method:: injectEventDispatcher(\Psr\EventDispatcher\EventDispatcherInterface $eventDispatcher)
:param $eventDispatcher: the eventDispatcher

.. php:method:: injectFeatures(\TYPO3\CMS\Core\Configuration\Features $features)
:param $features: the features

.. php:method:: add(?object $object)
Adds an object to this repository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,21 @@
.. code-block:: typoscript
:caption: EXT:blog_example/Configuration/Sets/RssFeed/setup.typoscript
plugin.tx_blogexample {
settings {
rss {
channel {
typeNum = {$blogExampleRss.page_type}
title = {$blogExampleRss.title}
}
}
}
}
# RSS rendering
tx_blogexample_rss = PAGE
tx_blogexample_rss {
typeNum = {$plugin.tx_blogexample.settings.rssPageType}
10 < tt_content.list.20.blogexample_postlistrss
typeNum = {$blogExampleRss.page_type}
10 < tt_content.blogexample_postlistrss
config {
disableAllHeaderCode = 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
:returns: `string`

Dedicated method for rendering preview header HTML for
the page module only. Receives the the GridColumnItem
the page module only. Receives the GridColumnItem
that contains the record for which a preview header
should be rendered and returned.

Expand All @@ -33,7 +33,7 @@
:returns: `string`

Dedicated method for rendering preview body HTML for
the page module only. Receives the the GridColumnItem
the page module only. Receives the GridColumnItem
that contains the record for which a preview should be
rendered and returned.

Expand Down
2 changes: 2 additions & 0 deletions Documentation/CodeSnippets/Manual/Core/SiteFinder.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@
:param $pageId: the pageId
:param $rootLine: the rootLine, default: NULL
:param $mountPointParameter: the mountPointParameter, default: NULL

.. php:method:: siteConfigurationChanged()
6 changes: 6 additions & 0 deletions Documentation/CodeSnippets/Manual/Entity/Site.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
Entity representing a single site with available languages

.. php:attr:: invalidSets
:public:

.. php:method:: getIdentifier()
:returns: `string`

Expand Down Expand Up @@ -65,6 +68,9 @@

Returns the whole configuration for this site

.. php:method:: getRawConfiguration()
:returns: `array`

.. php:method:: getSettings()
:returns: `\TYPO3\CMS\Core\Site\Entity\SiteSettings`

Expand Down
11 changes: 7 additions & 4 deletions Documentation/CodeSnippets/Manual/Entity/SiteSettings.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,19 @@
.. php:method:: getAll()
:returns: `array`

.. php:method:: getMap()
:returns: `array`

.. php:method:: getAllFlat()
:returns: `array`

.. php:method:: jsonSerialize()
:returns: `?mixed`

.. php:method:: getIdentifiers()
:returns: `array`

.. php:method:: __set_state(array $state)
:returns: `self`
:returns: `static`

:param $state: the state

.. php:method:: getIdentifiers()
:returns: `array`

0 comments on commit d85cac9

Please sign in to comment.