Search moodle.org's
Developer Documentation

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
  • Differences Between: [Versions 37 and 311]

    Auxiliary manual user enrolment lib, the main purpose is to lower memory requirements...

    Copyright: 2010 Petr Skoda {@link http://skodak.org}
    License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
    File Size: 503 lines (18 kb)
    Included or required:0 times
    Referenced: 3 times
    Includes or requires: 0 files

    Defines 4 classes

    enrol_manual_potential_participant:: (3 methods):
      __construct()
      find_users()
      get_options()

    enrol_manual_current_participant:: (3 methods):
      __construct()
      find_users()
      get_options()

    enrol_manual_editselectedusers_operation:: (4 methods):
      get_title()
      get_identifier()
      process()
      get_form()

    enrol_manual_deleteselectedusers_operation:: (6 methods):
      get_identifier()
      get_title()
      get_form()
      process()
      enrol_manual_migrate_plugin_enrolments()
      enrol_manual_get_potential_cohorts()


    Class: enrol_manual_potential_participant  - X-Ref

    Enrol candidates.

    __construct($name, $options)   X-Ref
    No description

    find_users($search)   X-Ref
    Candidate users

    param: string $search
    return: array

    get_options()   X-Ref
    No description

    Class: enrol_manual_current_participant  - X-Ref

    Enrolled users.

    __construct($name, $options)   X-Ref
    No description

    find_users($search)   X-Ref
    Candidate users

    param: string $search
    return: array

    get_options()   X-Ref
    No description

    Class: enrol_manual_editselectedusers_operation  - X-Ref

    A bulk operation for the manual enrolment plugin to edit selected users.

    get_title()   X-Ref
    Returns the title to display for this bulk operation.

    return: string

    get_identifier()   X-Ref
    Returns the identifier for this bulk operation. This is the key used when the plugin
    returns an array containing all of the bulk operations it supports.


    process(course_enrolment_manager $manager, array $users, stdClass $properties)   X-Ref
    Processes the bulk operation request for the given userids with the provided properties.

    param: course_enrolment_manager $manager
    param: array $userids
    param: stdClass $properties The data returned by the form.

    get_form($defaultaction = null, $defaultcustomdata = null)   X-Ref
    Returns a enrol_bulk_enrolment_operation extension form to be used
    in collecting required information for this operation to be processed.

    param: string|moodle_url|null $defaultaction
    param: mixed $defaultcustomdata
    return: enrol_manual_editselectedusers_form

    Class: enrol_manual_deleteselectedusers_operation  - X-Ref

    A bulk operation for the manual enrolment plugin to delete selected users enrolments.

    get_identifier()   X-Ref
    Returns the title to display for this bulk operation.

    return: string

    get_title()   X-Ref
    Returns the identifier for this bulk operation. This is the key used when the plugin
    returns an array containing all of the bulk operations it supports.

    return: string

    get_form($defaultaction = null, $defaultcustomdata = null)   X-Ref
    Returns a enrol_bulk_enrolment_operation extension form to be used
    in collecting required information for this operation to be processed.

    param: string|moodle_url|null $defaultaction
    param: mixed $defaultcustomdata
    return: enrol_manual_editselectedusers_form

    process(course_enrolment_manager $manager, array $users, stdClass $properties)   X-Ref
    Processes the bulk operation request for the given userids with the provided properties.

    param: course_enrolment_manager $manager
    param: array $userids
    param: stdClass $properties The data returned by the form.

    enrol_manual_migrate_plugin_enrolments($enrol)   X-Ref
    Migrates all enrolments of the given plugin to enrol_manual plugin,
    this is used for example during plugin uninstallation.

    NOTE: this function does not trigger role and enrolment related events.

    param: string $enrol  The enrolment method.

    enrol_manual_get_potential_cohorts($context, $enrolid, $search = '', $page = 0, $perpage = 25, $addedenrollment = 0)   X-Ref
    Gets an array of the cohorts that can be enrolled in this course.

    param: int $enrolid
    param: string $search
    param: int $page Defaults to 0
    param: int $perpage Defaults to 25
    param: int $addedenrollment
    return: array Array(totalcohorts => int, cohorts => array)