wordpress-seo / src / builders / indexable-builder.php

indexable-builder.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 18.5.1, at src/builders/indexable-builder.php

400 lines 12.1 KB

Raw Download Zip

1	<?php
2
3	namespace Yoast\WP\SEO\Builders;
4
5	use Yoast\WP\SEO\Exceptions\Indexable\Source_Exception;
6	use Yoast\WP\SEO\Helpers\Indexable_Helper;
7	use Yoast\WP\SEO\Models\Indexable;
8	use Yoast\WP\SEO\Repositories\Indexable_Repository;
9	use Yoast\WP\SEO\Services\Indexables\Indexable_Version_Manager;
10
11	/**
12	* Builder for the indexables.
13	*
14	* Creates all the indexables.
15	*/
16	class Indexable_Builder {
17
18	/**
19	* The author builder.
20	*
21	* @var Indexable_Author_Builder
22	*/
23	private $author_builder;
24
25	/**
26	* The post builder.
27	*
28	* @var Indexable_Post_Builder
29	*/
30	private $post_builder;
31
32	/**
33	* The term builder.
34	*
35	* @var Indexable_Term_Builder
36	*/
37	private $term_builder;
38
39	/**
40	* The home page builder.
41	*
42	* @var Indexable_Home_Page_Builder
43	*/
44	private $home_page_builder;
45
46	/**
47	* The post type archive builder.
48	*
49	* @var Indexable_Post_Type_Archive_Builder
50	*/
51	private $post_type_archive_builder;
52
53	/**
54	* The data archive builder.
55	*
56	* @var Indexable_Date_Archive_Builder
57	*/
58	private $date_archive_builder;
59
60	/**
61	* The system page builder.
62	*
63	* @var Indexable_System_Page_Builder
64	*/
65	private $system_page_builder;
66
67	/**
68	* The indexable hierarchy builder.
69	*
70	* @var Indexable_Hierarchy_Builder
71	*/
72	private $hierarchy_builder;
73
74	/**
75	* The primary term builder
76	*
77	* @var Primary_Term_Builder
78	*/
79	private $primary_term_builder;
80
81	/**
82	* The indexable repository.
83	*
84	* @var Indexable_Repository
85	*/
86	private $indexable_repository;
87
88	/**
89	* The indexable helper.
90	*
91	* @var Indexable_Helper
92	*/
93	protected $indexable_helper;
94
95	/**
96	* The Indexable Version Manager.
97	*
98	* @var Indexable_Version_Manager
99	*/
100	protected $version_manager;
101
102	/**
103	* Returns the instance of this class constructed through the ORM Wrapper.
104	*
105	* @param Indexable_Author_Builder $author_builder The author builder for creating missing indexables.
106	* @param Indexable_Post_Builder $post_builder The post builder for creating missing indexables.
107	* @param Indexable_Term_Builder $term_builder The term builder for creating missing indexables.
108	* @param Indexable_Home_Page_Builder $home_page_builder The front page builder for creating missing indexables.
109	* @param Indexable_Post_Type_Archive_Builder $post_type_archive_builder The post type archive builder for creating missing indexables.
110	* @param Indexable_Date_Archive_Builder $date_archive_builder The date archive builder for creating missing indexables.
111	* @param Indexable_System_Page_Builder $system_page_builder The search result builder for creating missing indexables.
112	* @param Indexable_Hierarchy_Builder $hierarchy_builder The hierarchy builder for creating the indexable hierarchy.
113	* @param Primary_Term_Builder $primary_term_builder The primary term builder for creating primary terms for posts.
114	* @param Indexable_Helper $indexable_helper The indexable helper.
115	* @param Indexable_Version_Manager $version_manager The indexable version manager.
116	*/
117	public function __construct(
118	Indexable_Author_Builder $author_builder,
119	Indexable_Post_Builder $post_builder,
120	Indexable_Term_Builder $term_builder,
121	Indexable_Home_Page_Builder $home_page_builder,
122	Indexable_Post_Type_Archive_Builder $post_type_archive_builder,
123	Indexable_Date_Archive_Builder $date_archive_builder,
124	Indexable_System_Page_Builder $system_page_builder,
125	Indexable_Hierarchy_Builder $hierarchy_builder,
126	Primary_Term_Builder $primary_term_builder,
127	Indexable_Helper $indexable_helper,
128	Indexable_Version_Manager $version_manager
129	) {
130	$this->author_builder = $author_builder;
131	$this->post_builder = $post_builder;
132	$this->term_builder = $term_builder;
133	$this->home_page_builder = $home_page_builder;
134	$this->post_type_archive_builder = $post_type_archive_builder;
135	$this->date_archive_builder = $date_archive_builder;
136	$this->system_page_builder = $system_page_builder;
137	$this->hierarchy_builder = $hierarchy_builder;
138	$this->primary_term_builder = $primary_term_builder;
139	$this->indexable_helper = $indexable_helper;
140	$this->version_manager = $version_manager;
141	}
142
143	/**
144	* Sets the indexable repository. Done to avoid circular dependencies.
145	*
146	* @required
147	*
148	* @param Indexable_Repository $indexable_repository The indexable repository.
149	*/
150	public function set_indexable_repository( Indexable_Repository $indexable_repository ) {
151	$this->indexable_repository = $indexable_repository;
152	}
153
154	/**
155	* Creates a clean copy of an Indexable to allow for later database operations.
156	*
157	* @param Indexable $indexable The Indexable to copy.
158	*
159	* @return bool\|Indexable
160	*/
161	protected function deep_copy_indexable( $indexable ) {
162	return $this->indexable_repository
163	->query()
164	->create( $indexable->as_array() );
165	}
166
167	/**
168	* Creates an indexable by its ID and type.
169	*
170	* @param int $object_id The indexable object ID.
171	* @param string $object_type The indexable object type.
172	* @param Indexable\|bool $indexable Optional. An existing indexable to overwrite.
173	*
174	* @return bool\|Indexable Instance of indexable. False when unable to build.
175	*/
176	public function build_for_id_and_type( $object_id, $object_type, $indexable = false ) {
177	$defaults = [
178	'object_type' => $object_type,
179	'object_id' => $object_id,
180	];
181
182	$indexable = $this->build( $indexable, $defaults );
183
184	return $indexable;
185	}
186
187	/**
188	* Creates an indexable for the homepage.
189	*
190	* @param Indexable\|bool $indexable Optional. An existing indexable to overwrite.
191	*
192	* @return Indexable The home page indexable.
193	*/
194	public function build_for_home_page( $indexable = false ) {
195	return $this->build( $indexable, [ 'object_type' => 'home-page' ] );
196	}
197
198	/**
199	* Creates an indexable for the date archive.
200	*
201	* @param Indexable\|bool $indexable Optional. An existing indexable to overwrite.
202	*
203	* @return Indexable The date archive indexable.
204	*/
205	public function build_for_date_archive( $indexable = false ) {
206	return $this->build( $indexable, [ 'object_type' => 'date-archive' ] );
207	}
208
209	/**
210	* Creates an indexable for a post type archive.
211	*
212	* @param string $post_type The post type.
213	* @param Indexable\|bool $indexable Optional. An existing indexable to overwrite.
214	*
215	* @return Indexable The post type archive indexable.
216	*/
217	public function build_for_post_type_archive( $post_type, $indexable = false ) {
218	$defaults = [
219	'object_type' => 'post-type-archive',
220	'object_sub_type' => $post_type,
221	];
222	return $this->build( $indexable, $defaults );
223	}
224
225	/**
226	* Creates an indexable for a system page.
227	*
228	* @param string $page_type The type of system page.
229	* @param Indexable\|bool $indexable Optional. An existing indexable to overwrite.
230	*
231	* @return Indexable The search result indexable.
232	*/
233	public function build_for_system_page( $page_type, $indexable = false ) {
234	$defaults = [
235	'object_type' => 'system-page',
236	'object_sub_type' => $page_type,
237	];
238	return $this->build( $indexable, $defaults );
239	}
240
241	/**
242	* Ensures we have a valid indexable. Creates one if false is passed.
243	*
244	* @param Indexable\|false $indexable The indexable.
245	* @param array $defaults The initial properties of the Indexable.
246	*
247	* @return Indexable The indexable.
248	*/
249	private function ensure_indexable( $indexable, $defaults = [] ) {
250	if ( ! $indexable ) {
251	return $this->indexable_repository->query()->create( $defaults );
252	}
253
254	return $indexable;
255	}
256
257	/**
258	* Saves and returns an indexable (on production environments only).
259	*
260	* @param Indexable $indexable The indexable.
261	* @param Indexable\|null $indexable_before The indexable before possible changes.
262	*
263	* @return Indexable The indexable.
264	*/
265	protected function save_indexable( $indexable, $indexable_before = null ) {
266	$intend_to_save = $this->indexable_helper->should_index_indexables();
267
268	/**
269	* Filter: 'wpseo_should_save_indexable' - Allow developers to enable / disable
270	* saving the indexable when the indexable is updated. Warning: overriding
271	* the intended action may cause problems when moving from a staging to a
272	* production environment because indexable permalinks may get set incorrectly.
273	*
274	* @param Indexable $indexable The indexable to be saved.
275	*
276	* @api bool $intend_to_save True if YoastSEO intends to save the indexable.
277	*/
278	$intend_to_save = \apply_filters( 'wpseo_should_save_indexable', $intend_to_save, $indexable );
279
280	if ( ! $intend_to_save ) {
281	return $indexable;
282	}
283
284	// Save the indexable before running the WordPress hook.
285	$indexable->save();
286
287	if ( $indexable_before ) {
288	/**
289	* Action: 'wpseo_save_indexable' - Allow developers to perform an action
290	* when the indexable is updated.
291	*
292	* @param Indexable $indexable_before The indexable before saving.
293	*
294	* @api Indexable $indexable The saved indexable.
295	*/
296	\do_action( 'wpseo_save_indexable', $indexable, $indexable_before );
297	}
298
299	return $indexable;
300	}
301
302	/**
303	* Rebuilds an Indexable from scratch.
304	*
305	* @param Indexable $indexable The Indexable to (re)build.
306	* @param array\|null $defaults The object type of the Indexable.
307	*
308	* @return Indexable\|false The resulting Indexable.
309	*/
310	public function build( $indexable, $defaults = null ) {
311	// Backup the previous Indexable, if there was one.
312	$indexable_before = ( $indexable ) ? $this->deep_copy_indexable( $indexable ) : null;
313
314	// Make sure we have an Indexable to work with.
315	$indexable = $this->ensure_indexable( $indexable, $defaults );
316
317	try {
318	switch ( $indexable->object_type ) {
319
320	case 'post':
321	$indexable = $this->post_builder->build( $indexable->object_id, $indexable );
322	if ( ! $indexable ) {
323	// Indexable for this Post was not built for a reason; e.g. if its post type is excluded.
324	return $indexable;
325	}
326
327	// Always rebuild the primary term.
328	$this->primary_term_builder->build( $indexable->object_id );
329
330	// Always rebuild the hierarchy; this needs the primary term to run correctly.
331	$this->hierarchy_builder->build( $indexable );
332
333	// Rebuild the author indexable only when necessary.
334	$author_indexable = $this->indexable_repository->find_by_id_and_type(
335	$indexable->author_id,
336	'user',
337	false
338	);
339	if ( ! $author_indexable \|\| $this->version_manager->indexable_needs_upgrade( $author_indexable ) ) {
340	$author_defaults = [
341	'object_type' => 'user',
342	'object_id' => $indexable->author_id,
343	];
344	$this->build( $author_indexable, $author_defaults );
345	}
346	break;
347
348	case 'user':
349	$indexable = $this->author_builder->build( $indexable->object_id, $indexable );
350	break;
351
352	case 'term':
353	$indexable = $this->term_builder->build( $indexable->object_id, $indexable );
354	$this->hierarchy_builder->build( $indexable );
355	break;
356
357	case 'home-page':
358	$indexable = $this->home_page_builder->build( $indexable );
359	break;
360
361	case 'date-archive':
362	$indexable = $this->date_archive_builder->build( $indexable );
363	break;
364
365	case 'post-type-archive':
366	$indexable = $this->post_type_archive_builder->build( $indexable->object_sub_type, $indexable );
367	break;
368
369	case 'system-page':
370	$indexable = $this->system_page_builder->build( $indexable->object_sub_type, $indexable );
371	break;
372	}
373
374	return $this->save_indexable( $indexable, $indexable_before );
375	}
376	catch ( Source_Exception $exception ) {
377	/**
378	* The current indexable could not be indexed. Create a placeholder indexable, so we can
379	* skip this indexable in future indexing runs.
380	*
381	* @var Indexable $indexable
382	*/
383	$indexable = $this->indexable_repository
384	->query()
385	->create(
386	[
387	'object_id' => $indexable->object_id,
388	'object_type' => $indexable->object_type,
389	'post_status' => 'unindexed',
390	'version' => 0,
391	]
392	);
393	// Make sure that the indexing process doesn't get stuck in a loop on this broken indexable.
394	$indexable = $this->version_manager->set_latest( $indexable );
395
396	return $this->save_indexable( $indexable, $indexable_before );
397	}
398	}
399	}
400