<?php
declare( strict_types = 1 );

namespace Cite\Parsoid;

use Cite\AnchorFormatter;

/**
 * Contains small pieces of additional knowledge that is specific to the Parsoid implementation and
 * doesn't belong to the generic {@link AnchorFormatter}.
 *
 * @license GPL-2.0-or-later
 */
class ParsoidAnchorFormatter {

	/**
	 * The clickable href="#…" link and id="…" target to jump from a footnote marker in the article
	 * down to the corresponding "note" item in the reference list.
	 */
	public static function getNoteIdentifier( RefGroupItem $ref ): string {
		return AnchorFormatter::getNoteIdentifier( $ref->name, $ref->globalId );
	}

	/**
	 * Identifier for the inner <span class="mw-reference-text"> node.
	 */
	public static function getNoteTextIdentifier( RefGroupItem $ref ): string {
		return AnchorFormatter::getNoteTextIdentifier( $ref->name, $ref->globalId );
	}

	/**
	 * The clickable href="#…" backlink and id="…" target to jump from the reference list back up to
	 * one of the possibly many footnote markers in the article.
	 */
	public static function getBacklinkIdentifier( RefGroupItem $ref, ?int $count = null ): string {
		return AnchorFormatter::getBacklinkIdentifier( $ref->name, $ref->globalId,
			$count ?? $ref->visibleNodes );
	}

}
