introduce interface AdminCourseWidgetPlugin and adjust core admin courses to it, fixes #3084

Closes #3084

Merge request studip/studip!2071

1 files changed, 42 insertions, 0 deletions

diff --git a/lib/plugins/core/AdminCourseWidgetPlugin.class.php b/lib/plugins/core/AdminCourseWidgetPlugin.class.php
new file mode 100644
index 0000000..c554626
--- /dev/null
+++ b/lib/plugins/core/AdminCourseWidgetPlugin.class.php
@@ -0,0 +1,42 @@
+<?php
+/**
+ * This plugin interface is used to add functionality to the sidebar of the
+ * admin courses page.
+ *
+ * @see    AdminCourseOptionsWidget
+ * @author Jan-Hendrik Willms <tleilax+studip@gmail.com>
+ * @since Stud.IP 5.4
+ */
+interface AdminCourseWidgetPlugin
+{
+    /**
+     * Returns a list of widgets for the admin courses page.
+     *
+     * @return AdminCourseOptionsWidget[]
+     */
+    public function getWidgets(): iterable;
+
+    /**
+     * Return the filter values this widget provides. Return an associative
+     * array with filter names as indices and filter values as values.
+     *
+     * @return array
+     */
+    public function getFilters(): array;
+
+    /**
+     * Apply the set filters to the AdminCourseFilter query.
+     *
+     * @param AdminCourseFilter $filter
+     */
+    public function applyFilters(AdminCourseFilter $filter): void;
+
+
+    /**
+     * Set filters from the admin course page. You will be given an associative
+     * array according to getFilters().
+     *
+     * @param array $filters
+     */
+    public function setFilters(array $filters): void;
+}