Mark Nelson
93af6a610e
- Added new icon for the recycle bin.
- Fixed issue where the course expiry setting was being used to display
the expiry messages in the category bin.
- Fixed failing Behat tests.
- Tidied Behat tests.
- General tidy up.
- Deleted three Behat feature files.
- Deleted 'delete_confirmation.feature' as it's testing JS functionality
that was removed (see comment further down). The 'basic_functionality.feature'
now tests deleting an activity and a course.
- Deleted 'description.feature' and added the tested functionality to
'basic_functionality.feature'.
- Deleted 'logs_test.feature' and moved testing to PHPUnit tests.
- Added another scenario for restoring a course.
- Removed protected mod settings - it was discussed that this was not a necessary
feature. We should not be treating the recycle bin as a backup.
- Renamed events to conform to guidelines.
- Wrote new PHPUnit tests for events.
- Tidied up existing PHPUnit tests and extended them.
- Alphabetised lang file.
- Made changes to strings and string identifiers in the lang file and changed usages in code.
- Changed setting names to better identify their purpose.
- Renamed classes and file names so it's easier to identify their purpose.
- Renamed the 'deleted' column to 'timecreated' for consistency with other
Moodle tables, and to easily identify what the value represents.
- Changed the columns 'category' and 'course' to 'categoryid' and
'courseid' respectively.
- Changed the name of the table indexes for consistency with core.
- Removed module.js and any use of it and replaced with Moodle core libraries
for JS confirmation.
- Removed 'noevent' argument in delete_item().
- Removed unnecessary capabilities - we can use the same capabilties for both
recycle bins based on the context the capability was given.
- Removed '_' in the capability definitions to keep it consistent with core.
- Set page layout and headings for index.php - varies between the course and
category recycle bins.
- Deleted styles.css and centred columns using the flexible_table API.
- Fixed IDE and codechecker complaints.
- Made use of the files API, rather than writing directly to
"$CFG->dataroot . '/recyclebin'".
- Used make_temp_directory rather than expecting it to exist.
- Replaced debugging function calls with calls to the backup API to
display errors.
- Deleted the temporary backup file after a successful restore, or if it fails.
- If the restore fails for a course, delete the course we created.
- Removed unnecessary '\' characters when not in namespace.
- Used configduration class for expiry times in the settings.
- Cleanup course bin when a course is deleted.
- Cleanup a category bin when a category is deleted.
- Removed unnecessary throw tags.
- Changed default settings.
106 lines
2.6 KiB
PHP
106 lines
2.6 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/>.
|
|
|
|
/**
|
|
* The main interface for recycle bin methods.
|
|
*
|
|
* @package tool_recyclebin
|
|
* @copyright 2015 University of Kent
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace tool_recyclebin;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Represents a recyclebin.
|
|
*
|
|
* @package tool_recyclebin
|
|
* @copyright 2015 University of Kent
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
abstract class base_bin {
|
|
|
|
/**
|
|
* Is this recyclebin enabled?
|
|
*/
|
|
public static function is_enabled() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns an item from the recycle bin.
|
|
*
|
|
* @param int $itemid Item ID to retrieve.
|
|
*/
|
|
public abstract function get_item($itemid);
|
|
|
|
/**
|
|
* Returns a list of items in the recycle bin.
|
|
*/
|
|
public abstract function get_items();
|
|
|
|
/**
|
|
* Store an item in this recycle bin.
|
|
*
|
|
* @param \stdClass $item Item to store.
|
|
*/
|
|
public abstract function store_item($item);
|
|
|
|
/**
|
|
* Restore an item from the recycle bin.
|
|
*
|
|
* @param \stdClass $item The item database record
|
|
*/
|
|
public abstract function restore_item($item);
|
|
|
|
/**
|
|
* Delete an item from the recycle bin.
|
|
*
|
|
* @param \stdClass $item The item database record
|
|
*/
|
|
public abstract function delete_item($item);
|
|
|
|
/**
|
|
* Empty the recycle bin.
|
|
*/
|
|
public function delete_all_items() {
|
|
// Cleanup all items.
|
|
$items = $this->get_items();
|
|
foreach ($items as $item) {
|
|
if ($this->can_delete()) {
|
|
$this->delete_item($item);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Can we view items in this recycle bin?
|
|
*/
|
|
public abstract function can_view();
|
|
|
|
/**
|
|
* Can we restore items in this recycle bin?
|
|
*/
|
|
public abstract function can_restore();
|
|
|
|
/**
|
|
* Can we delete this?
|
|
*/
|
|
public abstract function can_delete();
|
|
}
|