Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Property Mapper from Extbase Fluid Book #2074

Merged
merged 4 commits into from
Aug 25, 2022
Merged

Conversation

linawolf
Copy link
Member

Releases: main, 11.5

linawolf added a commit to TYPO3-Documentation/TYPO3CMS-Book-ExtbaseFluid that referenced this pull request Aug 17, 2022
Copy link
Contributor

@brotkrueml brotkrueml left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if the PropertyMapping should go under the Controller folder. As I have no experience with property mapping by now, I assume it can also be used independent of a controller. Maybe "Model / Domain" would be better as it is about mapping of models?

linawolf added a commit to TYPO3-Documentation/TYPO3CMS-Book-ExtbaseFluid that referenced this pull request Aug 18, 2022
github-actions bot pushed a commit to TYPO3-Documentation/TYPO3CMS-Book-ExtbaseFluid that referenced this pull request Aug 18, 2022
linawolf added a commit to TYPO3-Documentation/TYPO3CMS-Book-ExtbaseFluid that referenced this pull request Aug 18, 2022
@linawolf
Copy link
Member Author

I am not sure if the PropertyMapping should go under the Controller folder. As I have no experience with property mapping by now, I assume it can also be used independent of a controller. Maybe "Model / Domain" would be better as it is about mapping of models?

I think Property Mapping is one very important feature of the Extbase Controller. One of the things that makes it so useful.

@brotkrueml
Copy link
Contributor

I think Property Mapping is one very important feature of the Extbase Controller. One of the things that makes it so useful.

Fine, then I have to dig into and use it :-)

linawolf and others added 3 commits August 20, 2022 08:55
Remove Example "Allow mapping of sub-properties"

here is no method propertyMappingConfigurationBuilder in the Abstract Controller anymore and the PropertyMappingConfigurationBuilder is internal. Therefore removing the section for now
@linawolf linawolf requested a review from brotkrueml August 20, 2022 11:13
Copy link
Contributor

@brotkrueml brotkrueml left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the blog_example to be used here. First: The code is not found in the blog_example repository. Second: It introduces dependencies (like the AbstractController from blog_example) which are not necessary for this chapter. Maybe we should provide the code snippets via EXT:examples or just describe it with "my_extension" without generating snippets automatically. What do you think?

I also suggest to integrate the second snippet (injection) into the first one with proper comments.

@linawolf
Copy link
Member Author

The code is found in the blog_example for v12. The snippets where automatically created from them.

Taking the code-snippets from the extension gurantees that they contain valid PHP and can be testet. Also it is the same example used all over. So readers don't have to get used to another extension just for the property mapper.

Yeah, dont like that AbstractController either, I will get rid of it in one of the next steps. Then this example will automatically change as well.

@linawolf linawolf requested a review from brotkrueml August 23, 2022 18:50
@linawolf linawolf merged commit 3c74441 into main Aug 25, 2022
@linawolf linawolf deleted the lwolf-move-property-mapper branch August 25, 2022 08:40
@github-actions
Copy link
Contributor

The backport to 11.5 failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply 53712e56... Include real code
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

stdout
[backport-2074-to-11.5 b5a0f7d5] Move Property Mapper from Extbase Fluid Book
 Author: lina.wolf <[email protected]>
 Date: Wed Aug 17 16:34:35 2022 +0200
 1 file changed, 105 insertions(+)
 create mode 100644 Documentation/ExtensionArchitecture/Extbase/Reference/Controller/PropertyMapping.rst
[backport-2074-to-11.5 08b2f7df] Update Documentation/ExtensionArchitecture/Extbase/Reference/Controller/PropertyMapping.rst
 Author: Lina Wolf <[email protected]>
 Date: Sat Aug 20 08:55:30 2022 +0200
 1 file changed, 1 insertion(+), 1 deletion(-)
Auto-merging Documentation/CodeSnippets/Config/Extbase.php
CONFLICT (content): Merge conflict in Documentation/CodeSnippets/Config/Extbase.php

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-11.5 11.5
# Navigate to the new working tree
cd .worktrees/backport-11.5
# Create a new branch
git switch --create backport-2074-to-11.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick e6a3a384274e9d70cc862320bcc3292d85dcbf08,01a41812ff9375279a5c08855573a63a3fe7828b,53712e564a67784dd90fd5e6db67fd44655f4f9e,b3705a0d75c272eea9f8af53b6cc329bd44340b2
# Push it to GitHub
git push --set-upstream origin backport-2074-to-11.5
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-11.5

Then, create a pull request where the base branch is 11.5 and the compare/head branch is backport-2074-to-11.5.

tromboman added a commit to tromboman/TYPO3CMS-Book-ExtbaseFluid that referenced this pull request Sep 21, 2022
* Typo (duplicate word) (TYPO3-Documentation#502)

* Make Extbase relevant SQL field names more prominent (TYPO3-Documentation#509)

The information about using lowercase_underscore and the corresponding Extbase model mapped attributes is too hidden in this sentence.
This should be more prominent as info section

* [TASK] Update hints of Extension Builder

The Extension Builder extension has been revised this year,
including its documentation. Reflect these changes in the
official manuals.

* [BUGFIX] Fix all reST rendering warnings

* [TASK] Reword "Installation & Setup" page

* [TASK] Remove return type from model constructor (TYPO3-Documentation#510)

A constructor does not have a return type.

* [BUGFIX] Fix spelling (TYPO3-Documentation#512)

Registrating -> Registering

* extension name and not extension key (TYPO3-Documentation#513)

* fix typo (TYPO3-Documentation#514)

* [TASK] Align with new TYPO3 documentation standards (TYPO3-Documentation#516)

- align README.rst, Settings.cfg, Index.rst, Includes.rst.txt, genindex.rst
- move Sitemap/Index.rst to Sitemap.rst and align
- fix rendering warnings
- remove outdated Targets.rst

See TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument@c2bb63b for further details.

* [DOCS] Replace :ts: with :typoscript: text role (TYPO3-Documentation#521)

The ambiguous :ts: text role has been removed to
not confuse the writer with typescript and typoscript.

* [BREAKING] Extbase validator interface changed (TYPO3-Documentation#522)

* [BREAKING] Extbase validator interface changed

https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Breaking-96998-ExtbaseValidatorInterfaceChanged.html

refs TYPO3-Documentation/TYPO3CMS-Reference-CoreApi#1624

* [BREAKING] TYPO3 Frontend always rendered in UTF-8

https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Breaking-97065-TYPO3FrontendAlwaysRenderedInUTF-8.html

refs TYPO3-Documentation/TYPO3CMS-Reference-CoreApi#1624

Co-authored-by: lina.wolf <[email protected]>

* [TASK] introduce backport workflow (TYPO3-Documentation#524)

Co-authored-by: lina.wolf <[email protected]>

* [DOCS] Reference manual's start page with :doc:`<manual>:Index` (TYPO3-Documentation#523)

Adding the custom label `start` to the beginning of the manual's
Index.rst is redundant. Use :doc:`<manual>:Index` instead of
:ref:`<manual:start>` to refer to it.

* [TASK] Add captions to code-blocks (TYPO3-Documentation#94) (TYPO3-Documentation#525)

* [TASK] Add captions to code-blocks (TYPO3-Documentation#94)

to make it more clear where code should go

Releases: main, 11.5

* Update 4-Property-mapping.rst

* Update 6-adding-the-template.rst

Co-authored-by: lina.wolf <[email protected]>
Co-authored-by: Tom Warwick <[email protected]>

* [TASK] Remove templating tutorial from Settings.cfg (TYPO3-Documentation#526)

As information got moved to the sitepackage tutorial

Co-authored-by: lina.wolf <[email protected]>

* Remove outdated information (TYPO3-Documentation#528)

* [TASK] #96972 - Deprecate QueryBuilder::execute() (TYPO3-Documentation#530)

Related: TYPO3-Documentation/Changelog-To-Doc#38

Additionally, fetchAll() is renamed to fetchAllAssociative() for compatibility
with DBAL 3.2:
https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Breaking-96287-DoctrineDBAL32.html

* Remove warning (TYPO3-Documentation#531)

Remove warning on the page "Individual database query". This warning
comes right in the middle of explaing the order and Extbase execute()
and uses Doctrine DBAL persistence without really explaining why.

This made the already lengthy page confusing without really making
it clear why this warning exists.

If there is the need to use QueryBuilder database persistence
functionality it is probably best to introduce this and handle it
on a separate page.

Resolves: TYPO3-Documentation#240

Co-authored-by: Sybille Peters <[email protected]>

* [TASK] Fix formatting for lists (TYPO3-Documentation#534)

This fixes a rendering problem where the list is not rendered
as list.

Releases: master, 11.5

* !!![TASK] Remove Fluid inline syntax (TYPO3-Documentation#537)

!!! redirects must be created.

Text about Fluid inline syntax was shortened and moved to
TYPO3 Explained. The page on inline syntax is now removed.
References are updated to link to new content.

Related: TYPO3-Documentation#536

* !!![WIP]Remove page "Developing a custom ViewHelper" (TYPO3-Documentation#539)

! redirects must be created
! cross references in other manuals must be fixed

The content was moved to TYPO3 Explained. All cross references
have been adapted.

Related: TYPO3-Documentation#536

* [TASK] Remove $_EXTKEY (TYPO3-Documentation#541)

It is discouraged to use this as it will be remove in the future,
see changelog
https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/9.0/Important-82692-GuidelinesForExtensionFiles.html

* Remove cObject ViewHelper page (TYPO3-Documentation#542)

The page was not specific to Extbase and has been removed to
"TYPO3 Explained".

Related: TYPO3-Documentation#536

* [TASK] Remove section about comments (TYPO3-Documentation#544)

This section has been migrated to the Fluid syntax
page in TYPO3 Explained

Related: TYPO3-Documentation#536

* [TASK] Remove information about sjr_offers from start page (TYPO3-Documentation#546)

The reason is:

- sjr_offers is one of 3 extensions used in this manual
- the information which example extensions is used is not so
  relevant
- sjr_offers is outdated (only available up to 6.2) and should
  ideally not be used at all

We cannot remove all references to sjr_offers since that is
too much woven into the examples, but we can remove it from the
start page for now.

* [TASK] Remove boolean conditions from Fluid (TYPO3-Documentation#549)

The content has been migrated to "TYPO3 Explained".

Related: TYPO3-Documentation#536

* [TASK] Add note for migrating Fluid (TYPO3-Documentation#551)

Related: TYPO3-Documentation#536

* [TASK] Remove Fluid partials (TYPO3-Documentation#554)

* [TASK] Remove Fluid partials

The content is removed and a note added, linking to TYPO3 Explained.

Related: TYPO3-Documentation#536

* Update 3-moving-repeating-snippets-to-partials.rst

Co-authored-by: Tom Warwick <[email protected]>

* [BUGFIX] Correct layout of query settings table (TYPO3-Documentation#556)

Releases: main, 11.5, 10.4

* [TASK] Remove content for layouts (TYPO3-Documentation#553)

Add a link to TYPO3 Explained.

Related: TYPO3-Documentation#536

* [FEATURE] #98024 - Remove TCA option "cruser_id" (TYPO3-Documentation#555)

Related: TYPO3-Documentation/Changelog-To-Doc#139

* [!!! TASK] Move Extbase Reference to TYPO3 Explained (TYPO3-Documentation#561)

* [!!! TASK] Move Extbase Reference to TYPO3 Explained

* Move information on Extbase validation to TYPO3 Explained

Co-authored-by: lina.wolf <[email protected]>

* [TASK] Correct spelling of TYPO3 versions (TYPO3-Documentation#562)

Related: TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument#295

Releases: main, 11.5

* Remove the outdated "inventory" extension (TYPO3-Documentation#564)

* Remove all traces of the outdated "inventory" extension. The information has been moved to TYPO3 Explained where still of interest. I will create redirects.

Releases: main, 11.5

* Remove the chapter from the menu

Co-authored-by: lina.wolf <[email protected]>

* Remove the Blog-Example Tutorial (TYPO3-Documentation#566)

Most of the information is severely outdated. What was still of value was moved to TYPO3 Explained. The Content can still be viewed in older Versions of this Book

Co-authored-by: lina.wolf <[email protected]>

* Move Property Mapper to TYPO3 Explained (TYPO3-Documentation#568)

refs TYPO3-Documentation/TYPO3CMS-Reference-CoreApi#2074

Releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Move section on programming secure extensions to TYPO3 Explained (TYPO3-Documentation#565)

Delete the conclusion and missleading titles

Co-authored-by: lina.wolf <[email protected]>

* Remove Outdated chapters (TYPO3-Documentation#567)

* Remove Outdated chapters

Leave a hint on what is happening with this book.

Releases: main, 11.5

* Update Documentation/About.rst

* Update Documentation/About.rst

* Update Documentation/Index.rst

* Update Documentation/Index.rst

Co-authored-by: lina.wolf <[email protected]>
Co-authored-by: Chris Müller <[email protected]>

* Change default rst indentation to 4 spaces (TYPO3-Documentation#572)

refs TYPO3-Documentation/T3DocTeam#194

* Remove Installation and Introduction chapters (TYPO3-Documentation#575)

redirects are already in place

releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Move localization chapter to TYPO3 Explained (TYPO3-Documentation#577)

Co-authored-by: lina.wolf <[email protected]>

* Move configuration chapter to TYPO3 explained

Redirects are already in place

releases: main, 11.5

* Move coding guidelines (file structure rather) (TYPO3-Documentation#579)

to TYPO3 Explained

Redirects are in place

releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Move Persistence chapters to TYPO3 Explained. (TYPO3-Documentation#581)

https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ExtensionArchitecture/Extbase/Reference/Domain/Model.html

Redirects are already in place

Releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Move "Implementing the domain model" to TYPO3 Explained. (TYPO3-Documentation#580)

https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ExtensionArchitecture/Extbase/Reference/Domain/Model.html

Redirect is already in place

Releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Move chapter on on general principles (TYPO3-Documentation#582)

to typo3 explained

Releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Move Controler chapter to TYPO3 Explained. (TYPO3-Documentation#583)

Redirect is already in place

Releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Move Error Action to T3 Explained (TYPO3-Documentation#585)

remove FAQ chapter, already moved

Redirects are in place

releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Display warning about outdated docs on every page (TYPO3-Documentation#586)

Co-authored-by: lina.wolf <[email protected]>

* Move fluid chapters, (TYPO3-Documentation#588)

redirects are already in place

releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Remove last chapters (TYPO3-Documentation#589)

redirects are already in place

releases: main, 11.5

Co-authored-by: lina.wolf <[email protected]>

* Close Extbase Book

Co-authored-by: Thomas Löffler <[email protected]>
Co-authored-by: Alexander Nitsche <[email protected]>
Co-authored-by: Tom Warwick <[email protected]>
Co-authored-by: twojtylak <[email protected]>
Co-authored-by: Luca Kredel <[email protected]>
Co-authored-by: Franz Holzinger <[email protected]>
Co-authored-by: Lina Wolf <[email protected]>
Co-authored-by: lina.wolf <[email protected]>
Co-authored-by: Chris Müller <[email protected]>
Co-authored-by: Sybille Peters <[email protected]>
Co-authored-by: Sybille Peters <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants