DynamicPageList3/includes/lister/SubPageList.php

<?php

namespace DPL\Lister;

class SubPageList extends UnorderedList {
	/**
	 * Listing style for this class.
	 *
	 * @var int
	 */
	public $style = parent::LIST_UNORDERED;

	/**
	 * List(Section) Start
	 *
	 * @var string
	 */
	public $listStart = '<ul%s>';

	/**
	 * List(Section) End
	 *
	 * @var string
	 */
	public $listEnd = '</ul>';

	/**
	 * Item Start
	 *
	 * @var string
	 */
	public $itemStart = '<li%s>';

	/**
	 * Item End
	 *
	 * @var string
	 */
	public $itemEnd = '</li>';

	/**
	 * Format a list of articles into a singular list.
	 *
	 * @param array $articles
	 * @param int $start
	 * @param int $count
	 * @return string
	 */
	public function formatList( $articles, $start, $count ) {
		$filteredCount = 0;
		$items = [];

		for ( $i = $start; $i < $start + $count; $i++ ) {
			$article = $articles[$i];

			if ( empty( $article ) || empty( $article->mTitle ) ) {
				continue;
			}

			$pageText = null;
			if ( $this->includePageText ) {
				$pageText = $this->transcludePage( $article, $filteredCount );
			} else {
				$filteredCount++;
			}

			$this->rowCount = $filteredCount++;

			$parts = explode( '/', $article->mTitle );
			$item = $this->formatItem( $article, $pageText );
			$items = $this->nestItem( $parts, $items, $item );
		}

		return $this->getListStart() . $this->implodeItems( $items ) . $this->listEnd;
	}

	/**
	 * Nest items down to the proper level.
	 *
	 * @param array &$parts
	 * @param array $items
	 * @param string $item
	 * @return array
	 */
	private function nestItem( &$parts, $items, $item ) {
		$firstPart = reset( $parts );

		if ( count( $parts ) > 1 ) {
			array_shift( $parts );

			if ( !isset( $items[$firstPart] ) ) {
				$items[$firstPart] = [];
			}

			$items[$firstPart] = $this->nestItem( $parts, $items[$firstPart], $item );

			return $items;
		}

		$items[$firstPart][] = $item;

		return $items;
	}

	/**
	 * Join together items after being processed by formatItem().
	 *
	 * @param array $items
	 * @return string
	 */
	protected function implodeItems( $items ) {
		$list = '';

		foreach ( $items as $key => $item ) {
			if ( is_string( $item ) ) {
				$list .= $item;
				continue;
			}

			if ( is_array( $item ) ) {
				$list .= $this->getItemStart() . $key . $this->getListStart() . $this->implodeItems( $item ) . $this->listEnd . $this->getItemEnd();
			}
		}

		return $list;
	}
}