mirror of
https://github.com/moodle/moodle.git
synced 2025-07-25 16:21:47 +02:00
0e367a119c
This commit is part of work on Custom fields API, to minimize commit history in moodle core the work of a team of developers was split into several commits with different authors but the authorship of individual lines of code may be different from the commit author.
85 lines
3.3 KiB
PHP
85 lines
3.3 KiB
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/>.
|
|
|
|
/**
|
|
* Contains interface customfield_provider
|
|
*
|
|
* @package core_customfield
|
|
* @copyright 2018 Marina Glancy
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_customfield\privacy;
|
|
|
|
use core_customfield\data_controller;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Interface customfield_provider, all customfield plugins need to implement it
|
|
*
|
|
* @package core_customfield
|
|
* @copyright 2018 Marina Glancy
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
interface customfield_provider extends
|
|
\core_privacy\local\request\plugin\subplugin_provider,
|
|
|
|
// The customfield plugins do not need to do anything themselves for the shared_userlist.
|
|
// This is all handled by the component core_customfield.
|
|
\core_privacy\local\request\shared_userlist_provider
|
|
{
|
|
|
|
/**
|
|
* Preprocesses data object that is going to be exported
|
|
*
|
|
* Minimum implementation:
|
|
* writer::with_context($data->get_context())->export_data($subcontext, $exportdata);
|
|
*
|
|
* @param data_controller $data
|
|
* @param \stdClass $exportdata generated object to be exported
|
|
* @param array $subcontext subcontext to use when exporting
|
|
* @return mixed
|
|
*/
|
|
public static function export_customfield_data(data_controller $data, \stdClass $exportdata, array $subcontext);
|
|
|
|
/**
|
|
* Allows plugins to delete everything they store related to the data (usually files)
|
|
*
|
|
* If plugin does not store any related files or other information, implement as an empty function
|
|
*
|
|
* @param string $dataidstest select query for data id (note that it may also return data for other field types)
|
|
* @param array $params named parameters for the select query
|
|
* @param array $contextids list of affected data contexts
|
|
* @return mixed
|
|
*/
|
|
public static function before_delete_data(string $dataidstest, array $params, array $contextids);
|
|
|
|
/**
|
|
* Allows plugins to delete everything they store related to the field configuration (usually files)
|
|
*
|
|
* The implementation should not delete data or anything related to the data, since "before_delete_data" is
|
|
* invoked separately.
|
|
*
|
|
* If plugin does not store any related files or other information, implement as an empty function
|
|
*
|
|
* @param string $fieldidstest select query for field id (note that it may also return fields of other types)
|
|
* @param array $params named parameters for the select query
|
|
* @param int[] $contextids list of affected configuration contexts
|
|
*/
|
|
public static function before_delete_fields(string $fieldidstest, array $params, array $contextids);
|
|
}
|