summaryrefslogtreecommitdiff
path: root/www/wiki/skins/chameleon/src/Menu/Menu.php
blob: 78ae3f768086133df6f5c0eeab30279c136b156d (plain)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<?php
/**
 * File holding the abstract Menu class
 *
 * This file is part of the MediaWiki skin Chameleon.
 *
 * @copyright 2013 - 2014, Stephan Gambke
 * @license   GNU General Public License, version 3 (or any later version)
 *
 * The Chameleon skin 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 3 of the License, or (at your option) any
 * later version.
 *
 * The Chameleon skin is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * @file
 * @ingroup   Skins
 */

namespace Skins\Chameleon\Menu;

/**
 * Class Menu
 *
 * @author  Stephan Gambke
 * @since   1.0
 * @ingroup Skins
 */
abstract class Menu {

	private $menuItemFormatter = null;
	private $itemListFormatter = null;

	abstract public function getHtml();

	/**
	 * @param string $href
	 * @param string $text
	 * @param int    $depth
	 * @param string $subitems
	 *
	 * @return string
	 */
	protected function getHtmlForMenuItem( $href, $text, $depth, $subitems ) {
		return call_user_func( $this->getMenuItemFormatter(), $href, $text, $depth, $subitems );
	}

	/**
	 * @return callable
	 */
	public function getMenuItemFormatter() {

		if ( $this->menuItemFormatter === null ) {

			$this->setMenuItemFormatter( function ( $href, $text, $depth, $subitems ) {
				$href = \Sanitizer::cleanUrl( $href );
				$text = htmlspecialchars( $text );
				$indent = str_repeat( "\t", 2 * $depth );

				if ( $subitems !== '' ) {
					return "$indent<li>\n$indent\t<a href=\"$href\">$text</a>\n$subitems$indent</li>\n";
				} else {
					return "$indent<li><a href=\"$href\">$text</a></li>\n";
				}
			} );

		}

		return $this->menuItemFormatter;
	}

	/**
	 * @param callable $menuItemFormatter
	 */
	public function setMenuItemFormatter( $menuItemFormatter ) {
		$this->menuItemFormatter = $menuItemFormatter;
	}

	/**
	 * @param string $rawItemsHtml
	 * @param int    $depth
	 *
	 * @return string
	 */
	protected function getHtmlForMenuItemList( $rawItemsHtml, $depth ) {
		return call_user_func( $this->getItemListFormatter(), $rawItemsHtml, $depth );
	}

	/**
	 * @return callable
	 */
	public function getItemListFormatter() {

		if ( $this->itemListFormatter === null ) {
			$this->setItemListFormatter( function ( $rawItemsHtml, $depth ) {
				$indent = str_repeat( "\t", 2 * $depth + 1 );
				return "$indent<ul>\n$rawItemsHtml$indent</ul>\n";
			} );
		}

		return $this->itemListFormatter;
	}

	/**
	 * @param callable $itemListFormatter
	 */
	public function setItemListFormatter( $itemListFormatter ) {
		$this->itemListFormatter = $itemListFormatter;
	}

}