first commit

user/profile/field/menu/classes/privacy/provider.php

@@ -0,0 +1,216 @@
+<?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/>.
+
+/**
+ * Privacy class for requesting user data.
+ *
+ * @package    profilefield_menu
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace profilefield_menu\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use \core_privacy\local\metadata\collection;
+use \core_privacy\local\request\contextlist;
+use \core_privacy\local\request\approved_contextlist;
+use core_privacy\local\request\userlist;
+use core_privacy\local\request\approved_userlist;
+
+/**
+ * Privacy class for requesting user data.
+ *
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements
+    \core_privacy\local\metadata\provider,
+    \core_privacy\local\request\core_userlist_provider,
+    \core_privacy\local\request\plugin\provider {
+
+    /**
+     * Returns meta data about this system.
+     *
+     * @param   collection $collection The initialised collection to add items to.
+     * @return  collection A listing of user data stored through this system.
+     */
+    public static function get_metadata(collection $collection): collection {
+        return $collection->add_database_table('user_info_data', [
+            'userid' => 'privacy:metadata:profilefield_menu:userid',
+            'fieldid' => 'privacy:metadata:profilefield_menu:fieldid',
+            'data' => 'privacy:metadata:profilefield_menu:data',
+            'dataformat' => 'privacy:metadata:profilefield_menu:dataformat'
+        ], 'privacy:metadata:profilefield_menu:tableexplanation');
+    }
+
+    /**
+     * Get the list of contexts that contain user information for the specified user.
+     *
+     * @param   int         $userid     The user to search.
+     * @return  contextlist $contextlist  The contextlist containing the list of contexts used in this plugin.
+     */
+    public static function get_contexts_for_userid(int $userid): contextlist {
+        $sql = "SELECT ctx.id
+                  FROM {user_info_data} uda
+                  JOIN {user_info_field} uif ON uda.fieldid = uif.id
+                  JOIN {context} ctx ON ctx.instanceid = uda.userid
+                       AND ctx.contextlevel = :contextlevel
+                 WHERE uda.userid = :userid
+                       AND uif.datatype = :datatype";
+        $params = [
+            'userid' => $userid,
+            'contextlevel' => CONTEXT_USER,
+            'datatype' => 'menu'
+        ];
+        $contextlist = new contextlist();
+        $contextlist->add_from_sql($sql, $params);
+
+        return $contextlist;
+    }
+
+    /**
+     * Get the list of users within a specific context.
+     *
+     * @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.
+     */
+    public static function get_users_in_context(userlist $userlist) {
+        $context = $userlist->get_context();
+
+        if (!$context instanceof \context_user) {
+            return;
+        }
+
+        $sql = "SELECT uda.userid
+                  FROM {user_info_data} uda
+                  JOIN {user_info_field} uif
+                       ON uda.fieldid = uif.id
+                 WHERE uda.userid = :userid
+                       AND uif.datatype = :datatype";
+
+        $params = [
+            'userid' => $context->instanceid,
+            'datatype' => 'menu'
+        ];
+
+        $userlist->add_from_sql('userid', $sql, $params);
+    }
+
+    /**
+     * Export all user data for the specified user, in the specified contexts.
+     *
+     * @param approved_contextlist $contextlist The approved contexts to export information for.
+     */
+    public static function export_user_data(approved_contextlist $contextlist) {
+        $user = $contextlist->get_user();
+        foreach ($contextlist->get_contexts() as $context) {
+            // Check if the context is a user context.
+            if ($context->contextlevel == CONTEXT_USER && $context->instanceid == $user->id) {
+                $results = static::get_records($user->id);
+                foreach ($results as $result) {
+                    $data = (object) [
+                        'name' => $result->name,
+                        'description' => $result->description,
+                        'data' => $result->data
+                    ];
+                    \core_privacy\local\request\writer::with_context($context)->export_data([
+                        get_string('pluginname', 'profilefield_menu')], $data);
+                }
+            }
+        }
+    }
+
+    /**
+     * Delete all user data which matches the specified context.
+     *
+     * @param   context $context A user context.
+     */
+    public static function delete_data_for_all_users_in_context(\context $context) {
+        // Delete data only for user context.
+        if ($context->contextlevel == CONTEXT_USER) {
+            static::delete_data($context->instanceid);
+        }
+    }
+
+    /**
+     * Delete multiple users within a single context.
+     *
+     * @param approved_userlist $userlist The approved context and user information to delete information for.
+     */
+    public static function delete_data_for_users(approved_userlist $userlist) {
+        $context = $userlist->get_context();
+
+        if ($context instanceof \context_user) {
+            static::delete_data($context->instanceid);
+        }
+    }
+
+    /**
+     * Delete all user data for the specified user, in the specified contexts.
+     *
+     * @param   approved_contextlist    $contextlist    The approved contexts and user information to delete information for.
+     */
+    public static function delete_data_for_user(approved_contextlist $contextlist) {
+        $user = $contextlist->get_user();
+        foreach ($contextlist->get_contexts() as $context) {
+            // Check if the context is a user context.
+            if ($context->contextlevel == CONTEXT_USER && $context->instanceid == $user->id) {
+                static::delete_data($context->instanceid);
+            }
+        }
+    }
+
+    /**
+     * Delete data related to a userid.
+     *
+     * @param  int $userid The user ID
+     */
+    protected static function delete_data($userid) {
+        global $DB;
+
+        $params = [
+            'userid' => $userid,
+            'datatype' => 'menu'
+        ];
+
+        $DB->delete_records_select('user_info_data', "fieldid IN (
+                SELECT id FROM {user_info_field} WHERE datatype = :datatype)
+                AND userid = :userid", $params);
+    }
+
+    /**
+     * Get records related to this plugin and user.
+     *
+     * @param  int $userid The user ID
+     * @return array An array of records.
+     */
+    protected static function get_records($userid) {
+        global $DB;
+
+        $sql = "SELECT *
+                  FROM {user_info_data} uda
+                  JOIN {user_info_field} uif ON uda.fieldid = uif.id
+                 WHERE uda.userid = :userid
+                       AND uif.datatype = :datatype";
+        $params = [
+            'userid' => $userid,
+            'datatype' => 'menu'
+        ];
+
+        return $DB->get_records_sql($sql, $params);
+    }
+}

user/profile/field/menu/define.class.php

@@ -0,0 +1,84 @@
+<?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/>.
+
+/**
+ * Menu profile field definition.
+ *
+ * @package    profilefield_menu
+ * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Class profile_define_menu
+ *
+ * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class profile_define_menu extends profile_define_base {
+
+    /**
+     * Adds elements to the form for creating/editing this type of profile field.
+     * @param moodleform $form
+     */
+    public function define_form_specific($form) {
+        // Param 1 for menu type contains the options.
+        $form->addElement('textarea', 'param1', get_string('profilemenuoptions', 'admin'), array('rows' => 6, 'cols' => 40));
+        $form->setType('param1', PARAM_TEXT);
+
+        // Default data.
+        $form->addElement('text', 'defaultdata', get_string('profiledefaultdata', 'admin'), 'size="50"');
+        $form->setType('defaultdata', PARAM_TEXT);
+    }
+
+    /**
+     * Validates data for the profile field.
+     *
+     * @param array $data
+     * @param array $files
+     * @return array
+     */
+    public function define_validate_specific($data, $files) {
+        $err = array();
+
+        $data->param1 = str_replace("\r", '', $data->param1);
+
+        // Check that we have at least 2 options.
+        if (($options = explode("\n", $data->param1)) === false) {
+            $err['param1'] = get_string('profilemenunooptions', 'admin');
+        } else if (count($options) < 2) {
+            $err['param1'] = get_string('profilemenutoofewoptions', 'admin');
+        } else if (!empty($data->defaultdata) and !in_array($data->defaultdata, $options)) {
+            // Check the default data exists in the options.
+            $err['defaultdata'] = get_string('profilemenudefaultnotinoptions', 'admin');
+        }
+        return $err;
+    }
+
+    /**
+     * Processes data before it is saved.
+     * @param array|stdClass $data
+     * @return array|stdClass
+     */
+    public function define_save_preprocess($data) {
+        $data->param1 = str_replace("\r", '', $data->param1);
+
+        return $data;
+    }
+
+}
+
+

user/profile/field/menu/field.class.php

@@ -0,0 +1,191 @@
+<?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/>.
+
+/**
+ * Menu profile field.
+ *
+ * @package    profilefield_menu
+ * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Class profile_field_menu
+ *
+ * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class profile_field_menu extends profile_field_base {
+
+    /** @var array $options */
+    public $options;
+
+    /** @var int $datakey */
+    public $datakey;
+
+    /**
+     * Constructor method.
+     *
+     * Pulls out the options for the menu from the database and sets the the corresponding key for the data if it exists.
+     *
+     * @param int $fieldid
+     * @param int $userid
+     * @param object $fielddata
+     */
+    public function __construct($fieldid = 0, $userid = 0, $fielddata = null) {
+        // First call parent constructor.
+        parent::__construct($fieldid, $userid, $fielddata);
+
+        // Param 1 for menu type is the options.
+        if (isset($this->field->param1)) {
+            $options = explode("\n", $this->field->param1);
+        } else {
+            $options = array();
+        }
+        $this->options = array();
+        if (!empty($this->field->required)) {
+            $this->options[''] = get_string('choose').'...';
+        }
+        foreach ($options as $key => $option) {
+            // Multilang formatting with filters.
+            $this->options[$option] = format_string($option, true, ['context' => context_system::instance()]);
+        }
+
+        // Set the data key.
+        if ($this->data !== null) {
+            $key = $this->data;
+            if (isset($this->options[$key]) || ($key = array_search($key, $this->options)) !== false) {
+                $this->data = $key;
+                $this->datakey = $key;
+            }
+        }
+    }
+
+    /**
+     * Create the code snippet for this field instance
+     * Overwrites the base class method
+     * @param moodleform $mform Moodle form instance
+     */
+    public function edit_field_add($mform) {
+        $mform->addElement('select', $this->inputname, format_string($this->field->name), $this->options);
+    }
+
+    /**
+     * Set the default value for this field instance
+     * Overwrites the base class method.
+     * @param moodleform $mform Moodle form instance
+     */
+    public function edit_field_set_default($mform) {
+        $key = $this->field->defaultdata;
+        if (isset($this->options[$key]) || ($key = array_search($key, $this->options)) !== false){
+            $defaultkey = $key;
+        } else {
+            $defaultkey = '';
+        }
+        $mform->setDefault($this->inputname, $defaultkey);
+    }
+
+    /**
+     * The data from the form returns the key.
+     *
+     * This should be converted to the respective option string to be saved in database
+     * Overwrites base class accessor method.
+     *
+     * @param mixed $data The key returned from the select input in the form
+     * @param stdClass $datarecord The object that will be used to save the record
+     * @return mixed Data or null
+     */
+    public function edit_save_data_preprocess($data, $datarecord) {
+        return isset($this->options[$data]) ? $data : null;
+    }
+
+    /**
+     * When passing the user object to the form class for the edit profile page
+     * we should load the key for the saved data
+     *
+     * Overwrites the base class method.
+     *
+     * @param stdClass $user User object.
+     */
+    public function edit_load_user_data($user) {
+        $user->{$this->inputname} = $this->datakey;
+    }
+
+    /**
+     * HardFreeze the field if locked.
+     * @param moodleform $mform instance of the moodleform class
+     */
+    public function edit_field_set_locked($mform) {
+        if (!$mform->elementExists($this->inputname)) {
+            return;
+        }
+        if ($this->is_locked() and !has_capability('moodle/user:update', context_system::instance())) {
+            $mform->hardFreeze($this->inputname);
+            $mform->setConstant($this->inputname, format_string($this->datakey));
+        }
+    }
+    /**
+     * Convert external data (csv file) from value to key for processing later by edit_save_data_preprocess
+     *
+     * @param string $value one of the values in menu options.
+     * @return int options key for the menu
+     */
+    public function convert_external_data($value) {
+        if (isset($this->options[$value])) {
+            $retval = $value;
+        } else {
+            $retval = array_search($value, $this->options);
+        }
+
+        // If value is not found in options then return null, so that it can be handled
+        // later by edit_save_data_preprocess.
+        if ($retval === false) {
+            $retval = null;
+        }
+        return $retval;
+    }
+
+    /**
+     * Return the field type and null properties.
+     * This will be used for validating the data submitted by a user.
+     *
+     * @return array the param type and null property
+     * @since Moodle 3.2
+     */
+    public function get_field_properties() {
+        return array(PARAM_TEXT, NULL_NOT_ALLOWED);
+    }
+
+    /**
+     * Return the field settings suitable to be exported via an external function.
+     *
+     * @return array all the settings
+     */
+    public function get_field_config_for_external() {
+
+        if (isset($this->field->param1) && !empty($this->options)) {
+            // Remove "Choose" option to make it consisten with the rest of the data.
+            if (!empty($this->field->required)) {
+                unset($this->options['']);
+            }
+            $this->field->param2 = implode("\n", array_values($this->options));
+        }
+
+        return (array) $this->field;
+    }
+}
+
+

user/profile/field/menu/lang/en/profilefield_menu.php

@@ -0,0 +1,30 @@
+<?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/>.
+
+/**
+ * Strings for component 'profilefield_menu', language 'en', branch 'MOODLE_20_STABLE'
+ *
+ * @package   profilefield_menu
+ * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['pluginname'] = 'Drop-down menu';
+$string['privacy:metadata:profilefield_menu:userid'] = 'The ID of the user whose data is stored by the drop-down menu user profile field';
+$string['privacy:metadata:profilefield_menu:fieldid'] = 'The ID of the profile field';
+$string['privacy:metadata:profilefield_menu:data'] = 'Drop-down menu user profile field user data';
+$string['privacy:metadata:profilefield_menu:dataformat'] = 'The format of the drop-down menu user profile field user data';
+$string['privacy:metadata:profilefield_menu:tableexplanation'] = 'Additional profile data';

user/profile/field/menu/tests/privacy/provider_test.php

@@ -0,0 +1,302 @@
+<?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/>.
+
+/**
+ * Base class for unit tests for profilefield_menu.
+ *
+ * @package    profilefield_menu
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace profilefield_menu\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_privacy\tests\provider_testcase;
+use profilefield_menu\privacy\provider;
+use core_privacy\local\request\approved_userlist;
+
+/**
+ * Unit tests for user\profile\field\menu\classes\privacy\provider.php
+ *
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider_test extends provider_testcase {
+
+    /**
+     * Basic setup for these tests.
+     */
+    public function setUp(): void {
+        $this->resetAfterTest(true);
+    }
+
+    /**
+     * Test getting the context for the user ID related to this plugin.
+     */
+    public function test_get_contexts_for_userid(): void {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create profile field.
+        $profilefieldid = $this->add_profile_field($categoryid, 'menu');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $this->add_user_info_data($user->id, $profilefieldid, 'test data');
+        // Get the field that was created.
+        $userfielddata = $DB->get_records('user_info_data', array('userid' => $user->id));
+        // Confirm we got the right number of user field data.
+        $this->assertCount(1, $userfielddata);
+        $context = \context_user::instance($user->id);
+        $contextlist = provider::get_contexts_for_userid($user->id);
+        $this->assertEquals($context, $contextlist->current());
+    }
+
+    /**
+     * Test that data is exported correctly for this plugin.
+     */
+    public function test_export_user_data(): void {
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create menu profile field.
+        $menuprofilefieldid = $this->add_profile_field($categoryid, 'menu');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = \context_user::instance($user->id);
+        // Add menu user info data.
+        $this->add_user_info_data($user->id, $menuprofilefieldid, 'test menu');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        $writer = \core_privacy\local\request\writer::with_context($context);
+        $this->assertFalse($writer->has_any_data());
+        $this->export_context_data_for_user($user->id, $context, 'profilefield_menu');
+        $data = $writer->get_data([get_string('pluginname', 'profilefield_menu')]);
+        $this->assertCount(3, (array) $data);
+        $this->assertEquals('Test field', $data->name);
+        $this->assertEquals('This is a test.', $data->description);
+        $this->assertEquals('test menu', $data->data);
+    }
+
+    /**
+     * Test that user data is deleted using the context.
+     */
+    public function test_delete_data_for_all_users_in_context(): void {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create menu profile field.
+        $menuprofilefieldid = $this->add_profile_field($categoryid, 'menu');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = \context_user::instance($user->id);
+        // Add menu user info data.
+        $this->add_user_info_data($user->id, $menuprofilefieldid, 'test menu');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        // Check that we have two entries.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(2, $userinfodata);
+        provider::delete_data_for_all_users_in_context($context);
+        // Check that the correct profile field has been deleted.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(1, $userinfodata);
+        $this->assertNotEquals('test menu', reset($userinfodata)->data);
+    }
+
+    /**
+     * Test that user data is deleted for this user.
+     */
+    public function test_delete_data_for_user(): void {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create menu profile field.
+        $menuprofilefieldid = $this->add_profile_field($categoryid, 'menu');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = \context_user::instance($user->id);
+        // Add menu user info data.
+        $this->add_user_info_data($user->id, $menuprofilefieldid, 'test menu');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        // Check that we have two entries.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(2, $userinfodata);
+        $approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'profilefield_menu',
+            [$context->id]);
+        provider::delete_data_for_user($approvedlist);
+        // Check that the correct profile field has been deleted.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(1, $userinfodata);
+        $this->assertNotEquals('test menu', reset($userinfodata)->data);
+    }
+
+    /**
+     * Test that only users with a user context are fetched.
+     */
+    public function test_get_users_in_context(): void {
+        $this->resetAfterTest();
+
+        $component = 'profilefield_menu';
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create menu profile field.
+        $profilefieldid = $this->add_profile_field($categoryid, 'menu');
+
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $usercontext = \context_user::instance($user->id);
+        // The list of users should not return anything yet (related data still haven't been created).
+        $userlist = new \core_privacy\local\request\userlist($usercontext, $component);
+        provider::get_users_in_context($userlist);
+        $this->assertCount(0, $userlist);
+
+        $this->add_user_info_data($user->id, $profilefieldid, 'test data');
+
+        // The list of users for user context should return the user.
+        provider::get_users_in_context($userlist);
+        $this->assertCount(1, $userlist);
+        $expected = [$user->id];
+        $actual = $userlist->get_userids();
+        $this->assertEquals($expected, $actual);
+
+        // The list of users for system context should not return any users.
+        $systemcontext = \context_system::instance();
+        $userlist = new \core_privacy\local\request\userlist($systemcontext, $component);
+        provider::get_users_in_context($userlist);
+        $this->assertCount(0, $userlist);
+    }
+
+    /**
+     * Test that data for users in approved userlist is deleted.
+     */
+    public function test_delete_data_for_users(): void {
+        $this->resetAfterTest();
+
+        $component = 'profilefield_menu';
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create menu profile field.
+        $profilefieldid = $this->add_profile_field($categoryid, 'menu');
+
+        // Create user1.
+        $user1 = $this->getDataGenerator()->create_user();
+        $usercontext1 = \context_user::instance($user1->id);
+        // Create user2.
+        $user2 = $this->getDataGenerator()->create_user();
+        $usercontext2 = \context_user::instance($user2->id);
+
+        $this->add_user_info_data($user1->id, $profilefieldid, 'test data');
+        $this->add_user_info_data($user2->id, $profilefieldid, 'test data');
+
+        // The list of users for usercontext1 should return user1.
+        $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
+        provider::get_users_in_context($userlist1);
+        $this->assertCount(1, $userlist1);
+        $expected = [$user1->id];
+        $actual = $userlist1->get_userids();
+        $this->assertEquals($expected, $actual);
+
+        // The list of users for usercontext2 should return user2.
+        $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
+        provider::get_users_in_context($userlist2);
+        $this->assertCount(1, $userlist2);
+        $expected = [$user2->id];
+        $actual = $userlist2->get_userids();
+        $this->assertEquals($expected, $actual);
+
+        // Add userlist1 to the approved user list.
+        $approvedlist = new approved_userlist($usercontext1, $component, $userlist1->get_userids());
+
+        // Delete user data using delete_data_for_user for usercontext1.
+        provider::delete_data_for_users($approvedlist);
+
+        // Re-fetch users in usercontext1 - The user list should now be empty.
+        $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
+        provider::get_users_in_context($userlist1);
+        $this->assertCount(0, $userlist1);
+
+        // Re-fetch users in usercontext2 - The user list should not be empty (user2).
+        $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
+        provider::get_users_in_context($userlist2);
+        $this->assertCount(1, $userlist2);
+
+        // User data should be only removed in the user context.
+        $systemcontext = \context_system::instance();
+        // Add userlist2 to the approved user list in the system context.
+        $approvedlist = new approved_userlist($systemcontext, $component, $userlist2->get_userids());
+        // Delete user1 data using delete_data_for_user.
+        provider::delete_data_for_users($approvedlist);
+        // Re-fetch users in usercontext2 - The user list should not be empty (user2).
+        $userlist1 = new \core_privacy\local\request\userlist($usercontext2, $component);
+        provider::get_users_in_context($userlist1);
+        $this->assertCount(1, $userlist1);
+    }
+
+    /**
+     * Add dummy user info data.
+     *
+     * @param int $userid The ID of the user
+     * @param int $fieldid The ID of the field
+     * @param string $data The data
+     */
+    private function add_user_info_data($userid, $fieldid, $data) {
+        global $DB;
+
+        $userinfodata = array(
+            'userid' => $userid,
+            'fieldid' => $fieldid,
+            'data' => $data,
+            'dataformat' => 0
+        );
+
+        $DB->insert_record('user_info_data', $userinfodata);
+    }
+
+    /**
+     * Add dummy profile category.
+     *
+     * @return int The ID of the profile category
+     */
+    private function add_profile_category() {
+        $cat = $this->getDataGenerator()->create_custom_profile_field_category(['name' => 'Test category']);
+        return $cat->id;
+    }
+
+    /**
+     * Add dummy profile field.
+     *
+     * @param int $categoryid The ID of the profile category
+     * @param string $datatype The datatype of the profile field
+     * @return int The ID of the profile field
+     */
+    private function add_profile_field($categoryid, $datatype) {
+        $data = $this->getDataGenerator()->create_custom_profile_field([
+            'datatype' => $datatype,
+            'shortname' => 'tstField',
+            'name' => 'Test field',
+            'description' => 'This is a test.',
+            'categoryid' => $categoryid,
+        ]);
+        return $data->id;
+    }
+}

user/profile/field/menu/version.php

@@ -0,0 +1,29 @@
+<?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/>.
+
+/**
+ * Menu profile field version information.
+ *
+ * @package    profilefield_menu
+ * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2024042200;        // The current plugin version (Date: YYYYMMDDXX).
+$plugin->requires  = 2024041600;        // Requires this Moodle version.
+$plugin->component = 'profilefield_menu'; // Full name of the plugin (used for diagnostics)