aboutsummaryrefslogtreecommitdiff
path: root/lib/modules/StudipModule.class.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/modules/StudipModule.class.php')
-rw-r--r--lib/modules/StudipModule.class.php72
1 files changed, 0 insertions, 72 deletions
diff --git a/lib/modules/StudipModule.class.php b/lib/modules/StudipModule.class.php
deleted file mode 100644
index 6cbcaf9..0000000
--- a/lib/modules/StudipModule.class.php
+++ /dev/null
@@ -1,72 +0,0 @@
-<?php
-/*
- * Copyright (c) 2012 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 StudipModule
-{
- /**
- * Return a navigation object representing this plugin in the
- * course overview table or return NULL if you want to display
- * no icon for this plugin (or course). The navigation object's
- * title will not be shown, only the image (and its associated
- * attributes like 'title') and the URL are actually used.
- *
- * By convention, new or changed plugin content is indicated
- * by a different icon and a corresponding tooltip.
- *
- * @param string $course_id course or institute range id
- * @param int $last_visit time of user's last visit
- * @param string $user_id the user to get the navigation for
- *
- * @return object navigation item to render or NULL
- */
- public function getIconNavigation($course_id, $last_visit, $user_id);
-
- /**
- * Return a navigation object representing this plugin in the
- * course overview table or return NULL if you want to display
- * no icon for this plugin (or course). The navigation object's
- * title will not be shown, only the image (and its associated
- * attributes like 'title') and the URL are actually used.
- *
- * By convention, new or changed plugin content is indicated
- * by a different icon and a corresponding tooltip.
- *
- * @param string $course_id course or institute range id
- *
- * @return array navigation item to render or NULL
- */
- public function getTabNavigation($course_id);
-
- /**
- * Provides metadata like a descriptional text for this module that
- * is shown on the course "+" page to inform users about what the
- * module acutally does. Additionally, a URL can be specified.
- *
- * @return array metadata containg description and/or url
- */
- public function getMetadata();
-
- /**
- * Return a template (an instance of the Flexi_Template class)
- * to be rendered on the course summary page. Return NULL to
- * render nothing for this plugin.
- *
- * 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
- * icon_url icon for this plugin (if any)
- * admin_url admin link for this plugin (if any)
- * admin_title title for admin link (default: Administration)
- *
- * @return object template object to render or NULL
- */
- public function getInfoTemplate($course_id);
-}