Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | List of all members
mod_forum\local\vaults\preprocessors\extract_record Class Reference

Extract record vault preprocessor. More...

Public Member Functions

 __construct (string $table, string $alias)
 Constructor. More...
 
 execute (array $records)
 Extract a record embedded in the properties of another record out into a separate record. More...
 

Detailed Description

Extract record vault preprocessor.

Extract record vault preprocessor. Typically used to separate out records when two tables have been joined together in a query.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

mod_forum\local\vaults\preprocessors\extract_record::__construct ( string  $table,
string  $alias 
)

Constructor.

Parameters
string$tableThe table name where the records were loaded from
string$aliasThe table alias used as the record property prefix

Member Function Documentation

◆ execute()

mod_forum\local\vaults\preprocessors\extract_record::execute ( array  $records)

Extract a record embedded in the properties of another record out into a separate record.

Parameters
stdClass[]$recordsThe list of records to process
Return values
stdClass[]The extracted records

The documentation for this class was generated from the following file: