wordpress-seo / src / llms-txt / domain / markdown / sections / description.php

description.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 28.4, at src/llms-txt/domain/markdown/sections/description.php

58 lines 1.1 KB

Raw Download Zip

1	<?php
2
3	// phpcs:disable Yoast.NamingConventions.NamespaceName.MaxExceeded
4	namespace Yoast\WP\SEO\Llms_Txt\Domain\Markdown\Sections;
5
6	use Yoast\WP\SEO\Llms_Txt\Application\Markdown_Escaper;
7
8	/**
9	* Represents the description section.
10	*/
11	class Description implements Section_Interface {
12
13	/**
14	* The description.
15	*
16	* @var string
17	*/
18	private $description;
19
20	/**
21	* Class constructor.
22	*
23	* @param string $description The description.
24	*/
25	public function __construct( string $description ) {
26	$this->description = $description;
27	}
28
29	/**
30	* Returns the prefix of the description section.
31	*
32	* @return string
33	*/
34	public function get_prefix(): string {
35	return '> ';
36	}
37
38	/**
39	* Renders the description section.
40	*
41	* @return string
42	*/
43	public function render(): string {
44	return $this->description;
45	}
46
47	/**
48	* Escapes the markdown content.
49	*
50	* @param Markdown_Escaper $markdown_escaper The markdown escaper.
51	*
52	* @return void
53	*/
54	public function escape_markdown( Markdown_Escaper $markdown_escaper ): void {
55	$this->description = $markdown_escaper->escape_markdown_content( $this->description );
56	}
57	}
58