Skip to content

Document Report Builder entity access control in Moodle 5.0 - #1746

Open
Felipelondonoliquid33 wants to merge 1 commit into
moodle:archive/5.0from
Felipelondonoliquid33:felipe/reportbuilder-capability-docs
Open

Felipelondonoliquid33 wants to merge 1 commit into
moodle:archive/5.0from
Felipelondonoliquid33:felipe/reportbuilder-capability-docs

Conversation

@Felipelondonoliquid33

Copy link
Copy Markdown

Summary

Clarifies access-control behavior for Report Builder entities in Moodle 5.0.

  • Documents that the entity base class does not define is_available() and adding such a method does not hide an entity or filter its rows.
  • Distinguishes the report base class's static is_available() method, which signals technical availability such as optional dependencies, from per-user capability checks.
  • Points developers to Moodle's Access API and explains that row-level visibility must be enforced across report viewing and export paths.

Fixes #1414

Validation

  • git diff --check
  • Markdown lint on the added section in isolation. The repository's full custom Markdown lint could not run because Yarn and its project dependencies are not installed in this environment.
  • Verified the Moodle 5.0 source: the entity base class has no is_available() method; the report base class method is documented for technical availability.

Clarify that entities do not expose an is_available hook and distinguish report availability from capability checks. Document where permission and row visibility restrictions need to be enforced.
@netlify

netlify Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e40ed2e
🔍 Latest deploy log https://app.netlify.com/projects/moodledevdocs/deploys/6aea5d9f41977d1470309f40
😎 Deploy Preview https://deploy-preview-1746--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@andrewnicols

Copy link
Copy Markdown
Member

Hi,

The Moodle 5.0 docs are now archived and will not be updated.

Can you please make this change to the 5.1+ docs instead.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants