SubPageList\Lister\UI\WikitextSubPageListRenderer

Complexity

Total Complexity

11

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	render()	0	10	1
A	addPageHierarchy()	0	3	1
A	addHeader()	0	5	2
A	addFooter()	0	5	2
A	wrapInElement()	0	16	2
A	assertElementIsAllowed()	0	13	2

<?php

namespace SubPageList\Lister\UI;

use Html;
use RuntimeException;
use SubPageList\Lister\Page;

/**
 * @since 1.2
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class WikitextSubPageListRenderer implements SubPageListRenderer {

	private $options;
	private $text;

	/**
	 * @var HierarchyRendererFactory
	 */
	private $hierarchyRendererFactory;

	public function __construct() {
		$this->hierarchyRendererFactory = new HierarchyRendererFactory();
	}

	/**
	 * @see SubPageListRenderer::render
	 *
	 * @param Page $page
	 * @param array $options
	 *
	 * @return string
	 */
	public function render( Page $page, array $options ) {
		$this->options = $options;
		$this->text = '';

		$this->addHeader();
		$this->addPageHierarchy( $page );
		$this->addFooter();

		return $this->wrapInElement( $this->text );
	}

	private function addHeader() {
		if ( $this->options['intro'] !== '' ) {
			$this->text .= $this->options['intro'] . "\n";
		}
	}

	private function addFooter() {
		if ( $this->options['outro'] !== '' ) {
			$this->text .= "\n". $this->options['outro'];
		}
	}

	private function addPageHierarchy( Page $page ) {
		$this->text .= $this->hierarchyRendererFactory->newTreeListRenderer( $this->options )->renderHierarchy( $page );
	}

	private function wrapInElement( $text ) {
		if ( $this->options['element'] === 'none' ) {
			return $text;
		}

		// This whitelist checking is done because the first parameter of Html::element is not escaped.
		$this->assertElementIsAllowed();

		return Html::element(
			$this->options['element'],
			[
				'class' => $this->options['class']
			],
			"\n" . $text . "\n"
		);
	}

	private function assertElementIsAllowed() {
		$allowedElements = [
			'p',
			'div',
			'span'
		];

		if ( !in_array( $this->options['element'], $allowedElements ) ) {
			throw new RuntimeException(
				'Got an unsupported value for the element option: ' . $this->options['element']
			);
		}
	}

}