forum_potential_subscriber_selector Class Reference

Inheritance diagram for forum_potential_subscriber_selector:

Collaboration diagram for forum_potential_subscriber_selector:

Public Member Functions
	__construct ($name, $options)
	find_users ($search)
	set_existing_subscribers (array $users)
	set_force_subscribed ($setting=true)
Protected Member Functions
	get_options ()
Protected Attributes
	$forcesubscribed = false
	$existingsubscribers = array()

---

Detailed Description

Definition at line 7600 of file lib.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	options
	)

Constructor method

Parameters:

string	$name
array	$options

Reimplemented from forum_subscriber_selector_base.

Definition at line 7618 of file lib.php.

---

Member Function Documentation

find_users

(

$

search

)

Finds all potential users

Potential users are determined by checking for users with a capability determined in {

See also:

forum_get_potential_subscribers()}

Parameters:

string

$search

Returns:

array

Reimplemented from user_selector_base.

Definition at line 7646 of file lib.php.

Here is the call graph for this function:

get_options

(

)

[protected]

Returns an arary of options for this control

Returns:

array

Reimplemented from forum_subscriber_selector_base.

Definition at line 7629 of file lib.php.

set_existing_subscribers

(

array $

users

)

Sets the existing subscribers

Parameters:

array

$users

Definition at line 7684 of file lib.php.

set_force_subscribed

(

$

setting = true

)

Sets this forum as force subscribed or not

Definition at line 7691 of file lib.php.

---

Field Documentation

$existingsubscribers = array() [protected]

Can be used to store existing subscribers so that they can be removed from the potential subscribers list

Definition at line 7611 of file lib.php.

$forcesubscribed = false [protected]

Definition at line 7606 of file lib.php.

---

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

• C:/xampp/htdocs/moodle/mod/forum/lib.php