-
Notifications
You must be signed in to change notification settings - Fork 0
/
NavMenuInterface.php
63 lines (56 loc) · 1.23 KB
/
NavMenuInterface.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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?php
/**
* NavMenu Interface
*
* @author Whizark <devaloka@whizark.com>
* @see http://whizark.com
* @copyright Copyright (C) 2014 Whizark.
* @license MIT
*/
namespace Devaloka\Component\NavMenu;
/**
* Interface NavMenuInterface
*
* @package Devaloka\Component\NavMenu
*
* @codeCoverageIgnore
*/
interface NavMenuInterface
{
/**
* Gets the menu location identifier.
*
* @return string The location identifier.
*/
public function getLocation();
/**
* Gets the menu location descriptive text.
*
* @return string The location descriptive text.
*/
public function getDescription();
/**
* Renders the menu with the given options.
*
* @param mixed[] $options The options.
*
* @return string The rendered HTML.
*/
public function render(array $options = []);
/**
* Displays the menu with the given options.
*
* @param mixed[] $options The options.
*/
public function display(array $options = []);
/**
* Registers the menu.
*/
public function register();
/**
* Unregisters the menu.
*
* @throws \RuntimeException If the menu cannot be unregistered.
*/
public function unregister();
}