mod_assign\privacy\useridlist Class Reference

An object for collecting user IDs related to a teacher. More...

Public Member Functions
	__construct ($teacherid, $assignid)
	Create this object. More...
	add_from_sql ($sql, $params)
	Add sql and params to return user IDs. More...
	get_assignid ()
	Returns the assign ID. More...
	get_teacherid ()
	Returns the teacher ID. More...
	get_userids ()
	Returns the user IDs. More...

Protected Attributes
int	$assignid
	The ID of the assignment object.
int	$teacherid
	The ID of the teacher.
array	$userids = []
	A collection of user IDs (students).

Detailed Description

An object for collecting user IDs related to a teacher.

Copyright

2018 Adrian Greeve adria.nosp@m.n@mo.nosp@m.odle..nosp@m.com

License

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

Constructor & Destructor Documentation

__construct()

mod_assign\privacy\useridlist::__construct	(		$teacherid,
			$assignid
	)

Create this object.

Parameters

int	$teacherid	The teacher ID.
int	$assignid	The assignment ID.

Member Function Documentation

add_from_sql()

mod_assign\privacy\useridlist::add_from_sql	(		$sql,
			$params
	)

Add sql and params to return user IDs.

Parameters

string	$sql	The sql string to return user IDs.
array	$params	Parameters for the sql statement.

get_assignid()

mod_assign\privacy\useridlist::get_assignid

(

)

Returns the assign ID.

Return values

int	The assign ID.

get_teacherid()

mod_assign\privacy\useridlist::get_teacherid

(

)

Returns the teacher ID.

Return values

int	The teacher ID.

get_userids()

mod_assign\privacy\useridlist::get_userids

(

)

Returns the user IDs.

Return values

array

User IDs.

---

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

• mod/assign/classes/privacy/useridlist.php