first commit

This commit is contained in:
CHIEFSOFT\ameye
2024-09-30 18:11:26 -04:00
commit e592ca6823
27270 changed files with 5002257 additions and 0 deletions
@@ -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_checkbox
* @copyright 2018 Mihail Geshoski <mihail@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace profilefield_checkbox\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_checkbox:userid',
'fieldid' => 'privacy:metadata:profilefield_checkbox:fieldid',
'data' => 'privacy:metadata:profilefield_checkbox:data',
'dataformat' => 'privacy:metadata:profilefield_checkbox:dataformat'
], 'privacy:metadata:profilefield_checkbox: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' => 'checkbox'
];
$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' => 'checkbox'
];
$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_checkbox')], $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' => 'checkbox'
];
$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' => 'checkbox'
];
return $DB->get_records_sql($sql, $params);
}
}
@@ -0,0 +1,45 @@
<?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/>.
/**
* Checkbox profile field
*
* @package profilefield_checkbox
* @copyright 2008 onwards Shane Elliot {@link http://pukunui.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Class profile_define_checkbox
* @copyright 2008 onwards Shane Elliot {@link http://pukunui.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class profile_define_checkbox extends profile_define_base {
/**
* Add elements for creating/editing a checkbox profile field.
*
* @param moodleform $form
*/
public function define_form_specific($form) {
// Select whether or not this should be checked by default.
$form->addElement('selectyesno', 'defaultdata', get_string('profiledefaultchecked', 'admin'));
$form->setDefault('defaultdata', 0); // Defaults to 'no'.
$form->setType('defaultdata', PARAM_BOOL);
}
}
@@ -0,0 +1,88 @@
<?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/>.
/**
* Class profile_field_checkbox
*
* @package profilefield_checkbox
* @copyright 2008 onwards Shane Elliot {@link http://pukunui.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class profile_field_checkbox extends profile_field_base {
/**
* Add elements for editing the profile field value.
* @param moodleform $mform
*/
public function edit_field_add($mform) {
// Create the form field.
$checkbox = $mform->addElement('advcheckbox', $this->inputname, format_string($this->field->name));
if ($this->data == '1') {
$checkbox->setChecked(true);
}
$mform->setType($this->inputname, PARAM_BOOL);
if ($this->is_required() and !has_capability('moodle/user:update', context_system::instance())) {
$mform->addRule($this->inputname, get_string('required'), 'nonzero', null, 'client');
}
}
/**
* Override parent {@see profile_field_base::is_empty} check
*
* We can't check the "data" property, because if not set by the user then it's populated by "defaultdata" of the field,
* which can also be 0 (false) therefore ensuring the parent class check could never return true for this comparison
*
* @return bool
*/
public function is_empty() {
return ($this->userid && !$this->field->hasuserdata);
}
/**
* Override parent {@see profile_field_base::show_field_content} check
*
* We only need to determine whether the field is visible, because we also want to show the "defaultdata" of the field,
* even if the user hasn't explicitly filled it in
*
* @param context|null $context
* @return bool
*/
public function show_field_content(?context $context = null): bool {
return $this->is_visible($context);
}
/**
* Display the data for this field
*
* @return string HTML.
*/
public function display_data() {
return $this->data ? get_string('yes') : get_string('no');
}
/**
* 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_BOOL, NULL_NOT_ALLOWED);
}
}
@@ -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_checkbox', language 'en', branch 'MOODLE_20_STABLE'
*
* @package profilefield_checkbox
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
$string['pluginname'] = 'Checkbox';
$string['privacy:metadata:profilefield_checkbox:userid'] = 'The ID of the user whose data is stored by the Checkbox user profile field';
$string['privacy:metadata:profilefield_checkbox:fieldid'] = 'The ID of the profile field';
$string['privacy:metadata:profilefield_checkbox:data'] = 'The checkbox user profile field user data';
$string['privacy:metadata:profilefield_checkbox:dataformat'] = 'The format of Checkbox user profile field user data';
$string['privacy:metadata:profilefield_checkbox:tableexplanation'] = 'Additional profile data';
@@ -0,0 +1,301 @@
<?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_checkbox.
*
* @package profilefield_checkbox
* @copyright 2018 Mihail Geshoski <mihail@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace profilefield_checkbox\privacy;
defined('MOODLE_INTERNAL') || die();
use core_privacy\tests\provider_testcase;
use profilefield_checkbox\privacy\provider;
use core_privacy\local\request\approved_userlist;
/**
* Unit tests for user\profile\field\checkbox\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, 'checkbox');
// 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 checkbox profile field.
$checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
// Create datetime profile field.
$datetimeprofilefieldid = $this->add_profile_field($categoryid, 'datetime');
// Create a user.
$user = $this->getDataGenerator()->create_user();
$context = \context_user::instance($user->id);
// Add checkbox user info data.
$this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
// Add datetime user info data.
$this->add_user_info_data($user->id, $datetimeprofilefieldid, '1524067200');
$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_checkbox');
$data = $writer->get_data([get_string('pluginname', 'profilefield_checkbox')]);
$this->assertCount(3, (array) $data);
$this->assertEquals('Test field', $data->name);
$this->assertEquals('This is a test.', $data->description);
$this->assertEquals('test data', $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 checkbox profile field.
$checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
// Create datetime profile field.
$datetimeprofilefieldid = $this->add_profile_field($categoryid, 'datetime');
// Create a user.
$user = $this->getDataGenerator()->create_user();
$context = \context_user::instance($user->id);
// Add checkbox user info data.
$this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
// Add datetime user info data.
$this->add_user_info_data($user->id, $datetimeprofilefieldid, '1524067200');
// 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 data', 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 checkbox profile field.
$checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
// Create datetime profile field.
$datetimeprofilefieldid = $this->add_profile_field($categoryid, 'datetime');
// Create a user.
$user = $this->getDataGenerator()->create_user();
$context = \context_user::instance($user->id);
// Add checkbox user info data.
$this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
// Add datetime user info data.
$this->add_user_info_data($user->id, $datetimeprofilefieldid, '1524067200');
// 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_checkbox',
[$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 data', 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_checkbox';
// Create profile category.
$categoryid = $this->add_profile_category();
// Create profile field.
$profilefieldid = $this->add_profile_field($categoryid, 'checkbox');
// 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_checkbox';
// Create profile category.
$categoryid = $this->add_profile_category();
// Create profile field.
$profilefieldid = $this->add_profile_field($categoryid, 'checkbox');
// 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;
}
}
@@ -0,0 +1,122 @@
<?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/>.
namespace profilefield_checkbox;
use advanced_testcase;
use profile_field_checkbox;
/**
* Unit tests for the field class
*
* @package profilefield_checkbox
* @covers \profile_field_checkbox
* @copyright 2024 Paul Holden <paulh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class profile_field_checkbox_test extends advanced_testcase {
/**
* Load required test libraries
*/
public static function setUpBeforeClass(): void {
global $CFG;
require_once("{$CFG->dirroot}/user/profile/lib.php");
}
/**
* Data provider for {@see test_is_empty}
*
* @return array[]
*/
public static function is_empty_provider(): array {
return [
'No value' => [
[],
true,
],
'Value equals 0' => [
['profile_field_check' => 0],
false,
],
'Value equals 1' => [
['profile_field_check' => 1],
false,
],
];
}
/**
* Test field empty state
*
* @param array $userrecord
* @param bool $expected
*
* @dataProvider is_empty_provider
*/
public function test_is_empty(array $userrecord, bool $expected): void {
$this->resetAfterTest();
$this->getDataGenerator()->create_custom_profile_field([
'datatype' => 'checkbox',
'name' => 'My check',
'shortname' => 'check',
]);
$user = $this->getDataGenerator()->create_user($userrecord);
/** @var profile_field_checkbox[] $fields */
$fields = profile_get_user_fields_with_data($user->id);
$fieldinstance = reset($fields);
$this->assertEquals($expected, $fieldinstance->is_empty());
}
/**
* Test whether to show field content
*/
public function test_show_field_content(): void {
$this->resetAfterTest();
$this->getDataGenerator()->create_custom_profile_field([
'datatype' => 'checkbox',
'name' => 'My check',
'shortname' => 'check',
'visible' => PROFILE_VISIBLE_PRIVATE,
]);
// User can view their own value.
$userwith = $this->getDataGenerator()->create_user(['profile_field_check' => 1]);
$this->setUser($userwith);
/** @var profile_field_checkbox[] $fields */
$fields = profile_get_user_fields_with_data($userwith->id);
$fieldinstance = reset($fields);
$this->assertTrue($fieldinstance->show_field_content());
// Another user cannot view the value.
$userview = $this->getDataGenerator()->create_user();
$this->setUser($userview);
$this->assertFalse($fieldinstance->show_field_content());
// Another user with appropriate access can view the value.
$this->setAdminUser();
$this->assertTrue($fieldinstance->show_field_content());
}
}
+29
View File
@@ -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/>.
/**
* Version information for the checkbox profile field type.
*
* @package profilefield_checkbox
* @copyright 2008 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_checkbox'; // Full name of the plugin (used for diagnostics)