Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Problem/Motivation
There is a node access documentation topic, but it does not include the various classes and interfaces that interact with node access, only the procedural code.
Proposed resolution
Add the appropriate @ingroup to classes and interfaces in the node module that play a role in node access.
Beta phase evaluation
Issue category | Task because there is no functional bug, just some extra digging needed. |
---|---|
Issue priority | Normal; it's a fairly small issue, but it does make the documentation topic incomplete |
Unfrozen changes | Unfrozen because it only changes documentation. |
Remaining tasks
Task | Novice task? | Contributor instructions | Complete? |
---|---|---|---|
Create a patch | Instructions | ||
Review patch to ensure that it fixes the issue, stays within scope, is properly documented, and follows coding standards | Instructions |
User interface changes
API changes
Comment | File | Size | Author |
---|---|---|---|
#9 | interdiff_2473123_6-9.txt | 512 bytes | JacobSanford |
#9 | node_access_documentation-2473123-9.patch | 3.79 KB | JacobSanford |
#6 | interdiff-4-6.txt | 2.42 KB | sander.devos |
#6 | node_access_documentation-2473123-6.patch | 4.29 KB | sander.devos |
#4 | node_access_documentation-2473123-4.patch | 1006 bytes | sander.devos |
Comments
Comment #1
xjmAdding beta evaluation.
Comment #2
jhodgdonThe only class I see mentioned in the text is NodeAccessControlHandler, which implements NodeAccessControlHandlerInterface...
Are these the only two that need @ingroup to be included here?
Comment #3
sander.devos CreditAttribution: sander.devos at Calibrate commentedI'm going to try and work on this issue.
Comment #4
sander.devos CreditAttribution: sander.devos at Calibrate commentedMy first ever patch. Hope you all like it!
Comment #5
xjmThanks @sander.devos!
There are a couple more classes and interfaces we need to add. See, for example, NodeGrantDatabaseStorageInterface. Take a look inside the class at the dependencies to get an idea. See the related issues around #2461049: Node module permissions are broken if hook_node_grants is implemented for more ideas as well.
Comment #6
sander.devos CreditAttribution: sander.devos at Calibrate commentedI just applied more changes. I think I got most of the classes that interact with node access.
I also found that BookNodeIsRemovableAccessCheck makes use of node access. But is in another module. Do I have to add @ingroup node_access here as well or not?
Comment #7
jhodgdonI don't think that the class in the Book module belongs in the node access topic... the list looks good to me. Provisionally setting to RTBC and assigning to xjm to decide whether everything is complete now.
Comment #8
xjmSo this one I think should not be in the group since it is about access control for creating content types, not for nodes.
Looks good to me other than that!
Comment #9
JacobSanfordUpdate as requested in #8.
Comment #10
jhodgdonLooks like this fixes #8, so should be RTBC now. Thanks!
Comment #11
xjmThis issue only changes documentation, so per https://www.drupal.org/core/beta-changes, this can be completed any time during the Drupal 8 beta phase. Committed and pushed to 8.0.x. Thanks!