1	<?php
2
3	/*
4	* This program is free software; you can redistribute it and/or
5	* modify it under the terms of the GNU General Public License
6	* as published by the Free Software Foundation; under version 2
7	* of the License (non-upgradable).
8	*
9	* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12	* GNU General Public License for more details.
13	*
14	* You should have received a copy of the GNU General Public License
15	* along with this program; if not, write to the Free Software
16	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17	*
18	* Copyright (c) 2017 (original work) Open Assessment Technologies SA ;
19	*
20	*/
21
22	namespace oat\tao\model\mvc;
23
24	/**
25	* Defines API that produce breadcrumbs.
26	*
27	* @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
28	* @package oat\tao\mvc
29	*/
30	interface Breadcrumbs
31	{
32	/**
33	* Builds breadcrumbs for a particular route.
34	* @param string $route - The route URL
35	* @param array $parsedRoute - The parsed URL (@see parse_url), augmented with extension, controller and action
36	* @return array|null - The breadcrumb related to the route, or `null` if none. Must contains:
37	* - id: the route id
38	* - url: the route url
39	* - label: the label displayed for the breadcrumb
40	* - entries: a list of related links, using the same format as above
41	*/
42	public function breadcrumbs($route, $parsedRoute);
43	}