Yoast\WP\SEO\Llms_Txt\Domain\Markdown\Sections

Link_List{} │ Yoast 1.0└─ Section_Interface

Represents a link list markdown section.

Хуков нет.

Использование

$Link_List = new Link_List();
// use class methods

Методы

1. public __construct( string $type, array $links )
2. public add_link( Link $link )
3. public escape_markdown( Markdown_Escaper $markdown_escaper )
4. public get_prefix()
5. public render()

Код Link_List{} Link List{} ^{Yoast 27.7}

class Link_List implements Section_Interface {

	/**
	 * The type of the links.
	 *
	 * @var string
	 */
	private $type;

	/**
	 * The links.
	 *
	 * @var Link[]
	 */
	private $links = [];

	/**
	 * Class constructor.
	 *
	 * @param string $type  The type of the links.
	 * @param Link[] $links The links.
	 */
	public function __construct( string $type, array $links ) {
		$this->type = $type;

		foreach ( $links as $link ) {
			$this->add_link( $link );
		}
	}

	/**
	 * Adds a link to the list.
	 *
	 * @param Link $link The link to add.
	 *
	 * @return void
	 */
	public function add_link( Link $link ): void {
		$this->links[] = $link;
	}

	/**
	 * Returns the prefix of the link list section.
	 *
	 * @return string
	 */
	public function get_prefix(): string {
		return '## ';
	}

	/**
	 * Renders the link item.
	 *
	 * @return string
	 */
	public function render(): string {
		if ( empty( $this->links ) ) {
			return '';
		}

		$rendered_links = [];
		foreach ( $this->links as $link ) {
			$rendered_links[] = '- ' . $link->render();
		}

		return $this->type . \PHP_EOL . \implode( \PHP_EOL, $rendered_links );
	}

	/**
	 * Escapes the markdown content.
	 *
	 * @param Markdown_Escaper $markdown_escaper The markdown escaper.
	 *
	 * @return void
	 */
	public function escape_markdown( Markdown_Escaper $markdown_escaper ): void {
		$this->type = $markdown_escaper->escape_markdown_content( $this->type );

		foreach ( $this->links as $link ) {
			$link->escape_markdown( $markdown_escaper );
		}
	}
}