mod_forum\local\vaults\preprocessors\extract_user Class Reference

Extract user vault preprocessor. More...

Public Member Functions
	__construct (string $idalias, string $alias)
	Constructor. More...
	execute (array $records)
	Extract the user records from a list of DB records. More...

Detailed Description

Extract user vault preprocessor.

Used to separate out the user record from a list of DB records that have been joined on the user table.

Copyright

2018 Ryan Wyllie ryan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

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

Constructor & Destructor Documentation

__construct()

mod_forum\local\vaults\preprocessors\extract_user::__construct	(	string	$idalias,
		string	$alias
	)

Constructor.

Parameters

string	$idalias	The alias for the id property of the user
string	$alias	The prefix used for each of the user properties

Member Function Documentation

execute()

mod_forum\local\vaults\preprocessors\extract_user::execute

(

array

$records

)

Extract the user records from a list of DB records.

Parameters

stdClass[]

$records

The DB records

Return values

stdClass[]

The list of extracted users

---

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

• mod/forum/classes/local/vaults/preprocessors/extract_user.php