Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
- Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/admin/tool/uploaduser/classes/ -> process.php (source)
Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 400 and 403]
Class process
| Copyright: | 2020 Moodle |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 1409 lines (62 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 2 classes
process:: (1 method):
__construct()
must:: (21 methods):
find_standard_fields()
find_profile_fields()
get_file_columns()
set_form_data()
get_operation_type()
get_allow_deletes()
get_match_on_email()
get_allow_renames()
get_bulk()
get_update_type()
get_update_passwords()
get_allow_email_duplicates()
get_reset_passwords()
get_create_paswords()
get_allow_suspends()
get_normalise_user_names()
get_string_yes_no()
process()
prepare_user_record()
process_line()
get_stats()
Process CSV file with users data, this will create/update users, enrol them into courses, etc
| __construct(\csv_import_reader $cir, string $progresstrackerclass = null) X-Ref |
| process constructor. param: \csv_import_reader $cir param: string|null $progresstrackerclass |
| find_standard_fields() X-Ref |
| Standard user fields. |
| find_profile_fields() X-Ref |
| Profile fields |
| get_file_columns() X-Ref |
| Returns the list of columns in the file return: array |
| set_form_data(\stdClass $formdata) X-Ref |
| Set data from the form (or from CLI options) param: \stdClass $formdata |
| get_operation_type() X-Ref |
| Operation type return: int |
| get_allow_deletes() X-Ref |
| Setting to allow deletes return: bool |
| get_match_on_email() X-Ref |
| Setting to allow matching user accounts on email return: bool |
| get_allow_renames() X-Ref |
| Setting to allow deletes return: bool |
| get_bulk() X-Ref |
| Setting to select for bulk actions (not available in CLI) return: bool |
| get_update_type() X-Ref |
| Setting for update type return: int |
| get_update_passwords() X-Ref |
| Setting to allow update passwords return: bool |
| get_allow_email_duplicates() X-Ref |
| Setting to allow email duplicates return: bool |
| get_reset_passwords() X-Ref |
| Setting for reset password return: int UU_PWRESET_NONE, UU_PWRESET_WEAK, UU_PWRESET_ALL |
| get_create_paswords() X-Ref |
| Setting to allow create passwords return: bool |
| get_allow_suspends() X-Ref |
| Setting to allow suspends return: bool |
| get_normalise_user_names() X-Ref |
| Setting to normalise user names return: bool |
| get_string_yes_no($value) X-Ref |
| Helper method to return Yes/No string param: bool $value return: string |
| process() X-Ref |
| Process the CSV file |
| prepare_user_record(array $line) X-Ref |
| Prepare one line from CSV file as a user record param: array $line return: \stdClass|null |
| process_line(array $line) X-Ref |
| Process one line from CSV file param: array $line |
| get_stats() X-Ref |
| Summary about the whole process (how many users created, skipped, updated, etc) return: array |
