wordpress-seo / src / dashboard / domain / score-groups / score-groups-interface.php

score-groups-interface.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 27.8, at src/dashboard/domain/score-groups/score-groups-interface.php

53 lines 1.0 KB

Raw Download Zip

1	<?php
2
3	// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure.
4	namespace Yoast\WP\SEO\Dashboard\Domain\Score_Groups;
5
6	/**
7	* This interface describes a score group implementation.
8	*/
9	interface Score_Groups_Interface {
10
11	/**
12	* Gets the name of the score group.
13	*
14	* @return string
15	*/
16	public function get_name(): string;
17
18	/**
19	* Gets the key of the score group that is used when filtering on the posts page.
20	*
21	* @return string
22	*/
23	public function get_filter_key(): string;
24
25	/**
26	* Gets the value of the score group that is used when filtering on the posts page.
27	*
28	* @return string
29	*/
30	public function get_filter_value(): string;
31
32	/**
33	* Gets the minimum score of the score group.
34	*
35	* @return int\|null
36	*/
37	public function get_min_score(): ?int;
38
39	/**
40	* Gets the maximum score of the score group.
41	*
42	* @return int\|null
43	*/
44	public function get_max_score(): ?int;
45
46	/**
47	* Gets the position of the score group.
48	*
49	* @return int
50	*/
51	public function get_position(): int;
52	}
53