lib/plugins/core/RESTAPIPlugin.class.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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();
}