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

[data_release] refactoring to use data framework. #9051

Conversation

racostas
Copy link
Contributor

@racostas racostas commented Feb 12, 2024

Brief summary of changes

Refactoring module

  • Use data framework.

Testing instructions (if applicable)

  1. All previous functionalities should be unchanged after adding the data framework.

Link(s) to related issue(s)

@driusan
Copy link
Collaborator

driusan commented Feb 13, 2024

@maximemulder would you be able to review / test this?

Comment on lines 227 to 236
/**
* 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;
}
Copy link
Contributor

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.

Copy link
Contributor Author

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.
image

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.

Copy link
Contributor Author

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 ?

Copy link
Collaborator

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

Copy link
Contributor

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.

Copy link
Contributor Author

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.
@maximemulder maximemulder added the Passed manual tests PR has been successfully tested by at least one peer label Mar 12, 2024
@driusan driusan merged commit 6349782 into aces:main Mar 12, 2024
28 checks passed
@ridz1208 ridz1208 added this to the 26.0.0 milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Passed manual tests PR has been successfully tested by at least one peer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[data_release] refactor module to use the data framework
4 participants