wordpress-seo / src / dashboard / infrastructure / tracking / setup-steps-tracking-repository-interface.php

setup-steps-tracking-repository-interface.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 28.2, at src/dashboard/infrastructure/tracking/setup-steps-tracking-repository-interface.php

32 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\Infrastructure\Tracking;
5
6	/**
7	* Interface for the Site Kit Usage Tracking Repository.
8	*
9	* @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded
10	*/
11	interface Setup_Steps_Tracking_Repository_Interface {
12
13	/**
14	* Sets an option inside the Site Kit usage options array..
15	*
16	* @param string $element_name The name of the array element to set.
17	* @param string $element_value The value of the array element to set.
18	*
19	* @return bool False when the update failed, true when the update succeeded.
20	*/
21	public function set_setup_steps_tracking_element( string $element_name, string $element_value ): bool;
22
23	/**
24	* Gets an option inside the Site Kit usage options array..
25	*
26	* @param string $element_name The name of the array element to get.
27	*
28	* @return string The value if present, empty string if not.
29	*/
30	public function get_setup_steps_tracking_element( string $element_name ): string;
31	}
32