-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from sudile/master
Reworked widget plugin system and fixed minor issues
- Loading branch information
Showing
15 changed files
with
270 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| <?php | ||
| // This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>. | ||
|
|
||
| namespace local_accessibility\privacy; | ||
|
|
||
| use core_privacy\local\metadata\collection; | ||
| use core_privacy\local\request\approved_contextlist; | ||
| use core_privacy\local\request\approved_userlist; | ||
| use core_privacy\local\request\contextlist; | ||
| use core_privacy\local\request\core_userlist_provider; | ||
| use core_privacy\local\request\transform; | ||
| use core_privacy\local\request\userlist; | ||
| use core_privacy\local\request\writer; | ||
|
|
||
| /** | ||
| * Privacy Subsystem implementation for local_accessibility. | ||
| * | ||
| * @package local_accessibility | ||
| * @copyright 2023 Ponlawat Weerapanpisit <[email protected]> | ||
| * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class provider implements | ||
| // This plugin has data. | ||
| \core_privacy\local\metadata\provider, | ||
| // This plugin has some sitewide user preferences to export. | ||
| core_userlist_provider, | ||
| \core_privacy\local\request\plugin\provider { | ||
|
|
||
| /** | ||
| * 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 { | ||
| $contextlist = new contextlist(); | ||
| $contextlist->add_system_context(); | ||
| return $contextlist; | ||
| } | ||
|
|
||
| /** | ||
| * Export all user data for the specified user, in the specified contexts. | ||
| * | ||
| * @param approved_contextlist $contextlist The approved contexts to export information for. | ||
| * @throws dml_exception | ||
| */ | ||
| public static function export_user_data(approved_contextlist $contextlist) { | ||
| global $DB; | ||
| $systemcontext = \context_system::instance(); | ||
| $user = $contextlist->get_user(); | ||
| if (!$contextlist->valid() || $contextlist->current()->contextlevel != CONTEXT_SYSTEM) { | ||
| return; | ||
| } | ||
| $rs = $DB->get_records_sql('SELECT c.widget, c.configvalue, c.userid | ||
| FROM {local_accessibility_configs} c | ||
| WHERE c.userid = :userid | ||
| ORDER BY c.widget, c.configvalue, c.userid', | ||
| ['userid' => $user->id]); | ||
| if (count($rs) == 0) { | ||
| return; | ||
| } | ||
| foreach ($rs as $config) { | ||
| $contextdata = (object) [ | ||
| 'widget' => $config->widget, | ||
| 'configvalue' => $config->configvalue, | ||
| 'userid' => transform::user($config->userid), | ||
| ]; | ||
| writer::with_context($systemcontext)->export_data(["local_accessibility_config"], $contextdata); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Delete all data for all users in the specified context. | ||
| * | ||
| * @param \context $context The specific context to delete data for. | ||
| * @throws dml_exception | ||
| */ | ||
| public static function delete_data_for_all_users_in_context(\context $context) { | ||
| global $DB; | ||
| if ($context->contextlevel != CONTEXT_SYSTEM) { | ||
| return; | ||
| } | ||
| // We just delete all data from the system context since we don't have other assignments? | ||
| $DB->delete_records('local_accessibility_configs'); | ||
| } | ||
|
|
||
| /** | ||
| * 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. | ||
| * @throws dml_exception | ||
| */ | ||
| public static function delete_data_for_user(approved_contextlist $contextlist) { | ||
| global $DB; | ||
| if (!$contextlist->valid() || $contextlist->current()->contextlevel != CONTEXT_SYSTEM) { | ||
| return; | ||
| } | ||
| $DB->delete_records('local_accessibility_configs', ['userid' => $contextlist->get_user()->id]); | ||
| } | ||
|
|
||
| /** | ||
| * Get the list of users who have data within a 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 (!is_a($context, \context_system::class)) { | ||
| return; | ||
| } | ||
| // Since we only have one system context all data lay here! | ||
| $sql = "SELECT userid FROM {local_accessibility_configs}"; | ||
| $userlist->add_from_sql('userid', $sql, []); | ||
| } | ||
|
|
||
| /** | ||
| * Delete multiple users within a single context. | ||
| * | ||
| * @param approved_userlist $userlist The approved context and user information to delete information for. | ||
| * @throws dml_exception | ||
| * @throws coding_exception | ||
| */ | ||
| public static function delete_data_for_users(approved_userlist $userlist) { | ||
| global $DB; | ||
| $context = $userlist->get_context(); | ||
| $userids = $userlist->get_userids(); | ||
| if ($context->contextlevel != CONTEXT_SYSTEM) { | ||
| return; | ||
| } | ||
| [$insql, $inparams] = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED); | ||
| $sql = "userid {$insql}"; | ||
| $DB->delete_records_select('local_accessibility_configs', $sql, $inparams); | ||
| } | ||
|
|
||
| /** | ||
| * Returns metadata 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 { | ||
| $collection->add_database_table( | ||
| 'local_accessibility_configs', | ||
| [ | ||
| 'widget' => 'privacy:metadata:configs:widget', | ||
| 'configvalue' => 'privacy:metadata:configs:configvalue', | ||
| 'userid' => 'privacy:metadata:configs:userid', | ||
| ], | ||
| 'privacy:metadata:configs' | ||
| ); | ||
| return $collection; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <?php | ||
| // This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>. | ||
|
|
||
| /** | ||
| * Interface which can be implemented by subplugins for css usage. | ||
| * | ||
| * @package local_accessibility | ||
| * @copyright 2023 Ponlawat Weerapanpisit <[email protected]> | ||
| * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace local_accessibility\widgets; | ||
| /** | ||
| * Used by widgets to mark that they have styles which need to be applied. | ||
| */ | ||
| interface apply_style { | ||
| /** | ||
| * Apply widget css will be served over the styles.php file. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function apply_style(): string; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.