aboutsummaryrefslogtreecommitdiff
path: root/lib/plugins/core/DetailspagePlugin.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/plugins/core/DetailspagePlugin.php')
-rw-r--r--lib/plugins/core/DetailspagePlugin.php27
1 files changed, 27 insertions, 0 deletions
diff --git a/lib/plugins/core/DetailspagePlugin.php b/lib/plugins/core/DetailspagePlugin.php
new file mode 100644
index 0000000..3cc3b57
--- /dev/null
+++ b/lib/plugins/core/DetailspagePlugin.php
@@ -0,0 +1,27 @@
+<?php
+/*
+ * DetailspagePlugin.php
+ *
+ * Copyright (c) 2019 - Rasmus Fuhse <fuhse@data-quest.de>
+ *
+ * This program 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 2 of
+ * the License, or (at your option) any later version.
+ */
+interface DetailspagePlugin
+{
+ /**
+ * Return a template (an instance of the Flexi\Template class)
+ * to be rendered on the details page. Return NULL to
+ * render nothing for this plugin or this course.
+ *
+ * The template will automatically get a standard layout, which
+ * can be configured via attributes set on the template:
+ *
+ * title title to display, defaults to plugin name
+ *
+ * @return Flexi\Template|null template object to render or NULL
+ */
+ public function getDetailspageTemplate($course);
+}