aboutsummaryrefslogtreecommitdiff
path: root/lib/plugins/core/AdminCourseContents.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/plugins/core/AdminCourseContents.php')
-rw-r--r--lib/plugins/core/AdminCourseContents.php25
1 files changed, 25 insertions, 0 deletions
diff --git a/lib/plugins/core/AdminCourseContents.php b/lib/plugins/core/AdminCourseContents.php
new file mode 100644
index 0000000..0e07b58
--- /dev/null
+++ b/lib/plugins/core/AdminCourseContents.php
@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * Interface AdminCourseContents
+ * With this interface a plugin is able to add columns to the course-overview table for admins and roots.
+ */
+interface AdminCourseContents
+{
+ /**
+ * The available columns for the course-overview table for admins. Index is the identifier of the column
+ * for the method adminAreaGetCourseContent. The value is the display name of the column.
+ * @return array : an associative array like array('index' => _("Translated display name"))
+ */
+ public function adminAvailableContents();
+
+ /**
+ * Returns the value of the additional column for the course-overview table in the admin-area.
+ *
+ * @param Course $course : A Course-object of the given ... course
+ * @param string $index : the index that comes from adminAvailableContents to identify the column.
+ *
+ * @return Flexi\Template | String : Either one will do, but string is preferred, because it can exported as CSV-file more easily.
+ */
+ public function adminAreaGetCourseContent($course, $index);
+}