Yoast\WP\SEO\Llms_Txt\Domain\Markdown\Items

Link{}Yoast 1.0└─ Item_Interface

Represents a link markdown item.

Хуков нет.

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

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

Методы

  1. public __construct( string $text, string $anchor, string $description = '' )
  2. public escape_markdown( Markdown_Escaper $markdown_escaper )
  3. public render()

Код Link{} Yoast 28.0

class Link implements Item_Interface {

	/**
	 * The description that is part of this link.
	 *
	 * @var string
	 */
	private $description;

	/**
	 * The link text.
	 *
	 * @var string
	 */
	private $text;

	/**
	 * The anchor text.
	 *
	 * @var string
	 */
	private $anchor;

	/**
	 * Class constructor.
	 *
	 * @param string $text        The link text.
	 * @param string $anchor      The anchor text.
	 * @param string $description The description.
	 */
	public function __construct( string $text, string $anchor, string $description = '' ) {
		$this->text        = $text;
		$this->anchor      = $anchor;
		$this->description = $description;
	}

	/**
	 * Renders the link item.
	 *
	 * @return string
	 */
	public function render(): string {
		$description = ( $this->description !== '' ) ? ": $this->description" : '';
		return "[$this->text]($this->anchor)$description";
	}

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