119 lines
3.0 KiB
PHP
119 lines
3.0 KiB
PHP
<?php
|
|
/**
|
|
* 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.
|
|
*
|
|
* This program 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, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\Minerva;
|
|
|
|
use DomainException;
|
|
|
|
/**
|
|
* Model for a menu that can be presented in a skin.
|
|
*/
|
|
class MenuBuilder {
|
|
/**
|
|
* @var MenuEntry[]
|
|
*/
|
|
private $entries = [];
|
|
|
|
/**
|
|
* Get all entries represented as plain old PHP arrays.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getEntries() {
|
|
$entryPresenter = function ( MenuEntry $entry ) {
|
|
$result = [
|
|
'name' => $entry->getName(),
|
|
'components' => $entry->getComponents(),
|
|
];
|
|
|
|
if ( $entry->isJSOnly() ) {
|
|
$result['class'] = 'jsonly';
|
|
}
|
|
|
|
return $result;
|
|
};
|
|
|
|
return array_map( $entryPresenter, $this->entries );
|
|
}
|
|
|
|
/**
|
|
* Insert an entry into the menu.
|
|
*
|
|
* @param string $name A unique name identifying the menu entry
|
|
* @param bool $isJSOnly Whether the menu entry works without JS
|
|
* @throws DomainException When the entry already exists
|
|
* @return MenuEntry
|
|
*/
|
|
public function insert( $name, $isJSOnly = false ) {
|
|
if ( $this->search( $name ) !== -1 ) {
|
|
throw new DomainException( "The \"${name}\" entry already exists." );
|
|
}
|
|
|
|
$this->entries[] = $entry = new MenuEntry( $name, $isJSOnly );
|
|
|
|
return $entry;
|
|
}
|
|
|
|
/**
|
|
* Searches for a menu entry by name.
|
|
*
|
|
* @param string $name
|
|
* @return integer If the menu entry exists, then the 0-based index of the entry; otherwise, -1
|
|
*/
|
|
private function search( $name ) {
|
|
$count = count( $this->entries );
|
|
|
|
for ( $i = 0; $i < $count; ++$i ) {
|
|
if ( $this->entries[$i]->getName() === $name ) {
|
|
return $i;
|
|
}
|
|
}
|
|
|
|
return -1;
|
|
}
|
|
|
|
/**
|
|
* Insert an entry after an existing one.
|
|
*
|
|
* @param string $targetName The name of the existing entry to insert
|
|
* the new entry after
|
|
* @param string $name The name of the new entry
|
|
* @param bool $isJSOnly Whether the entry works without JS
|
|
* @throws DomainException When the existing entry doesn't exist
|
|
* @return MenuEntry
|
|
*/
|
|
public function insertAfter( $targetName, $name, $isJSOnly = false ) {
|
|
if ( $this->search( $name ) !== -1 ) {
|
|
throw new DomainException( "The \"${name}\" entry already exists." );
|
|
}
|
|
|
|
$index = $this->search( $targetName );
|
|
|
|
if ( $index === -1 ) {
|
|
throw new DomainException( "The \"{$targetName}\" entry doesn't exist." );
|
|
}
|
|
|
|
$entry = new MenuEntry( $name, $isJSOnly );
|
|
array_splice( $this->entries, $index + 1, 0, [ $entry ] );
|
|
|
|
return $entry;
|
|
}
|
|
}
|