aboutsummaryrefslogtreecommitdiff
path: root/lib/plugins/core/RESTAPIPlugin.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/plugins/core/RESTAPIPlugin.php')
-rw-r--r--lib/plugins/core/RESTAPIPlugin.php26
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/plugins/core/RESTAPIPlugin.php b/lib/plugins/core/RESTAPIPlugin.php
new file mode 100644
index 0000000..f69344c
--- /dev/null
+++ b/lib/plugins/core/RESTAPIPlugin.php
@@ -0,0 +1,26 @@
+<?php
+/*
+ * REST-API Plugins add maps to the REST-API router.
+ *
+ * Copyright (c) 2014 - Marcus Lunzenauer <mlunzena@uos.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.
+ */
+
+/**
+ * @deprecated Since Stud.IP 5.0. Will be removed in Stud.IP 6.0.
+ */
+interface RESTAPIPlugin
+{
+ /**
+ * Returns one or more instances of RESTAPI\RouteMap to register
+ * to the Router.
+ *
+ * @return RouteMap|Array either a single instance of class
+ * RouteMap or an array of them
+ */
+ public function getRouteMaps();
+}