From 57a59d6c5aa0a70e0cb40c927c69a95c23f69fb3 Mon Sep 17 00:00:00 2001
From: David Monllao <davidm@moodle.com>
Date: Wed, 11 Apr 2018 10:49:17 +0200
Subject: [PATCH] MDL-61899 tool_dataprivacy: Remove upgrade.php and add @since

---
 admin/tool/dataprivacy/classes/external.php | 43 ++++++++++++++++++++
 admin/tool/dataprivacy/db/upgrade.php       | 44 ---------------------
 2 files changed, 43 insertions(+), 44 deletions(-)
 delete mode 100644 admin/tool/dataprivacy/db/upgrade.php

diff --git a/admin/tool/dataprivacy/classes/external.php b/admin/tool/dataprivacy/classes/external.php
index 4e5a50a4685..63f8ecb5473 100644
--- a/admin/tool/dataprivacy/classes/external.php
+++ b/admin/tool/dataprivacy/classes/external.php
@@ -62,6 +62,7 @@ class external extends external_api {
     /**
      * Parameter description for cancel_data_request().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function cancel_data_request_parameters() {
@@ -73,6 +74,7 @@ class external extends external_api {
     /**
      * Cancel a data request.
      *
+     * @since Moodle 3.5
      * @param int $requestid The request ID.
      * @return array
      * @throws invalid_persistent_exception
@@ -119,6 +121,7 @@ class external extends external_api {
     /**
      * Parameter description for cancel_data_request().
      *
+     * @since Moodle 3.5
      * @return external_description
      */
     public static function cancel_data_request_returns() {
@@ -131,6 +134,7 @@ class external extends external_api {
     /**
      * Parameter description for contact_dpo().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function contact_dpo_parameters() {
@@ -142,6 +146,7 @@ class external extends external_api {
     /**
      * Deny a data request.
      *
+     * @since Moodle 3.5
      * @param string $message The message to be sent to the DPO.
      * @return array
      * @throws coding_exception
@@ -207,6 +212,7 @@ class external extends external_api {
     /**
      * Parameter description for deny_data_request().
      *
+     * @since Moodle 3.5
      * @return external_description
      */
     public static function contact_dpo_returns() {
@@ -219,6 +225,7 @@ class external extends external_api {
     /**
      * Parameter description for get_data_request().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function get_data_request_parameters() {
@@ -230,6 +237,7 @@ class external extends external_api {
     /**
      * Fetch the details of a user's data request.
      *
+     * @since Moodle 3.5
      * @param int $requestid The request ID.
      * @return array
      * @throws coding_exception
@@ -266,6 +274,7 @@ class external extends external_api {
     /**
      * Parameter description for get_data_request().
      *
+     * @since Moodle 3.5
      * @return external_description
      */
     public static function get_data_request_returns() {
@@ -278,6 +287,7 @@ class external extends external_api {
     /**
      * Parameter description for approve_data_request().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function approve_data_request_parameters() {
@@ -289,6 +299,7 @@ class external extends external_api {
     /**
      * Approve a data request.
      *
+     * @since Moodle 3.5
      * @param int $requestid The request ID.
      * @return array
      * @throws coding_exception
@@ -332,6 +343,7 @@ class external extends external_api {
     /**
      * Parameter description for approve_data_request().
      *
+     * @since Moodle 3.5
      * @return external_description
      */
     public static function approve_data_request_returns() {
@@ -344,6 +356,7 @@ class external extends external_api {
     /**
      * Parameter description for deny_data_request().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function deny_data_request_parameters() {
@@ -355,6 +368,7 @@ class external extends external_api {
     /**
      * Deny a data request.
      *
+     * @since Moodle 3.5
      * @param int $requestid The request ID.
      * @return array
      * @throws coding_exception
@@ -398,6 +412,7 @@ class external extends external_api {
     /**
      * Parameter description for deny_data_request().
      *
+     * @since Moodle 3.5
      * @return external_description
      */
     public static function deny_data_request_returns() {
@@ -410,6 +425,7 @@ class external extends external_api {
     /**
      * Parameter description for get_data_request().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function get_users_parameters() {
@@ -421,6 +437,7 @@ class external extends external_api {
     /**
      * Fetch the details of a user's data request.
      *
+     * @since Moodle 3.5
      * @param string $query The search request.
      * @return array
      * @throws required_capability_exception
@@ -460,6 +477,7 @@ class external extends external_api {
     /**
      * Parameter description for get_users().
      *
+     * @since Moodle 3.5
      * @return external_description
      * @throws coding_exception
      */
@@ -476,6 +494,7 @@ class external extends external_api {
     /**
      * Parameter description for create_purpose_form().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function create_purpose_form_parameters() {
@@ -487,6 +506,7 @@ class external extends external_api {
     /**
      * Creates a data purpose from form data.
      *
+     * @since Moodle 3.5
      * @param string $jsonformdata
      * @return array
      */
@@ -527,6 +547,7 @@ class external extends external_api {
     /**
      * Returns for create_purpose_form().
      *
+     * @since Moodle 3.5
      * @return external_single_structure
      */
     public static function create_purpose_form_returns() {
@@ -540,6 +561,7 @@ class external extends external_api {
     /**
      * Parameter description for delete_purpose().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function delete_purpose_parameters() {
@@ -551,6 +573,7 @@ class external extends external_api {
     /**
      * Deletes a data purpose.
      *
+     * @since Moodle 3.5
      * @param int $id The ID.
      * @return array
      * @throws invalid_persistent_exception
@@ -575,6 +598,7 @@ class external extends external_api {
     /**
      * Parameter description for delete_purpose().
      *
+     * @since Moodle 3.5
      * @return external_single_structure
      */
     public static function delete_purpose_returns() {
@@ -587,6 +611,7 @@ class external extends external_api {
     /**
      * Parameter description for create_category_form().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function create_category_form_parameters() {
@@ -598,6 +623,7 @@ class external extends external_api {
     /**
      * Creates a data category from form data.
      *
+     * @since Moodle 3.5
      * @param string $jsonformdata
      * @return array
      */
@@ -638,6 +664,7 @@ class external extends external_api {
     /**
      * Returns for create_category_form().
      *
+     * @since Moodle 3.5
      * @return external_single_structure
      */
     public static function create_category_form_returns() {
@@ -651,6 +678,7 @@ class external extends external_api {
     /**
      * Parameter description for delete_category().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function delete_category_parameters() {
@@ -662,6 +690,7 @@ class external extends external_api {
     /**
      * Deletes a data category.
      *
+     * @since Moodle 3.5
      * @param int $id The ID.
      * @return array
      * @throws invalid_persistent_exception
@@ -686,6 +715,7 @@ class external extends external_api {
     /**
      * Parameter description for delete_category().
      *
+     * @since Moodle 3.5
      * @return external_single_structure
      */
     public static function delete_category_returns() {
@@ -698,6 +728,7 @@ class external extends external_api {
     /**
      * Parameter description for set_contextlevel_form().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function set_contextlevel_form_parameters() {
@@ -709,6 +740,7 @@ class external extends external_api {
     /**
      * Creates a data category from form data.
      *
+     * @since Moodle 3.5
      * @param string $jsonformdata
      * @return array
      */
@@ -753,6 +785,7 @@ class external extends external_api {
     /**
      * Returns for set_contextlevel_form().
      *
+     * @since Moodle 3.5
      * @return external_single_structure
      */
     public static function set_contextlevel_form_returns() {
@@ -765,6 +798,7 @@ class external extends external_api {
     /**
      * Parameter description for set_context_form().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function set_context_form_parameters() {
@@ -776,6 +810,7 @@ class external extends external_api {
     /**
      * Creates a data category from form data.
      *
+     * @since Moodle 3.5
      * @param string $jsonformdata
      * @return array
      */
@@ -819,6 +854,7 @@ class external extends external_api {
     /**
      * Returns for set_context_form().
      *
+     * @since Moodle 3.5
      * @return external_single_structure
      */
     public static function set_context_form_returns() {
@@ -831,6 +867,7 @@ class external extends external_api {
     /**
      * Parameter description for tree_extra_branches().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function tree_extra_branches_parameters() {
@@ -843,6 +880,7 @@ class external extends external_api {
     /**
      * Returns tree extra branches.
      *
+     * @since Moodle 3.5
      * @param int $contextid
      * @param string $element
      * @return array
@@ -882,6 +920,7 @@ class external extends external_api {
     /**
      * Returns for tree_extra_branches().
      *
+     * @since Moodle 3.5
      * @return external_single_structure
      */
     public static function tree_extra_branches_returns() {
@@ -894,6 +933,7 @@ class external extends external_api {
     /**
      * Parameters for confirm_contexts_for_deletion().
      *
+     * @since Moodle 3.5
      * @return external_function_parameters
      */
     public static function confirm_contexts_for_deletion_parameters() {
@@ -908,6 +948,7 @@ class external extends external_api {
     /**
      * Confirm a given array of expired context record IDs
      *
+     * @since Moodle 3.5
      * @param int[] $ids Array of record IDs from the expired contexts table.
      * @return array
      * @throws coding_exception
@@ -988,6 +1029,7 @@ class external extends external_api {
     /**
      * Returns for confirm_contexts_for_deletion().
      *
+     * @since Moodle 3.5
      * @return external_single_structure
      */
     public static function confirm_contexts_for_deletion_returns() {
@@ -1000,6 +1042,7 @@ class external extends external_api {
     /**
      * Gets the structure of a tree node (link + child branches).
      *
+     * @since Moodle 3.5
      * @param bool $allowchildbranches
      * @return array
      */
diff --git a/admin/tool/dataprivacy/db/upgrade.php b/admin/tool/dataprivacy/db/upgrade.php
deleted file mode 100644
index c7788230cc0..00000000000
--- a/admin/tool/dataprivacy/db/upgrade.php
+++ /dev/null
@@ -1,44 +0,0 @@
-<?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/>.
-
-/**
- * tool_dataprivacy plugin upgrade code
- *
- * @package    tool_dataprivacy
- * @copyright  2018 David Monllao
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-defined('MOODLE_INTERNAL') || die();
-
-/**
- * Function to upgrade auth_cas.
- * @param int $oldversion the version we are upgrading from
- * @return bool result
- */
-function xmldb_tool_dataprivacy_upgrade($oldversion) {
-    global $CFG, $DB;
-
-    $dbman = $DB->get_manager();
-
-    if ($oldversion < 2018040500) {
-        // Nothing to do here. Moodle Plugins site's just complaining about missing upgrade.php.
-        // Savepoint reached.
-        upgrade_plugin_savepoint(true, 2018040500, 'tool', 'dataprivacy');
-    }
-
-    return true;
-}