search

catalyst / moodle-tool_cloudmetrics

Realtime metrics for Moodle
https://moodle.org/plugins/tool_cloudmetrics
GNU General Public License v3.0
0 stars 3 forks source link

Clarify the exact semantics of is_ready #77

Closed brendanheywood closed 2 years ago

brendanheywood commented 2 years ago

ie does is_ready mean that the plugin simply has its dependencies met (eg cloudwatch has the aws sdk) or does it mean it is also configured and the connection it good?

Does it also assume that the plugin is enabled?

The key thing is whether a plugin can be disabled, but ready. Ie we know it is going to work, but we have turned it off.

This may end up mostly as a documentation task and not really change things

jaypha commented 2 years ago

My thinking is that is_ready() means that it is ready to receive data. So it must be enabled, properly configured, a good connection etc .. basically everything.

brendanheywood commented 2 years ago

is_ready for core cache stores means 'I have my php modules, and I am configured, and I can connect' so this all aligns well

So this should boil down to a few phpdoc updates