-
Notifications
You must be signed in to change notification settings - Fork 879
/
class-wpseo-rank.php
338 lines (304 loc) · 7.18 KB
/
class-wpseo-rank.php
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Internals
*/
/**
* Holder for SEO Rank information.
*/
class WPSEO_Rank {
/**
* Constant used for determining a bad SEO rating.
*
* @var string
*/
public const BAD = 'bad';
/**
* Constant used for determining an OK SEO rating.
*
* @var string
*/
public const OK = 'ok';
/**
* Constant used for determining a good SEO rating.
*
* @var string
*/
public const GOOD = 'good';
/**
* Constant used for determining that no focus keyphrase is set.
*
* @var string
*/
public const NO_FOCUS = 'na';
/**
* Constant used for determining that this content is not indexed.
*
* @var string
*/
public const NO_INDEX = 'noindex';
/**
* All possible ranks.
*
* @var array
*/
protected static $ranks = [
self::BAD,
self::OK,
self::GOOD,
self::NO_FOCUS,
self::NO_INDEX,
];
/**
* Holds the translation from seo score slug to actual score range.
*
* @var array
*/
protected static $ranges = [
self::NO_FOCUS => [
'start' => 0,
'end' => 0,
],
self::BAD => [
'start' => 1,
'end' => 40,
],
self::OK => [
'start' => 41,
'end' => 70,
],
self::GOOD => [
'start' => 71,
'end' => 100,
],
];
/**
* The current rank.
*
* @var int
*/
protected $rank;
/**
* WPSEO_Rank constructor.
*
* @param int $rank The actual rank.
*/
public function __construct( $rank ) {
if ( ! in_array( $rank, self::$ranks, true ) ) {
$rank = self::BAD;
}
$this->rank = $rank;
}
/**
* Returns the saved rank for this rank.
*
* @return string
*/
public function get_rank() {
return $this->rank;
}
/**
* Returns a CSS class for this rank.
*
* @return string
*/
public function get_css_class() {
$labels = [
self::NO_FOCUS => 'na',
self::NO_INDEX => 'noindex',
self::BAD => 'bad',
self::OK => 'ok',
self::GOOD => 'good',
];
return $labels[ $this->rank ];
}
/**
* Returns a label for this rank.
*
* @return string
*/
public function get_label() {
$labels = [
self::NO_FOCUS => __( 'Not available', 'wordpress-seo' ),
self::NO_INDEX => __( 'No index', 'wordpress-seo' ),
self::BAD => __( 'Needs improvement', 'wordpress-seo' ),
self::OK => __( 'OK', 'wordpress-seo' ),
self::GOOD => __( 'Good', 'wordpress-seo' ),
];
return $labels[ $this->rank ];
}
/**
* Returns an inclusive language label for this rank.
* The only difference with get_label above is that we return "Potentially non-inclusive" for an OK rank.
*
* @return string
*/
public function get_inclusive_language_label() {
if ( $this->rank === self::OK ) {
return __( 'Potentially non-inclusive', 'wordpress-seo' );
}
return $this->get_label();
}
/**
* Returns a label for use in a drop down.
*
* @return mixed
*/
public function get_drop_down_label() {
$labels = [
self::NO_FOCUS => sprintf(
/* translators: %s expands to the SEO score */
__( 'SEO: %s', 'wordpress-seo' ),
__( 'No Focus Keyphrase', 'wordpress-seo' )
),
self::BAD => sprintf(
/* translators: %s expands to the SEO score */
__( 'SEO: %s', 'wordpress-seo' ),
__( 'Needs improvement', 'wordpress-seo' )
),
self::OK => sprintf(
/* translators: %s expands to the SEO score */
__( 'SEO: %s', 'wordpress-seo' ),
__( 'OK', 'wordpress-seo' )
),
self::GOOD => sprintf(
/* translators: %s expands to the SEO score */
__( 'SEO: %s', 'wordpress-seo' ),
__( 'Good', 'wordpress-seo' )
),
self::NO_INDEX => sprintf(
/* translators: %s expands to the SEO score */
__( 'SEO: %s', 'wordpress-seo' ),
__( 'Post Noindexed', 'wordpress-seo' )
),
];
return $labels[ $this->rank ];
}
/**
* Gets the drop down labels for the readability score.
*
* @return string The readability rank label.
*/
public function get_drop_down_readability_labels() {
$labels = [
self::BAD => sprintf(
/* translators: %s expands to the readability score */
__( 'Readability: %s', 'wordpress-seo' ),
__( 'Needs improvement', 'wordpress-seo' )
),
self::OK => sprintf(
/* translators: %s expands to the readability score */
__( 'Readability: %s', 'wordpress-seo' ),
__( 'OK', 'wordpress-seo' )
),
self::GOOD => sprintf(
/* translators: %s expands to the readability score */
__( 'Readability: %s', 'wordpress-seo' ),
__( 'Good', 'wordpress-seo' )
),
];
return $labels[ $this->rank ];
}
/**
* Gets the drop down labels for the inclusive language score.
*
* @return string The inclusive language rank label.
*/
public function get_drop_down_inclusive_language_labels() {
$labels = [
self::BAD => sprintf(
/* translators: %s expands to the inclusive language score */
__( 'Inclusive language: %s', 'wordpress-seo' ),
__( 'Needs improvement', 'wordpress-seo' )
),
self::OK => sprintf(
/* translators: %s expands to the inclusive language score */
__( 'Inclusive language: %s', 'wordpress-seo' ),
__( 'Potentially non-inclusive', 'wordpress-seo' )
),
self::GOOD => sprintf(
/* translators: %s expands to the inclusive language score */
__( 'Inclusive language: %s', 'wordpress-seo' ),
__( 'Good', 'wordpress-seo' )
),
];
return $labels[ $this->rank ];
}
/**
* Get the starting score for this rank.
*
* @return int The start score.
*/
public function get_starting_score() {
// No index does not have a starting score.
if ( $this->rank === self::NO_INDEX ) {
return -1;
}
return self::$ranges[ $this->rank ]['start'];
}
/**
* Get the ending score for this rank.
*
* @return int The end score.
*/
public function get_end_score() {
// No index does not have an end score.
if ( $this->rank === self::NO_INDEX ) {
return -1;
}
return self::$ranges[ $this->rank ]['end'];
}
/**
* Returns a rank for a specific numeric score.
*
* @param int $score The score to determine a rank for.
*
* @return self
*/
public static function from_numeric_score( $score ) {
// Set up the default value.
$rank = new self( self::BAD );
foreach ( self::$ranges as $rank_index => $range ) {
if ( $range['start'] <= $score && $score <= $range['end'] ) {
$rank = new self( $rank_index );
break;
}
}
return $rank;
}
/**
* Returns a list of all possible SEO Ranks.
*
* @return WPSEO_Rank[]
*/
public static function get_all_ranks() {
return array_map( [ 'WPSEO_Rank', 'create_rank' ], self::$ranks );
}
/**
* Returns a list of all possible Readability Ranks.
*
* @return WPSEO_Rank[]
*/
public static function get_all_readability_ranks() {
return array_map( [ 'WPSEO_Rank', 'create_rank' ], [ self::BAD, self::OK, self::GOOD ] );
}
/**
* Returns a list of all possible Inclusive Language Ranks.
*
* @return WPSEO_Rank[]
*/
public static function get_all_inclusive_language_ranks() {
return array_map( [ 'WPSEO_Rank', 'create_rank' ], [ self::BAD, self::OK, self::GOOD ] );
}
/**
* Converts a numeric rank into a WPSEO_Rank object, for use in functional array_* functions.
*
* @param string $rank SEO Rank.
*
* @return WPSEO_Rank
*/
private static function create_rank( $rank ) {
return new self( $rank );
}
}