wordpress-seo / src / dashboard / user-interface / time-based-seo-metrics / time-based-seo-metrics-route.php

time-based-seo-metrics-route.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 28.6, at src/dashboard/user-interface/time-based-seo-metrics/time-based-seo-metrics-route.php

310 lines 10.2 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\User_Interface\Time_Based_SEO_Metrics;
5
6	use DateTime;
7	use DateTimeZone;
8	use Exception;
9	use WP_REST_Request;
10	use WP_REST_Response;
11	use Yoast\WP\SEO\Conditionals\Third_Party\Site_Kit_Conditional;
12	use Yoast\WP\SEO\Dashboard\Application\Search_Rankings\Search_Ranking_Compare_Repository;
13	use Yoast\WP\SEO\Dashboard\Application\Search_Rankings\Top_Page_Repository;
14	use Yoast\WP\SEO\Dashboard\Application\Search_Rankings\Top_Query_Repository;
15	use Yoast\WP\SEO\Dashboard\Application\Traffic\Organic_Sessions_Compare_Repository;
16	use Yoast\WP\SEO\Dashboard\Application\Traffic\Organic_Sessions_Daily_Repository;
17	use Yoast\WP\SEO\Dashboard\Domain\Data_Provider\Parameters;
18	use Yoast\WP\SEO\Dashboard\Domain\Time_Based_SEO_Metrics\Repository_Not_Found_Exception;
19	use Yoast\WP\SEO\Dashboard\Infrastructure\Analytics_4\Analytics_4_Parameters;
20	use Yoast\WP\SEO\Dashboard\Infrastructure\Search_Console\Search_Console_Parameters;
21	use Yoast\WP\SEO\Helpers\Capability_Helper;
22	use Yoast\WP\SEO\Main;
23	use Yoast\WP\SEO\Routes\Route_Interface;
24
25	/**
26	* Abstract scores route.
27	*/
28	final class Time_Based_SEO_Metrics_Route implements Route_Interface {
29
30	/**
31	* The namespace of the route.
32	*
33	* @var string
34	*/
35	public const ROUTE_NAMESPACE = Main::API_V1_NAMESPACE;
36
37	/**
38	* The prefix of the route.
39	*
40	* @var string
41	*/
42	public const ROUTE_NAME = '/time_based_seo_metrics';
43
44	/**
45	* The data provider for page based search rankings.
46	*
47	* @var Top_Page_Repository
48	*/
49	private $top_page_repository;
50
51	/**
52	* The data provider for query based search rankings.
53	*
54	* @var Top_Query_Repository
55	*/
56	private $top_query_repository;
57
58	/**
59	* The data provider for comparison organic session traffic.
60	*
61	* @var Organic_Sessions_Compare_Repository
62	*/
63	private $organic_sessions_compare_repository;
64
65	/**
66	* The data provider for daily organic session traffic.
67	*
68	* @var Organic_Sessions_Daily_Repository
69	*/
70	private $organic_sessions_daily_repository;
71
72	/**
73	* The data provider for searching ranking comparison.
74	*
75	* @var Search_Ranking_Compare_Repository
76	*/
77	private $search_ranking_compare_repository;
78
79	/**
80	* Holds the capability helper instance.
81	*
82	* @var Capability_Helper
83	*/
84	private $capability_helper;
85
86	/**
87	* Returns the needed conditionals.
88	*
89	* @return array<string> The conditionals that must be met to load this.
90	*/
91	public static function get_conditionals(): array {
92	return [ Site_Kit_Conditional::class ];
93	}
94
95	/**
96	* The constructor.
97	*
98	* @param Top_Page_Repository $top_page_repository The data provider for page based search rankings.
99	* @param Top_Query_Repository $top_query_repository The data provider for query based search rankings.
100	* @param Organic_Sessions_Compare_Repository $organic_sessions_compare_repository The data provider for comparison organic session traffic.
101	* @param Organic_Sessions_Daily_Repository $organic_sessions_daily_repository The data provider for daily organic session traffic.
102	* @param Search_Ranking_Compare_Repository $search_ranking_compare_repository The data provider for searching ranking comparison.
103	* @param Capability_Helper $capability_helper The capability helper.
104	*/
105	public function __construct(
106	Top_Page_Repository $top_page_repository,
107	Top_Query_Repository $top_query_repository,
108	Organic_Sessions_Compare_Repository $organic_sessions_compare_repository,
109	Organic_Sessions_Daily_Repository $organic_sessions_daily_repository,
110	Search_Ranking_Compare_Repository $search_ranking_compare_repository,
111	Capability_Helper $capability_helper
112	) {
113	$this->top_page_repository = $top_page_repository;
114	$this->top_query_repository = $top_query_repository;
115	$this->organic_sessions_compare_repository = $organic_sessions_compare_repository;
116	$this->organic_sessions_daily_repository = $organic_sessions_daily_repository;
117	$this->search_ranking_compare_repository = $search_ranking_compare_repository;
118	$this->capability_helper = $capability_helper;
119	}
120
121	/**
122	* Registers routes for scores.
123	*
124	* @return void
125	*/
126	public function register_routes() {
127	\register_rest_route(
128	self::ROUTE_NAMESPACE,
129	self::ROUTE_NAME,
130	[
131	[
132	'methods' => 'GET',
133	'callback' => [ $this, 'get_time_based_seo_metrics' ],
134	'permission_callback' => [ $this, 'permission_manage_options' ],
135	'args' => [
136	'limit' => [
137	'type' => 'int',
138	'sanitize_callback' => 'absint',
139	'default' => 5,
140	],
141	'options' => [
142	'type' => 'object',
143	'required' => true,
144	'properties' => [
145	'widget' => [
146	'type' => 'string',
147	'required' => true,
148	'sanitize_callback' => 'sanitize_text_field',
149	],
150	],
151	],
152	],
153	],
154	],
155	);
156	}
157
158	/**
159	* Gets the time based SEO metrics.
160	*
161	* @param WP_REST_Request $request The request object.
162	*
163	* @return WP_REST_Response The success or failure response.
164	*
165	* @throws Repository_Not_Found_Exception When the given widget name is not implemented yet.
166	*/
167	public function get_time_based_seo_metrics( WP_REST_Request $request ): WP_REST_Response {
168	try {
169	$widget_name = $request->get_param( 'options' )['widget'];
170
171	switch ( $widget_name ) {
172	case 'query':
173	$request_parameters = new Search_Console_Parameters();
174
175	$request_parameters = $this->set_date_range_parameters( $request_parameters );
176	$request_parameters->set_limit( $request->get_param( 'limit' ) );
177	$request_parameters->set_dimensions( [ 'query' ] );
178
179	$time_based_seo_metrics_container = $this->top_query_repository->get_data( $request_parameters );
180	break;
181	case 'page':
182	$request_parameters = new Search_Console_Parameters();
183
184	$request_parameters = $this->set_date_range_parameters( $request_parameters );
185	$request_parameters->set_limit( $request->get_param( 'limit' ) );
186	$request_parameters->set_dimensions( [ 'page' ] );
187
188	$time_based_seo_metrics_container = $this->top_page_repository->get_data( $request_parameters );
189	break;
190	case 'organicSessionsDaily':
191	$request_parameters = new Analytics_4_Parameters();
192
193	$request_parameters = $this->set_date_range_parameters( $request_parameters );
194	$request_parameters->set_dimensions( [ 'date' ] );
195	$request_parameters->set_metrics( [ 'sessions' ] );
196	$request_parameters->set_dimension_filters( [ 'sessionDefaultChannelGrouping' => [ 'Organic Search' ] ] );
197	$request_parameters->set_order_by( 'dimension', 'date' );
198
199	$time_based_seo_metrics_container = $this->organic_sessions_daily_repository->get_data( $request_parameters );
200	break;
201	case 'organicSessionsCompare':
202	$request_parameters = new Analytics_4_Parameters();
203
204	$request_parameters = $this->set_date_range_parameters( $request_parameters );
205	$request_parameters = $this->set_comparison_date_range_parameters( $request_parameters );
206	$request_parameters->set_metrics( [ 'sessions' ] );
207	$request_parameters->set_dimension_filters( [ 'sessionDefaultChannelGrouping' => [ 'Organic Search' ] ] );
208
209	$time_based_seo_metrics_container = $this->organic_sessions_compare_repository->get_data( $request_parameters );
210	break;
211	case 'searchRankingCompare':
212	$request_parameters = new Search_Console_Parameters();
213
214	$request_parameters = $this->set_date_range_parameters( $request_parameters );
215	$request_parameters = $this->set_comparison_date_range_parameters( $request_parameters );
216	$request_parameters->set_dimensions( [ 'date' ] );
217
218	$time_based_seo_metrics_container = $this->search_ranking_compare_repository->get_data( $request_parameters );
219	break;
220	default:
221	throw new Repository_Not_Found_Exception();
222	}
223	} catch ( Exception $exception ) {
224	return new WP_REST_Response(
225	[
226	'error' => $exception->getMessage(),
227	],
228	$exception->getCode(),
229	);
230	}
231
232	return new WP_REST_Response(
233	$time_based_seo_metrics_container->to_array(),
234	200,
235	);
236	}
237
238	/**
239	* Sets date range parameters.
240	*
241	* @param Parameters $request_parameters The request parameters.
242	*
243	* @return Parameters The request parameters with configured date range.
244	*/
245	public function set_date_range_parameters( Parameters $request_parameters ): Parameters {
246	$date = $this->get_base_date();
247	$date->modify( '-28 days' );
248	$start_date = $date->format( 'Y-m-d' );
249
250	$date = $this->get_base_date();
251	$date->modify( '-1 days' );
252	$end_date = $date->format( 'Y-m-d' );
253
254	$request_parameters->set_start_date( $start_date );
255	$request_parameters->set_end_date( $end_date );
256
257	return $request_parameters;
258	}
259
260	/**
261	* Sets comparison date range parameters.
262	*
263	* @param Parameters $request_parameters The request parameters.
264	*
265	* @return Parameters The request parameters with configured comparison date range.
266	*/
267	public function set_comparison_date_range_parameters( Parameters $request_parameters ): Parameters {
268	$date = $this->get_base_date();
269	$date->modify( '-29 days' );
270	$compare_end_date = $date->format( 'Y-m-d' );
271
272	$date->modify( '-27 days' );
273	$compare_start_date = $date->format( 'Y-m-d' );
274
275	$request_parameters->set_compare_start_date( $compare_start_date );
276	$request_parameters->set_compare_end_date( $compare_end_date );
277
278	return $request_parameters;
279	}
280
281	/**
282	* Gets the base date.
283	*
284	* @return DateTime The base date.
285	*/
286	private function get_base_date() {
287	/**
288	* Filter: 'wpseo_custom_site_kit_base_date' - Allow the base date for Site Kit requests to be dynamically set.
289	*
290	* @param string $base_date The custom base date for Site Kit requests, defaults to 'now'.
291	*/
292	$base_date = \apply_filters( 'wpseo_custom_site_kit_base_date', 'now' );
293
294	try {
295	return new DateTime( $base_date, new DateTimeZone( 'UTC' ) );
296	} catch ( Exception $e ) {
297	return new DateTime( 'now', new DateTimeZone( 'UTC' ) );
298	}
299	}
300
301	/**
302	* Permission callback.
303	*
304	* @return bool True when user has the 'wpseo_manage_options' capability.
305	*/
306	public function permission_manage_options() {
307	return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
308	}
309	}
310