Log methods in AbstractExternalModule

[gadeynebram]

Hi, I have a question regarding the log method that is described here.

This feature sounds like a nice method to use. We're currently on v15.5.15.

• Unfortunately I think the log method itself is missing in the AbstractExternalModule class that is packaged with redcap. The md documentation mentions a signature of log($message[, $parameters]).
• queryLogs: this has a signature queryLogs($sql, $parameters = null) while the md documentation mentions getQueryLogsSql($sql).
• removeLogs: this has a signature removeLogs() while the md documentation mentions removeLogs($whereClause, $parameters).

[moorejr5]

Hey, Thanks for the question. I'm part of the Vanderbilt External Module Framework team, so I'll try my best to answer.

• The 'log', 'removeLogs' and 'queryLogs' methods are all accessed through the Framework class. Through this context, they match what is in the documentation. This is typically accessed through something like $module->framework->[method_name]
• 'getQueryLogsSql' and 'queryLogs' are two different methods. The documentation for 'queryLogs' matches the signature.

Easy to follow documentation is a continued process on our end of things. So thanks for bringing up these questions. It will help us identify places to provide more clarification.