Plugins, Hooks, & External Modules
Developer methods for
Plugins, Hooks, & External Modules
Hook functions
REDCap Developer Tools:
Documentation for Plugins, Hooks, & External Modules
REDCap Version 14.9.1
REDCap::getLogEventTable
(REDCap >= 8.5.0)
REDCap::getLogEventTable
— Get the name of the specific redcap_log_event* database table used by a REDCap project
Description
string REDCap::getLogEventTable ( int $project_id )
Given a project ID number, this method returns the redcap_log_event* database table name (e.g., "redcap_log_event4") used by a specified REDCap project. Many redcap_log_event* tables exist in the database, but each individual project will use only one specific redcap_log_event* table. The only way to know which redcap_log_event* table that a project utilizes for storing its logged events is to call this method. This is mostly used when making explicit database calls to the redcap_log_event* table.
Parameters
project_id
The project ID number of the REDCap project. If the project_id parameter's value is not numeric, it will return "redcap_log_event".
The project ID number of the REDCap project. If the project_id parameter's value is not numeric, it will return "redcap_log_event".
Return Values
The specific redcap_log_event* database table used by a REDCap project (e.g., "redcap_log_event3").
Examples
Example #1:
Simple example for extracting a project's logged events from its respective redcap_log_event* table in the database.
$log_event_table = method_exists('\REDCap', 'getLogEventTable')
? \REDCap::getLogEventTable($project_id) : "redcap_log_event";
$sql = "select * from $log_event_table where project_id = $project_id order by log_event_id";
REDCap 14.9.1 - © 2024 Vanderbilt University