L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-44255 user: tidied up phpdocs and coding style

Browse Source
This commit is contained in:
Sam Hemelryk
2014-02-24 09:23:47 +13:00
parent ec4c8161a4
commit a2ed6e69f9
65 changed files with 3382 additions and 2236 deletions
Download Patch File Download Diff File Expand all files Collapse all files
user/editlib.php
+84 -23
View File
@@ -1,31 +1,69 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* 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
* @package core_user
*/
/**
* Cancels the requirement for a user to update their email address.
*
* @param int $userid
*/
function cancel_email_update($userid) {
unset_user_preference('newemail', $userid);
unset_user_preference('newemailkey', $userid);
unset_user_preference('newemailattemptsleft', $userid);
}
/**
* Loads the given users preferences into the given user object.
*
* @param stdClass $user The user object, modified by reference.
* @param bool $reload
*/
function useredit_load_preferences(&$user, $reload=true) {
global $USER;
if (!empty($user->id)) {
if ($reload and $USER->id == $user->id) {
// reload preferences in case it was changed in other session
// Reload preferences in case it was changed in other session.
unset($USER->preference);
}
if ($preferences = get_user_preferences(null, null, $user->id)) {
foreach($preferences as $name=>$value) {
foreach ($preferences as $name => $value) {
$user->{'preference_'.$name} = $value;
}
}
}
}
/**
* Updates the user preferences for teh given user.
*
* @param stdClass|array $usernew
*/
function useredit_update_user_preference($usernew) {
$ua = (array)$usernew;
foreach($ua as $key=>$value) {
foreach ($ua as $key => $value) {
if (strpos($key, 'preference_') === 0) {
$name = substr($key, strlen('preference_'));
set_user_preference($name, $value, $usernew->id);
@@ -34,12 +72,12 @@ function useredit_update_user_preference($usernew) {
}
/**
* Updates the provided users profile picture based upon the expected fields
* returned from the edit or edit_advanced forms.
* Updates the provided users profile picture based upon the expected fields returned from the edit or edit_advanced forms.
*
* @global moodle_database $DB
* @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
* @param array $filemanageroptions
* @return bool True if the user was updated, false if it stayed the same.
*/
function useredit_update_picture(stdClass $usernew, moodleform $userform, $filemanageroptions = array()) {
@@ -47,33 +85,33 @@ function useredit_update_picture(stdClass $usernew, moodleform $userform, $filem
require_once("$CFG->libdir/gdlib.php");
$context = context_user::instance($usernew->id, MUST_EXIST);
$user = $DB->get_record('user', array('id'=>$usernew->id), 'id, picture', MUST_EXIST);
$user = $DB->get_record('user', array('id' => $usernew->id), 'id, picture', MUST_EXIST);
$newpicture = $user->picture;
// Get file_storage to process files.
$fs = get_file_storage();
if (!empty($usernew->deletepicture)) {
// The user has chosen to delete the selected users picture
$fs->delete_area_files($context->id, 'user', 'icon'); // drop all images in area
// The user has chosen to delete the selected users picture.
$fs->delete_area_files($context->id, 'user', 'icon'); // Drop all images in area.
$newpicture = 0;
} else {
// Save newly uploaded file, this will avoid context mismatch for newly created users.
file_save_draft_area_files($usernew->imagefile, $context->id, 'user', 'newicon', 0, $filemanageroptions);
if (($iconfiles = $fs->get_area_files($context->id, 'user', 'newicon')) && count($iconfiles) == 2) {
// Get file which was uploaded in draft area
// Get file which was uploaded in draft area.
foreach ($iconfiles as $file) {
if (!$file->is_directory()) {
break;
}
}
// Copy file to temporary location and the send it for processing icon
// Copy file to temporary location and the send it for processing icon.
if ($iconfile = $file->copy_content_to_temp()) {
// There is a new image that has been uploaded
// There is a new image that has been uploaded.
// Process the new image and set the user to make use of it.
// NOTE: Uploaded images always take over Gravatar
// NOTE: Uploaded images always take over Gravatar.
$newpicture = (int)process_new_icon($context, 'user', 'icon', 0, $iconfile);
// Delete temporary file
// Delete temporary file.
@unlink($iconfile);
// Remove uploaded file.
$fs->delete_area_files($context->id, 'user', 'newicon');
@@ -94,21 +132,33 @@ function useredit_update_picture(stdClass $usernew, moodleform $userform, $filem
}
}
/**
* 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.
*/
function useredit_update_bounces($user, $usernew) {
if (!isset($usernew->email)) {
//locked field
// Locked field.
return;
}
if (!isset($user->email) || $user->email !== $usernew->email) {
set_bounce_count($usernew,true);
set_send_count($usernew,true);
set_bounce_count($usernew, true);
set_send_count($usernew, true);
}
}
/**
* 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.
*/
function useredit_update_trackforums($user, $usernew) {
global $CFG;
if (!isset($usernew->trackforums)) {
//locked field
// Locked field.
return;
}
if ((!isset($user->trackforums) || ($usernew->trackforums != $user->trackforums)) and !$usernew->trackforums) {
@@ -117,10 +167,23 @@ function useredit_update_trackforums($user, $usernew) {
}
}
/**
* Updates a users interests.
*
* @param stdClass $user
* @param array $interests
*/
function useredit_update_interests($user, $interests) {
tag_set('user', $user->id, $interests);
}
/**
* Powerful function that is used by edit and editadvanced to add common form elements/rules/etc.
*
* @param moodleform $mform
* @param array|null $editoroptions
* @param array|null $filemanageroptions
*/
function useredit_shared_definition(&$mform, $editoroptions = null, $filemanageroptions = null) {
global $CFG, $USER, $DB;
@@ -143,7 +206,7 @@ function useredit_shared_definition(&$mform, $editoroptions = null, $filemanager
$mform->setType($addname, PARAM_NOTAGS);
}
// Do not show email field if change confirmation is pending
// Do not show email field if change confirmation is pending.
if (!empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
$notice = get_string('emailchangepending', 'auth', $user);
$notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
@@ -228,7 +291,7 @@ function useredit_shared_definition(&$mform, $editoroptions = null, $filemanager
}
$choices = get_string_manager()->get_list_of_countries();
$choices= array(''=>get_string('selectacountry').'...') + $choices;
$choices = array('' => get_string('selectacountry') . '...') + $choices;
$mform->addElement('select', 'country', get_string('selectacountry'), $choices);
if (!empty($CFG->country)) {
$mform->setDefault('country', $CFG->country);
@@ -258,7 +321,7 @@ function useredit_shared_definition(&$mform, $editoroptions = null, $filemanager
$choices = array();
$choices[''] = get_string('default');
$themes = get_list_of_themes();
foreach ($themes as $key=>$theme) {
foreach ($themes as $key => $theme) {
if (empty($theme->hidefromselector)) {
$choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
}
@@ -306,7 +369,7 @@ function useredit_shared_definition(&$mform, $editoroptions = null, $filemanager
$mform->addHelpButton('interests', 'interestslist');
}
/// Moodle optional fields
// Moodle optional fields.
$mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
$mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
@@ -344,8 +407,6 @@ function useredit_shared_definition(&$mform, $editoroptions = null, $filemanager
$mform->addElement('text', 'address', get_string('address'), 'maxlength="255" size="25"');
$mform->setType('address', PARAM_TEXT);
}
/**