Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Internals

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Holder for SEO Rank information.

[8] Fix | Delete

[9] Fix | Delete

class WPSEO_Rank {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Constant used for determining a bad SEO rating.

[13] Fix | Delete

[14] Fix | Delete

* @var string

[15] Fix | Delete

[16] Fix | Delete

public const BAD = 'bad';

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Constant used for determining an OK SEO rating.

[20] Fix | Delete

[21] Fix | Delete

* @var string

[22] Fix | Delete

[23] Fix | Delete

public const OK = 'ok';

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Constant used for determining a good SEO rating.

[27] Fix | Delete

[28] Fix | Delete

* @var string

[29] Fix | Delete

[30] Fix | Delete

public const GOOD = 'good';

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Constant used for determining that no focus keyphrase is set.

[34] Fix | Delete

[35] Fix | Delete

* @var string

[36] Fix | Delete

[37] Fix | Delete

public const NO_FOCUS = 'na';

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Constant used for determining that this content is not indexed.

[41] Fix | Delete

[42] Fix | Delete

* @var string

[43] Fix | Delete

[44] Fix | Delete

public const NO_INDEX = 'noindex';

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* All possible ranks.

[48] Fix | Delete

[49] Fix | Delete

* @var array

[50] Fix | Delete

[51] Fix | Delete

protected static $ranks = [

[52] Fix | Delete

self::BAD,

[53] Fix | Delete

self::OK,

[54] Fix | Delete

self::GOOD,

[55] Fix | Delete

self::NO_FOCUS,

[56] Fix | Delete

self::NO_INDEX,

[57] Fix | Delete

];

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Holds the translation from seo score slug to actual score range.

[61] Fix | Delete

[62] Fix | Delete

* @var array

[63] Fix | Delete

[64] Fix | Delete

protected static $ranges = [

[65] Fix | Delete

self::NO_FOCUS => [

[66] Fix | Delete

'start' => 0,

[67] Fix | Delete

'end' => 0,

[68] Fix | Delete

[69] Fix | Delete

self::BAD => [

[70] Fix | Delete

'start' => 1,

[71] Fix | Delete

'end' => 40,

[72] Fix | Delete

[73] Fix | Delete

self::OK => [

[74] Fix | Delete

'start' => 41,

[75] Fix | Delete

'end' => 70,

[76] Fix | Delete

[77] Fix | Delete

self::GOOD => [

[78] Fix | Delete

'start' => 71,

[79] Fix | Delete

'end' => 100,

[80] Fix | Delete

[81] Fix | Delete

];

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* The current rank.

[85] Fix | Delete

[86] Fix | Delete

* @var int

[87] Fix | Delete

[88] Fix | Delete

protected $rank;

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* WPSEO_Rank constructor.

[92] Fix | Delete

[93] Fix | Delete

* @param int $rank The actual rank.

[94] Fix | Delete

[95] Fix | Delete

public function __construct( $rank ) {

[96] Fix | Delete

if ( ! in_array( $rank, self::$ranks, true ) ) {

[97] Fix | Delete

$rank = self::BAD;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

$this->rank = $rank;

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Returns the saved rank for this rank.

[105] Fix | Delete

[106] Fix | Delete

* @return string

[107] Fix | Delete

[108] Fix | Delete

public function get_rank() {

[109] Fix | Delete

return $this->rank;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

/**

[113] Fix | Delete

* Returns a CSS class for this rank.

[114] Fix | Delete

[115] Fix | Delete

* @return string

[116] Fix | Delete

[117] Fix | Delete

public function get_css_class() {

[118] Fix | Delete

$labels = [

[119] Fix | Delete

self::NO_FOCUS => 'na',

[120] Fix | Delete

self::NO_INDEX => 'noindex',

[121] Fix | Delete

self::BAD => 'bad',

[122] Fix | Delete

self::OK => 'ok',

[123] Fix | Delete

self::GOOD => 'good',

[124] Fix | Delete

];

[125] Fix | Delete

[126] Fix | Delete

return $labels[ $this->rank ];

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Returns a label for this rank.

[131] Fix | Delete

[132] Fix | Delete

* @return string

[133] Fix | Delete

[134] Fix | Delete

public function get_label() {

[135] Fix | Delete

$labels = [

[136] Fix | Delete

self::NO_FOCUS => __( 'Not available', 'wordpress-seo' ),

[137] Fix | Delete

self::NO_INDEX => __( 'No index', 'wordpress-seo' ),

[138] Fix | Delete

self::BAD => __( 'Needs improvement', 'wordpress-seo' ),

[139] Fix | Delete

self::OK => __( 'OK', 'wordpress-seo' ),

[140] Fix | Delete

self::GOOD => __( 'Good', 'wordpress-seo' ),

[141] Fix | Delete

];

[142] Fix | Delete

[143] Fix | Delete

return $labels[ $this->rank ];

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Returns an inclusive language label for this rank.

[148] Fix | Delete

* The only difference with get_label above is that we return "Potentially non-inclusive" for an OK rank.

[149] Fix | Delete

[150] Fix | Delete

* @return string

[151] Fix | Delete

[152] Fix | Delete

public function get_inclusive_language_label() {

[153] Fix | Delete

if ( $this->rank === self::OK ) {

[154] Fix | Delete

return __( 'Potentially non-inclusive', 'wordpress-seo' );

[155] Fix | Delete

}

[156] Fix | Delete

return $this->get_label();

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* Returns a label for use in a drop down.

[161] Fix | Delete

[162] Fix | Delete

* @return mixed

[163] Fix | Delete

[164] Fix | Delete

public function get_drop_down_label() {

[165] Fix | Delete

$labels = [

[166] Fix | Delete

self::NO_FOCUS => sprintf(

[167] Fix | Delete

/* translators: %s expands to the SEO score */

[168] Fix | Delete

__( 'SEO: %s', 'wordpress-seo' ),

[169] Fix | Delete

__( 'No Focus Keyphrase', 'wordpress-seo' )

[170] Fix | Delete

[171] Fix | Delete

self::BAD => sprintf(

[172] Fix | Delete

/* translators: %s expands to the SEO score */

[173] Fix | Delete

__( 'SEO: %s', 'wordpress-seo' ),

[174] Fix | Delete

__( 'Needs improvement', 'wordpress-seo' )

[175] Fix | Delete

[176] Fix | Delete

self::OK => sprintf(

[177] Fix | Delete

/* translators: %s expands to the SEO score */

[178] Fix | Delete

__( 'SEO: %s', 'wordpress-seo' ),

[179] Fix | Delete

__( 'OK', 'wordpress-seo' )

[180] Fix | Delete

[181] Fix | Delete

self::GOOD => sprintf(

[182] Fix | Delete

/* translators: %s expands to the SEO score */

[183] Fix | Delete

__( 'SEO: %s', 'wordpress-seo' ),

[184] Fix | Delete

__( 'Good', 'wordpress-seo' )

[185] Fix | Delete

[186] Fix | Delete

self::NO_INDEX => sprintf(

[187] Fix | Delete

/* translators: %s expands to the SEO score */

[188] Fix | Delete

__( 'SEO: %s', 'wordpress-seo' ),

[189] Fix | Delete

__( 'Post Noindexed', 'wordpress-seo' )

[190] Fix | Delete

[191] Fix | Delete

];

[192] Fix | Delete

[193] Fix | Delete

return $labels[ $this->rank ];

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* Gets the drop down labels for the readability score.

[198] Fix | Delete

[199] Fix | Delete

* @return string The readability rank label.

[200] Fix | Delete

[201] Fix | Delete

public function get_drop_down_readability_labels() {

[202] Fix | Delete

$labels = [

[203] Fix | Delete

self::BAD => sprintf(

[204] Fix | Delete

/* translators: %s expands to the readability score */

[205] Fix | Delete

__( 'Readability: %s', 'wordpress-seo' ),

[206] Fix | Delete

__( 'Needs improvement', 'wordpress-seo' )

[207] Fix | Delete

[208] Fix | Delete

self::OK => sprintf(

[209] Fix | Delete

/* translators: %s expands to the readability score */

[210] Fix | Delete

__( 'Readability: %s', 'wordpress-seo' ),

[211] Fix | Delete

__( 'OK', 'wordpress-seo' )

[212] Fix | Delete

[213] Fix | Delete

self::GOOD => sprintf(

[214] Fix | Delete

/* translators: %s expands to the readability score */

[215] Fix | Delete

__( 'Readability: %s', 'wordpress-seo' ),

[216] Fix | Delete

__( 'Good', 'wordpress-seo' )

[217] Fix | Delete

[218] Fix | Delete

];

[219] Fix | Delete

[220] Fix | Delete

return $labels[ $this->rank ];

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

/**

[224] Fix | Delete

* Gets the drop down labels for the inclusive language score.

[225] Fix | Delete

[226] Fix | Delete

* @return string The inclusive language rank label.

[227] Fix | Delete

[228] Fix | Delete

public function get_drop_down_inclusive_language_labels() {

[229] Fix | Delete

$labels = [

[230] Fix | Delete

self::BAD => sprintf(

[231] Fix | Delete

/* translators: %s expands to the inclusive language score */

[232] Fix | Delete

__( 'Inclusive language: %s', 'wordpress-seo' ),

[233] Fix | Delete

__( 'Needs improvement', 'wordpress-seo' )

[234] Fix | Delete

[235] Fix | Delete

self::OK => sprintf(

[236] Fix | Delete

/* translators: %s expands to the inclusive language score */

[237] Fix | Delete

__( 'Inclusive language: %s', 'wordpress-seo' ),

[238] Fix | Delete

__( 'Potentially non-inclusive', 'wordpress-seo' )

[239] Fix | Delete

[240] Fix | Delete

self::GOOD => sprintf(

[241] Fix | Delete

/* translators: %s expands to the inclusive language score */

[242] Fix | Delete

__( 'Inclusive language: %s', 'wordpress-seo' ),

[243] Fix | Delete

__( 'Good', 'wordpress-seo' )

[244] Fix | Delete

[245] Fix | Delete

];

[246] Fix | Delete

[247] Fix | Delete

return $labels[ $this->rank ];

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Get the starting score for this rank.

[252] Fix | Delete

[253] Fix | Delete

* @return int The start score.

[254] Fix | Delete

[255] Fix | Delete

public function get_starting_score() {

[256] Fix | Delete

// No index does not have a starting score.

[257] Fix | Delete

if ( $this->rank === self::NO_INDEX ) {

[258] Fix | Delete

return -1;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

return self::$ranges[ $this->rank ]['start'];

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

/**

[265] Fix | Delete

* Get the ending score for this rank.

[266] Fix | Delete

[267] Fix | Delete

* @return int The end score.

[268] Fix | Delete

[269] Fix | Delete

public function get_end_score() {

[270] Fix | Delete

// No index does not have an end score.

[271] Fix | Delete

if ( $this->rank === self::NO_INDEX ) {

[272] Fix | Delete

return -1;

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

return self::$ranges[ $this->rank ]['end'];

[276] Fix | Delete

}

[277] Fix | Delete

[278] Fix | Delete

/**

[279] Fix | Delete

* Returns a rank for a specific numeric score.

[280] Fix | Delete

[281] Fix | Delete

* @param int $score The score to determine a rank for.

[282] Fix | Delete

[283] Fix | Delete

* @return self

[284] Fix | Delete

[285] Fix | Delete

public static function from_numeric_score( $score ) {

[286] Fix | Delete

// Set up the default value.

[287] Fix | Delete

$rank = new self( self::BAD );

[288] Fix | Delete

[289] Fix | Delete

foreach ( self::$ranges as $rank_index => $range ) {

[290] Fix | Delete

if ( $range['start'] <= $score && $score <= $range['end'] ) {

[291] Fix | Delete

$rank = new self( $rank_index );

[292] Fix | Delete

break;

[293] Fix | Delete

}

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete

return $rank;

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

/**

[300] Fix | Delete

* Returns a list of all possible SEO Ranks.

[301] Fix | Delete

[302] Fix | Delete

* @return WPSEO_Rank[]

[303] Fix | Delete

[304] Fix | Delete

public static function get_all_ranks() {

[305] Fix | Delete

return array_map( [ 'WPSEO_Rank', 'create_rank' ], self::$ranks );

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

/**

[309] Fix | Delete

* Returns a list of all possible Readability Ranks.

[310] Fix | Delete

[311] Fix | Delete

* @return WPSEO_Rank[]

[312] Fix | Delete

[313] Fix | Delete

public static function get_all_readability_ranks() {

[314] Fix | Delete

return array_map( [ 'WPSEO_Rank', 'create_rank' ], [ self::BAD, self::OK, self::GOOD ] );

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

/**

[318] Fix | Delete

* Returns a list of all possible Inclusive Language Ranks.

[319] Fix | Delete

[320] Fix | Delete

* @return WPSEO_Rank[]

[321] Fix | Delete

[322] Fix | Delete

public static function get_all_inclusive_language_ranks() {

[323] Fix | Delete

return array_map( [ 'WPSEO_Rank', 'create_rank' ], [ self::BAD, self::OK, self::GOOD ] );

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

/**

[327] Fix | Delete

* Converts a numeric rank into a WPSEO_Rank object, for use in functional array_* functions.

[328] Fix | Delete

[329] Fix | Delete

* @param string $rank SEO Rank.

[330] Fix | Delete

[331] Fix | Delete

* @return WPSEO_Rank

[332] Fix | Delete

[333] Fix | Delete

private static function create_rank( $rank ) {

[334] Fix | Delete

return new self( $rank );

[335] Fix | Delete

}

[336] Fix | Delete

}

[337] Fix | Delete

[338] Fix | Delete