[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/user/ -> editlib.php (summary)

This file contains function used when editing a users profile and preferences.

Copyright: 1999 Martin Dougiamas http://dougiamas.com
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 481 lines (19 kb)
Included or required:0 times
Referenced: 3 times
Includes or requires: 0 files

Defines 12 functions

  cancel_email_update()
  useredit_setup_preference_page()
  useredit_load_preferences()
  useredit_update_user_preference()
  useredit_update_picture()
  useredit_update_bounces()
  useredit_update_trackforums()
  useredit_update_interests()
  useredit_shared_definition()
  useredit_get_required_name_fields()
  useredit_get_enabled_name_fields()
  useredit_get_disabled_name_fields()

Functions
Functions that are not part of a class:

cancel_email_update($userid)   X-Ref
Cancels the requirement for a user to update their email address.

param: int $userid

useredit_setup_preference_page($userid, $courseid)   X-Ref
Performs the common access checks and page setup for all
user preference pages.

param: int $userid The user id to edit taken from the page params.
param: int $courseid The optional course id if we came from a course context.
return: array containing the user and course records.

useredit_load_preferences(&$user, $reload=true)   X-Ref
Loads the given users preferences into the given user object.

param: stdClass $user The user object, modified by reference.
param: bool $reload

useredit_update_user_preference($usernew)   X-Ref
Updates the user preferences for teh given user.

param: stdClass|array $usernew

useredit_update_picture(stdClass $usernew, moodleform $userform, $filemanageroptions = array()   X-Ref
Updates the provided users profile picture based upon the expected fields returned from the edit or edit_advanced forms.

param: stdClass $usernew An object that contains some information about the user being updated
param: moodleform $userform The form that was submitted to edit the form (unused)
param: array $filemanageroptions
return: bool True if the user was updated, false if it stayed the same.

useredit_update_bounces($user, $usernew)   X-Ref
Updates the user email bounce + send counts when the user is edited.

param: stdClass $user The current user object.
param: stdClass $usernew The updated user object.

useredit_update_trackforums($user, $usernew)   X-Ref
Updates the forums a user is tracking when the user is edited.

param: stdClass $user The original user object.
param: stdClass $usernew The updated user object.

useredit_update_interests($user, $interests)   X-Ref
Updates a users interests.

param: stdClass $user
param: array $interests

useredit_shared_definition(&$mform, $editoroptions, $filemanageroptions, $user)   X-Ref
Powerful function that is used by edit and editadvanced to add common form elements/rules/etc.

param: moodleform $mform
param: array $editoroptions
param: array $filemanageroptions
param: stdClass $user

useredit_get_required_name_fields()   X-Ref
Return required user name fields for forms.

return: array required user name fields in order according to settings.

useredit_get_enabled_name_fields()   X-Ref
Gets enabled (from fullnameformate setting) user name fields in appropriate order.

return: array Enabled user name fields.

useredit_get_disabled_name_fields($enabledadditionalusernames = null)   X-Ref
Gets user name fields not enabled from the setting fullnamedisplay.

param: array $enabledadditionalusernames Current enabled additional user name fields.
return: array Disabled user name fields.



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1