wordpress-seo / src / llms-txt / domain / file / llms-file-system-interface.php

llms-file-system-interface.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI trunk, at src/llms-txt/domain/file/llms-file-system-interface.php

41 lines 890 B

Raw Download Zip

1	<?php
2
3	// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong
4	namespace Yoast\WP\SEO\Llms_Txt\Domain\File;
5
6	/**
7	* Interface to describe handeling the llms.txt file.
8	*/
9	interface Llms_File_System_Interface {
10
11	/**
12	* Method to set the llms.txt file content.
13	*
14	* @param string $content The content for the file.
15	*
16	* @return bool True on success, false on failure.
17	*/
18	public function set_file_content( string $content ): bool;
19
20	/**
21	* Method to remove the llms.txt file from the file system.
22	*
23	* @return bool True on success, false on failure.
24	*/
25	public function remove_file(): bool;
26
27	/**
28	* Gets the contents of the current llms.txt file.
29	*
30	* @return string
31	*/
32	public function get_file_contents(): string;
33
34	/**
35	* Checks if the llms.txt file exists.
36	*
37	* @return bool Whether the llms.txt file exists.
38	*/
39	public function file_exists(): bool;
40	}
41