-
Notifications
You must be signed in to change notification settings - Fork 174
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
[data_release] refactoring to use data framework. #9051
[data_release] refactoring to use data framework. #9051
Conversation
@maximemulder would you be able to review / test this? |
/** | ||
* Tells the base class that this page's provisioner can support the | ||
* HasAnyPermissionOrUserSiteMatch filter. | ||
* | ||
* @return ?array of site permissions or null | ||
*/ | ||
public function allSitePermissionNames() : ?array | ||
{ | ||
return null; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I may be mistaken, but this documentation comment does not seem to coincide with the documentation of the base method, no ? It seems to me that returning null
means the provisionner does not support the HasAnyPermissionOrUserSiteMatch
filter.
Other than that LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @maximemulder, thank you for the review. Very appreciated.
This is what I found in the declaration of the method.
The data release docs are not site tied. That's way I'm returning null in the implementation. The page don't use site filtering.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think it will be more accurate to specify this in the documentation of the implementation itself: That this page don't use site filtering ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be more accurate, or you could use the {@inheritDoc}
annotation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think it will be more accurate to specify this in the documentation of the implementation itself: That this page don't use site filtering ?
Sorry for the wait, but yes, just like Dave said, specifying either that or inheriting the parent documentation should do the job.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sorry, somehow this escaped to my attention. Should be fixed now. Thank you.
fixes method documentation.
Brief summary of changes
Refactoring module
Testing instructions (if applicable)
Link(s) to related issue(s)