107 lines
2.9 KiB
PHP
107 lines
2.9 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
|
|
*/
|
|
|
|
namespace MediaWiki\Skin;
|
|
|
|
use MediaWiki\Output\OutputPage;
|
|
use MediaWiki\Parser\ParserOutputFlags;
|
|
|
|
/**
|
|
* @internal for use inside Skin and SkinTemplate classes only
|
|
* @unstable
|
|
*/
|
|
class SkinComponentTableOfContents implements SkinComponent {
|
|
/** @var OutputPage */
|
|
private $output;
|
|
|
|
/**
|
|
* @param OutputPage $output
|
|
*/
|
|
public function __construct( OutputPage $output ) {
|
|
$this->output = $output;
|
|
}
|
|
|
|
/**
|
|
* Nests child sections within their parent sections.
|
|
*
|
|
* @param array $sections
|
|
* @param int $toclevel
|
|
* @return array
|
|
*/
|
|
private function getSectionsDataInternal( array $sections, int $toclevel = 1 ): array {
|
|
$data = [];
|
|
foreach ( $sections as $i => $section ) {
|
|
// Child section belongs to a higher parent.
|
|
if ( $section->tocLevel < $toclevel ) {
|
|
return $data;
|
|
}
|
|
|
|
// Set all the parent sections at the current top level.
|
|
if ( $section->tocLevel === $toclevel ) {
|
|
$childSections = $this->getSectionsDataInternal(
|
|
array_slice( $sections, $i + 1 ),
|
|
$toclevel + 1
|
|
);
|
|
$data[] = $section->toLegacy() + [
|
|
'array-sections' => $childSections,
|
|
'is-top-level-section' => $toclevel === 1,
|
|
'is-parent-section' => $childSections !== []
|
|
];
|
|
}
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Get table of contents template data
|
|
*
|
|
* Enriches section data by nesting child elements within parent elements
|
|
* such that the table of contents can be rendered in Mustache.
|
|
*
|
|
* For an example of how to render the data, see TableOfContents.mustache in
|
|
* the Vector skin.
|
|
*
|
|
* @return array
|
|
*/
|
|
private function getTOCDataInternal(): array {
|
|
$tocData = $this->output->getTOCData();
|
|
// Return data only if TOC present T298796.
|
|
if ( $tocData === null ) {
|
|
return [];
|
|
}
|
|
// Respect __NOTOC__
|
|
if ( $this->output->getOutputFlag( ParserOutputFlags::NO_TOC ) ) {
|
|
return [];
|
|
}
|
|
|
|
$outputSections = $tocData->getSections();
|
|
|
|
return count( $outputSections ) > 0 ? [
|
|
'number-section-count' => count( $outputSections ),
|
|
'array-sections' => $this->getSectionsDataInternal( $outputSections, 1 ),
|
|
] : [];
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getTemplateData(): array {
|
|
return $this->getTOCDataInternal();
|
|
}
|
|
}
|