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

TASK: docs and readability of Node::getProperty #4328

Merged
merged 1 commit into from
Nov 20, 2023

Conversation

mhsdesign
Copy link
Member

@mhsdesign mhsdesign commented Jun 11, 2023

This pr incorporates a few cleanups regarding node.properties

Clean up how node::getProperty and hasProperty access the lower level methods.

Make the code more obvious - calling node::getProperty and hasProperty goes into deep rabbit hole until we find the actual implementation. This makes it harder to understand the actual behavior. This also lead to slightly miss documented code:
For example hasProperty might be true for a property even if it is null, because a serializer might unserialize it to null!

I also adjusted the documentation (meta #4478)
As its was actually the same from the old cr and we dont have those funny content object dingsis anymore

Upgrade instructions

Review instructions

Checklist

  • Code follows the PSR-2 coding style
  • Tests have been created, run and adjusted as needed
  • The PR is created against the lowest maintained branch
  • Reviewer - PR Title is brief but complete and starts with FEATURE|TASK|BUGFIX
  • Reviewer - The first section explains the change briefly for change-logs
  • Reviewer - Breaking Changes are marked with !!! and have upgrade-instructions

@mhsdesign mhsdesign changed the title Task: docs and readability of node get property TASK: docs and readability of node get property Jun 11, 2023
@mhsdesign
Copy link
Member Author

mhsdesign commented Jun 23, 2023

might get obsolete when we opt in for @bwaidelich's cleanup #4304 (comment) / or can be build upon

@dlubitz
Copy link
Contributor

dlubitz commented Jun 23, 2023 via email

@mhsdesign mhsdesign changed the title TASK: docs and readability of node get property TASK: docs and readability of Node::getProperty Jun 27, 2023
@mhsdesign mhsdesign force-pushed the task/docsAndReadabilityOfNodeGetProperty branch from 4738883 to fcdfae7 Compare September 3, 2023 18:18
@mhsdesign mhsdesign marked this pull request as draft September 3, 2023 19:18
@bwaidelich
Copy link
Member

@mhsdesign you have replaced the PropertyCollectionInterface with this PR, but it seems to be stuck on the mock-issue.
I created a PR now for just the interface removal with #4513 in order to slice up the task a little.
We should continue our discussion on how to best mock parts of the CR in our weekly tomorrow

@mhsdesign mhsdesign force-pushed the task/docsAndReadabilityOfNodeGetProperty branch from 359e8da to cc9a45e Compare November 12, 2023 15:35
@mhsdesign mhsdesign force-pushed the task/docsAndReadabilityOfNodeGetProperty branch from cc9a45e to c41d5fe Compare November 12, 2023 15:41
@mhsdesign mhsdesign marked this pull request as ready for review November 12, 2023 15:43
@mhsdesign mhsdesign mentioned this pull request Nov 12, 2023
6 tasks
@mhsdesign
Copy link
Member Author

Rebased and removed all the crazy parts ;) so now its only improved docs and types and stuff ^^

Copy link
Member

@kdambekalns kdambekalns left a comment

Choose a reason for hiding this comment

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

👍 by 👀

@mhsdesign mhsdesign merged commit 32b593f into 9.0 Nov 20, 2023
9 checks passed
@mhsdesign mhsdesign deleted the task/docsAndReadabilityOfNodeGetProperty branch November 20, 2023 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants