Privacy API/Utilities - Revision history

Devdocsbot: Protected "Privacy API/Utilities": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-23T23:58:10Z

Protected "Privacy API/Utilities": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 23:58, 23 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-23T23:56:33Z

Update migration status and path

← Older revision		Revision as of 23:56, 23 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/privacy/utils}}
	While implementing the privacy API into your plugin, there are CLI scripts that can help you to test things on the fly. Just don't forget these are not supposed to replace proper unit tests.		While implementing the privacy API into your plugin, there are CLI scripts that can help you to test things on the fly. Just don't forget these are not supposed to replace proper unit tests.

Pholden: Fix syntaxhighlight tags.

2021-07-14T19:53:25Z

Fix syntaxhighlight tags.

← Older revision		Revision as of 19:53, 14 July 2021
Line 105:		Line 105:
	return $rcm->invoke($manager, $component, $interface);		return $rcm->invoke($manager, $component, $interface);
	}		}
	</~~code~~>		</syntaxhighlight>

	== Test of exporting user data ==		== Test of exporting user data ==
Line 197:		Line 197:
	echo "== File export was uncompressed to {$exportpath}\n";		echo "== File export was uncompressed to {$exportpath}\n";
	echo "============================================================================\n";		echo "============================================================================\n";
	</~~code~~>		</syntaxhighlight>

	== Test of deleting user data ==		== Test of deleting user data ==
Line 272:		Line 272:

	$manager->delete_data_for_user($approvedlist, $trace);		$manager->delete_data_for_user($approvedlist, $trace);
	</~~code~~>		</syntaxhighlight>

	[[Category:Privacy]]		[[Category:Privacy]]

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:30:57Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:30, 14 July 2021
				
Line 5:
Line 5:
== Test of privacy API compliance == == Test of privacy API compliance ==



<code php> <syntaxhighlight lang="php">
<?php <?php



Line 109:
Line 109:
== Test of exporting user data == == Test of exporting user data ==



<code php> <syntaxhighlight lang="php">
<?php <?php
// This file is part of Moodle - http://moodle.org/ // This file is part of Moodle - http://moodle.org/
Line 201:
Line 201:
== Test of deleting user data == == Test of deleting user data ==



<code php> <syntaxhighlight lang="php">
<?php <?php
// This file is part of Moodle - http://moodle.org/ // This file is part of Moodle - http://moodle.org/



Vadimon: fix error
2021-01-03T04:46:22Z
fix error

				
				
				
				
				
				← Older revision
				Revision as of 04:46, 3 January 2021
				
Line 59:
Line 59:
         $collection = new \core_privacy\local\metadata\collection($component);          $collection = new \core_privacy\local\metadata\collection($component);
         $classname::get_metadata($collection);          $classname::get_metadata($collection);
         $count = count($collection);          $count = count($collection->get_collection());
         echo "    Found {$count} items of metadata\n";          echo "    Found {$count} items of metadata\n";
         if (empty($count)) {          if (empty($count)) {



Andrewnicols: Add deletion tool
2018-05-25T04:13:44Z
Add deletion tool

				
				
				
				
				
				← Older revision
				Revision as of 04:13, 25 May 2018
				
Line 197:
Line 197:
echo "== File export was uncompressed to {$exportpath}\n"; echo "== File export was uncompressed to {$exportpath}\n";
echo "============================================================================\n"; echo "============================================================================\n";
</code>

== Test of deleting user data ==

<code php>
<?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/>.

define('CLI_SCRIPT', true);
require_once('config.php');
require_once("$CFG->libdir/clilib.php");

list($options, $unrecognized) = cli_get_params(
    [
        'username' => '',
        'userid' => '',
    ],
    []
);

$user = null;
$username = $options['username'];
$userid = $options['userid'];

if (!empty($options['username'])) {
    $user = \core_user::get_user_by_username($options['username']);
} else if (!empty($options['userid'])) {
    $user = \core_user::get_user($options['userid']);
}

while (empty($user)) {
    if (!empty($username)) {
        echo "Unable to find a user with username '{$username}'.\n";
        echo "Try again.\n";
    } else if (!empty($userid)) {
        echo "Unable to find a user with userid '{$userid}'.\n";
        echo "Try again.\n";
    }
    $username = readline("Username: ");
    $user = \core_user::get_user_by_username($username);
}

echo "Processing delete for " . fullname($user) . "\n";

\core\session\manager::init_empty_session();
\core\session\manager::set_user($user);

$manager = new \core_privacy\manager();

$approvedlist = new \core_privacy\local\request\contextlist_collection($user->id);

$trace = new text_progress_trace();
$contextlists = $manager->get_contexts_for_userid($user->id, $trace);
foreach ($contextlists as $contextlist) {
    $approvedlist->add_contextlist(new \core_privacy\local\request\approved_contextlist(
        $user,
        $contextlist->get_component(),
        $contextlist->get_contextids()
    ));
}

$manager->delete_data_for_user($approvedlist, $trace);
</code> </code>






Andrewnicols: /* Test of exporting user data */
2018-05-10T01:14:58Z
Test of exporting user data

				
				
				
				
				
				← Older revision
				Revision as of 01:14, 10 May 2018
				
Line 171:
Line 171:
\core\session\manager::init_empty_session(); \core\session\manager::init_empty_session();
\core\session\manager::set_user($user); \core\session\manager::set_user($user);

$PAGE = new moodle_page();
$OUTPUT = new core_renderer($PAGE, RENDERER_TARGET_GENERAL);



$manager = new \core_privacy\manager(); $manager = new \core_privacy\manager();



Basbrands at 09:57, 4 May 2018
2018-05-04T09:57:57Z


				
				
				
				
				
				← Older revision
				Revision as of 09:57, 4 May 2018
				
Line 186:
Line 186:



$exportedcontent = $manager->export_user_data($approvedlist); $exportedcontent = $manager->export_user_data($approvedlist);

echo "\n"; 
echo "== File was successfully exported to {$exportedcontent}\n"; 

$basedir = make_temp_directory('privacy'); $basedir = make_temp_directory('privacy');
$exportpath = make_unique_writable_directory($basedir, true); $exportpath = make_unique_writable_directory($basedir, true);
Line 195:
Line 191:
$fp->extract_to_pathname($exportedcontent, $exportpath); $fp->extract_to_pathname($exportedcontent, $exportpath);



echo "\n";
echo "== File export was uncompressed to {$exportpath}\n"; echo "== File export was uncompressed to {$exportpath}\n";
echo "============================================================================\n"; echo "============================================================================\n";



Andrewnicols: Add another category for privacy
2018-04-22T23:51:07Z
Add another category for privacy

				
				
				
				
				
				← Older revision
				Revision as of 23:51, 22 April 2018
				
Line 199:
Line 199:
</code> </code>



  [[Category:Privacy]]
[[Category:GDPR]] [[Category:GDPR]]
[[Category:Utilities]] [[Category:Utilities]]
[[Category:SampleCode]] [[Category:SampleCode]]



Andrewnicols: Categorise the page
2018-04-22T23:50:33Z
Categorise the page

				
				
				
				
				
				← Older revision
				Revision as of 23:50, 22 April 2018
				
Line 198:
Line 198:
echo "============================================================================\n"; echo "============================================================================\n";
</code> </code>


[[Category:GDPR]]
[[Category:Utilities]]
[[Category:SampleCode]]

← Older revision		Revision as of 13:30, 14 July 2021
Line 5:		Line 5:
	== Test of privacy API compliance ==		== Test of privacy API compliance ==

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 109:		Line 109:
	== Test of exporting user data ==		== Test of exporting user data ==

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php
	// This file is part of Moodle - http://moodle.org/		// This file is part of Moodle - http://moodle.org/
Line 201:		Line 201:
	== Test of deleting user data ==		== Test of deleting user data ==

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php
	// This file is part of Moodle - http://moodle.org/		// This file is part of Moodle - http://moodle.org/

← Older revision		Revision as of 04:46, 3 January 2021
Line 59:		Line 59:
	$collection = new \core_privacy\local\metadata\collection($component);		$collection = new \core_privacy\local\metadata\collection($component);
	$classname::get_metadata($collection);		$classname::get_metadata($collection);
	$count = count($collection);		$count = count($collection->get_collection());
	echo " Found {$count} items of metadata\n";		echo " Found {$count} items of metadata\n";
	if (empty($count)) {		if (empty($count)) {

← Older revision		Revision as of 01:14, 10 May 2018
Line 171:		Line 171:
	\core\session\manager::init_empty_session();		\core\session\manager::init_empty_session();
	\core\session\manager::set_user($user);		\core\session\manager::set_user($user);

			$PAGE = new moodle_page();
			$OUTPUT = new core_renderer($PAGE, RENDERER_TARGET_GENERAL);

	$manager = new \core_privacy\manager();		$manager = new \core_privacy\manager();

← Older revision		Revision as of 09:57, 4 May 2018
Line 186:		Line 186:

	$exportedcontent = $manager->export_user_data($approvedlist);		$exportedcontent = $manager->export_user_data($approvedlist);

	~~echo "\n";~~
	~~echo "== File was successfully exported to {$exportedcontent}\n";~~

	$basedir = make_temp_directory('privacy');		$basedir = make_temp_directory('privacy');
	$exportpath = make_unique_writable_directory($basedir, true);		$exportpath = make_unique_writable_directory($basedir, true);
Line 195:		Line 191:
	$fp->extract_to_pathname($exportedcontent, $exportpath);		$fp->extract_to_pathname($exportedcontent, $exportpath);

			echo "\n";
	echo "== File export was uncompressed to {$exportpath}\n";		echo "== File export was uncompressed to {$exportpath}\n";
	echo "============================================================================\n";		echo "============================================================================\n";

← Older revision		Revision as of 23:51, 22 April 2018
Line 199:		Line 199:
	</code>		</code>

			[[Category:Privacy]]
	[[Category:GDPR]]		[[Category:GDPR]]
	[[Category:Utilities]]		[[Category:Utilities]]
	[[Category:SampleCode]]		[[Category:SampleCode]]

← Older revision		Revision as of 23:50, 22 April 2018
Line 198:		Line 198:
	echo "============================================================================\n";		echo "============================================================================\n";
	</code>		</code>


			[[Category:GDPR]]
			[[Category:Utilities]]
			[[Category:SampleCode]]

Privacy API/Utilities - Revision history

Devdocsbot: Protected "Privacy API/Utilities": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Pholden: Fix syntaxhighlight tags.

Mudrd8mz: Text replacement - "" to ""

Vadimon: fix error

Andrewnicols: Add deletion tool

Andrewnicols: /* Test of exporting user data */

Basbrands at 09:57, 4 May 2018

Andrewnicols: Add another category for privacy

Andrewnicols: Categorise the page

Mudrd8mz: Text replacement - "`" to ""`