mediawiki-skins-MinervaNeue/includes/menu/Group.php
Stephen Niedzielski 4c34cce9f3 Hygiene: move menu entries to subdirectory
The number of generic menu entry specific files is growing which is
cluttering the Menu/ directory. Move the entries to a new subfolder.

Bug: T214540
Change-Id: I807d6f6034ee1924e3a606f5e6782c3298896825
2019-07-05 21:32:44 +00:00

161 lines
4.2 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\Menu;
use DomainException;
use MediaWiki\Minerva\Menu\Entries\IMenuEntry;
use MediaWiki\Minerva\Menu\Entries\MenuEntry;
/**
* Model for a menu that can be presented in a skin.
*/
class Group {
/**
* @var IMenuEntry[]
*/
private $entries = [];
/**
* Return entries count
*
* @return bool
*/
public function hasEntries() {
return count( $this->entries ) > 0;
}
/**
* Get all entries represented as plain old PHP arrays.
*
* @return array
*/
public function getEntries() {
$entryPresenter = function ( IMenuEntry $entry ) {
$result = [
'name' => $entry->getName(),
'components' => $entry->getComponents(),
];
$classes = $entry->getCSSClasses();
if ( $classes ) {
$result[ 'class' ] = implode( ' ', $classes );
}
return $result;
};
return array_map( $entryPresenter, $this->entries );
}
/**
* Helper method to verify that the $name of entry is unique (do not exists
* in current Group )
* @param string $name
* @throws DomainException When the entry already exists
*/
private function throwIfNotUnique( $name ) {
try {
$this->search( $name );
} catch ( DomainException $exception ) {
return;
}
throw new DomainException( "The \"${name}\" entry already exists." );
}
/**
* Insert new menu entry
* @param IMenuEntry $entry
* @throws DomainException When the entry already exists
*/
public function insertEntry( IMenuEntry $entry ) {
$this->throwIfNotUnique( $entry->getName() );
$this->entries[] = $entry;
}
/**
* 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 ) {
$this->throwIfNotUnique( $name );
$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
* @throws DomainException
*/
private function search( $name ) {
$count = count( $this->entries );
for ( $i = 0; $i < $count; ++$i ) {
if ( $this->entries[$i]->getName() === $name ) {
return $i;
}
}
throw new DomainException( "The \"{$name}\" entry doesn't exist." );
}
/**
* 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 ) {
$this->throwIfNotUnique( $name );
$index = $this->search( $targetName );
$entry = new MenuEntry( $name, $isJSOnly );
array_splice( $this->entries, $index + 1, 0, [ $entry ] );
return $entry;
}
/**
* @param string $targetName
* @return IMenuEntry
* @throws DomainException
*/
public function getEntryByName( $targetName ): IMenuEntry {
$index = $this->search( $targetName );
return $this->entries[$index];
}
}
/**
* make sure BlueSpiceMultiUpload and GrowthExperiments use the new class
* @TODO remove after updating all extensions that still depend upon MenuBuilder
*/
class_alias( 'MediaWiki\Minerva\Menu\Group', 'MediaWiki\Minerva\MenuBuilder' );