Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/mod/forum/classes/ -> potential_subscriber_selector.php (source)

[Source view]

A type of forum.

Copyright: 2014 Andrew Robert Nicols <andrew@nicols.co.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 159 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

mod_forum_potential_subscriber_selector:: (5 methods):
  __construct()
  get_options()
  find_users()
  set_existing_subscribers()
  set_force_subscribed()


Class: mod_forum_potential_subscriber_selector  - X-Ref

A user selector control for potential subscribers to the selected forum

__construct($name, $options)   X-Ref
Constructor method

param: string $name
param: array $options

get_options()   X-Ref
Returns an arary of options for this control

return: array

find_users($search)   X-Ref
Finds all potential users

Potential subscribers are all enroled users who are not already subscribed.

param: string $search
return: array

set_existing_subscribers(array $users)   X-Ref
Sets the existing subscribers

param: array $users

set_force_subscribed($setting=true)   X-Ref
Sets this forum as force subscribed or not