1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
<?php
namespace Yoast\WP\SEO\Helpers;
use Yoast\WP\SEO\Actions\Indexing\Indexable_General_Indexation_Action;
use Yoast\WP\SEO\Actions\Indexing\Indexable_Post_Indexation_Action;
use Yoast\WP\SEO\Actions\Indexing\Indexable_Post_Type_Archive_Indexation_Action;
use Yoast\WP\SEO\Actions\Indexing\Indexable_Term_Indexation_Action;
use Yoast\WP\SEO\Actions\Indexing\Post_Link_Indexing_Action;
use Yoast\WP\SEO\Actions\Indexing\Term_Link_Indexing_Action;
use Yoast\WP\SEO\Config\Indexing_Reasons;
use Yoast\WP\SEO\Integrations\Admin\Indexing_Notification_Integration;
use Yoast_Notification_Center;
/**
* A helper object for indexing.
*/
class Indexing_Helper {
/**
* The options helper.
*
* @var Options_Helper
*/
protected $options_helper;
/**
* The date helper.
*
* @var Date_Helper
*/
protected $date_helper;
/**
* The notification center.
*
* @var Yoast_Notification_Center
*/
protected $notification_center;
/**
* The post indexing action.
*
* @var Indexable_Post_Indexation_Action
*/
protected $post_indexation;
/**
* The term indexing action.
*
* @var Indexable_Term_Indexation_Action
*/
protected $term_indexation;
/**
* The post type archive indexing action.
*
* @var Indexable_Post_Type_Archive_Indexation_Action
*/
protected $post_type_archive_indexation;
/**
* The post link indexing action.
*
* @var Post_Link_Indexing_Action
*/
protected $post_link_indexing_action;
/**
* The term link indexing action.
*
* @var Term_Link_Indexing_Action
*/
protected $term_link_indexing_action;
/**
* Represents the general indexing.
*
* @var Indexable_General_Indexation_Action
*/
protected $general_indexation;
/**
* Indexing_Helper constructor.
*
* @param Options_Helper $options_helper The options helper.
* @param Date_Helper $date_helper The date helper.
* @param Yoast_Notification_Center $notification_center The notification center.
*/
public function __construct(
Options_Helper $options_helper,
Date_Helper $date_helper,
Yoast_Notification_Center $notification_center
) {
$this->options_helper = $options_helper;
$this->date_helper = $date_helper;
$this->notification_center = $notification_center;
}
/**
* Sets the actions.
*
* @required
*
* @param Indexable_Post_Indexation_Action $post_indexation The post indexing action.
* @param Indexable_Term_Indexation_Action $term_indexation The term indexing action.
* @param Indexable_Post_Type_Archive_Indexation_Action $post_type_archive_indexation The posttype indexing action.
* @param Indexable_General_Indexation_Action $general_indexation The general indexing (homepage etc) action.
* @param Post_Link_Indexing_Action $post_link_indexing_action The post crosslink indexing action.
* @param Term_Link_Indexing_Action $term_link_indexing_action The term crossling indexing action.
*/
public function set_indexing_actions(
Indexable_Post_Indexation_Action $post_indexation,
Indexable_Term_Indexation_Action $term_indexation,
Indexable_Post_Type_Archive_Indexation_Action $post_type_archive_indexation,
Indexable_General_Indexation_Action $general_indexation,
Post_Link_Indexing_Action $post_link_indexing_action,
Term_Link_Indexing_Action $term_link_indexing_action
) {
$this->post_indexation = $post_indexation;
$this->term_indexation = $term_indexation;
$this->post_type_archive_indexation = $post_type_archive_indexation;
$this->general_indexation = $general_indexation;
$this->post_link_indexing_action = $post_link_indexing_action;
$this->term_link_indexing_action = $term_link_indexing_action;
}
/**
* Sets several database options when the indexing process is started.
*
* @return void
*/
public function start() {
$this->set_first_time( false );
$this->set_started( $this->date_helper->current_time() );
}
/**
* Sets several database options when the indexing process is finished.
*
* @return void
*/
public function finish() {
$this->set_reason( '' );
$this->set_started( null );
}
/**
* Sets appropriate flags when the indexing process fails.
*
* @return void
*/
public function indexing_failed() {
$this->set_reason( Indexing_Reasons::REASON_INDEXING_FAILED );
$this->set_started( null );
}
/**
* Sets the indexing reason.
*
* @param string $reason The indexing reason.
*
* @return void
*/
public function set_reason( $reason ) {
$this->options_helper->set( 'indexing_reason', $reason );
/*
* Remove any pre-existing notification, so that a new notification
* (with a possible new reason) can be added.
*/
$this->notification_center->remove_notification_by_id(
Indexing_Notification_Integration::NOTIFICATION_ID
);
}
/**
* Determines whether an indexing reason has been set in the options.
*
* @return bool Whether an indexing reason has been set in the options.
*/
public function has_reason() {
$reason = $this->get_reason();
return ! empty( $reason );
}
/**
* Returns the indexing reason. The reason why the site-wide indexing process should be run.
*
* @return string The indexing reason, defaults to the empty string if no reason has been set.
*/
public function get_reason() {
return $this->options_helper->get( 'indexing_reason', '' );
}
/**
* Sets the start time when the indexing process has started but not completed.
*
* @param int|bool $timestamp The start time when the indexing process has started but not completed, false otherwise.
*
* @return void
*/
public function set_started( $timestamp ) {
$this->options_helper->set( 'indexing_started', $timestamp );
}
/**
* Gets the start time when the indexing process has started but not completed.
*
* @return int|bool $start_time The start time when the indexing process has started but not completed, false otherwise.
*/
public function get_started() {
return $this->options_helper->get( 'indexing_started' );
}
/**
* Sets a boolean that indicates whether or not a site still has to be indexed for the first time.
*
* @param bool $is_first_time_indexing Whether or not a site still has to be indexed for the first time.
*
* @return void
*/
public function set_first_time( $is_first_time_indexing ) {
$this->options_helper->set( 'indexing_first_time', $is_first_time_indexing );
}
/**
* Gets a boolean that indicates whether or not the site still has to be indexed for the first time.
*
* @return bool Whether the site still has to be indexed for the first time.
*/
public function is_initial_indexing() {
return $this->options_helper->get( 'indexing_first_time', true );
}
/**
* Returns the total number of unindexed objects.
*
* @return int The total number of unindexed objects.
*/
public function get_unindexed_count() {
$unindexed_count = $this->post_indexation->get_total_unindexed();
$unindexed_count += $this->term_indexation->get_total_unindexed();
$unindexed_count += $this->general_indexation->get_total_unindexed();
$unindexed_count += $this->post_type_archive_indexation->get_total_unindexed();
$unindexed_count += $this->post_link_indexing_action->get_total_unindexed();
$unindexed_count += $this->term_link_indexing_action->get_total_unindexed();
return $unindexed_count;
}
/**
* Returns the total number of unindexed objects and applies a filter for third party integrations.
*
* @return int The total number of unindexed objects.
*/
public function get_filtered_unindexed_count() {
/**
* Filter: 'wpseo_indexing_get_unindexed_count' - Allow changing the amount of unindexed objects.
*
* @param int $unindexed_count The amount of unindexed objects.
*/
return \apply_filters( 'wpseo_indexing_get_unindexed_count', $this->get_unindexed_count() );
}
}
|