Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Admin\Statistics

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Class WPSEO_Statistics_Service.

[8] Fix | Delete

[9] Fix | Delete

class WPSEO_Statistics_Service {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Cache transient id.

[13] Fix | Delete

[14] Fix | Delete

* @var string

[15] Fix | Delete

[16] Fix | Delete

public const CACHE_TRANSIENT_KEY = 'wpseo-statistics-totals';

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Class that generates interesting statistics about things.

[20] Fix | Delete

[21] Fix | Delete

* @var WPSEO_Statistics

[22] Fix | Delete

[23] Fix | Delete

protected $statistics;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Statistics labels.

[27] Fix | Delete

[28] Fix | Delete

* @var string[]

[29] Fix | Delete

[30] Fix | Delete

protected $labels;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* WPSEO_Statistics_Service contructor.

[34] Fix | Delete

[35] Fix | Delete

* @param WPSEO_Statistics $statistics The statistics class to retrieve statistics from.

[36] Fix | Delete

[37] Fix | Delete

public function __construct( WPSEO_Statistics $statistics ) {

[38] Fix | Delete

$this->statistics = $statistics;

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Fetches statistics by REST request.

[43] Fix | Delete

[44] Fix | Delete

* @return WP_REST_Response The response object.

[45] Fix | Delete

[46] Fix | Delete

public function get_statistics() {

[47] Fix | Delete

// Switch to the user locale with fallback to the site locale.

[48] Fix | Delete

switch_to_locale( get_user_locale() );

[49] Fix | Delete

[50] Fix | Delete

$this->labels = $this->labels();

[51] Fix | Delete

$statistics = $this->statistic_items();

[52] Fix | Delete

[53] Fix | Delete

$data = [

[54] Fix | Delete

'header' => $this->get_header_from_statistics( $statistics ),

[55] Fix | Delete

'seo_scores' => $statistics['scores'],

[56] Fix | Delete

];

[57] Fix | Delete

[58] Fix | Delete

return new WP_REST_Response( $data );

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Gets a header summarizing the given statistics results.

[63] Fix | Delete

[64] Fix | Delete

* @param array $statistics The statistics results.

[65] Fix | Delete

[66] Fix | Delete

* @return string The header summing up the statistics results.

[67] Fix | Delete

[68] Fix | Delete

private function get_header_from_statistics( array $statistics ) {

[69] Fix | Delete

// Personal interpretation to allow release, should be looked at later.

[70] Fix | Delete

if ( $statistics['division'] === false ) {

[71] Fix | Delete

return __( 'You don\'t have any published posts, your SEO scores will appear here once you make your first post!', 'wordpress-seo' );

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

if ( $statistics['division']['good'] > 0.66 ) {

[75] Fix | Delete

return __( 'Hey, your SEO is doing pretty well! Check out the stats:', 'wordpress-seo' );

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

return __( 'Below are your published posts\' SEO scores. Now is as good a time as any to start improving some of your posts!', 'wordpress-seo' );

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* An array representing items to be added to the At a Glance dashboard widget.

[83] Fix | Delete

[84] Fix | Delete

* @return array The statistics for the current user.

[85] Fix | Delete

[86] Fix | Delete

private function statistic_items() {

[87] Fix | Delete

$transient = $this->get_transient();

[88] Fix | Delete

$user_id = get_current_user_id();

[89] Fix | Delete

[90] Fix | Delete

if ( isset( $transient[ $user_id ] ) ) {

[91] Fix | Delete

return $transient[ $user_id ];

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

return $this->set_statistic_items_for_user( $transient, $user_id );

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Gets the statistics transient value. Returns array if transient wasn't set.

[99] Fix | Delete

[100] Fix | Delete

* @return array|mixed Returns the transient or an empty array if the transient doesn't exist.

[101] Fix | Delete

[102] Fix | Delete

private function get_transient() {

[103] Fix | Delete

$transient = get_transient( self::CACHE_TRANSIENT_KEY );

[104] Fix | Delete

[105] Fix | Delete

if ( $transient === false ) {

[106] Fix | Delete

return [];

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

return $transient;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

/**

[113] Fix | Delete

* Set the statistics transient cache for a specific user.

[114] Fix | Delete

[115] Fix | Delete

* @param array $transient The current stored transient with the cached data.

[116] Fix | Delete

* @param int $user The user's ID to assign the retrieved values to.

[117] Fix | Delete

[118] Fix | Delete

* @return array The statistics transient for the user.

[119] Fix | Delete

[120] Fix | Delete

private function set_statistic_items_for_user( $transient, $user ) {

[121] Fix | Delete

$scores = $this->get_seo_scores_with_post_count();

[122] Fix | Delete

$division = $this->get_seo_score_division( $scores );

[123] Fix | Delete

[124] Fix | Delete

$transient[ $user ] = [

[125] Fix | Delete

// Use array_values because array_filter may return non-zero indexed arrays.

[126] Fix | Delete

'scores' => array_values( array_filter( $scores, [ $this, 'filter_items' ] ) ),

[127] Fix | Delete

'division' => $division,

[128] Fix | Delete

];

[129] Fix | Delete

[130] Fix | Delete

set_transient( self::CACHE_TRANSIENT_KEY, $transient, DAY_IN_SECONDS );

[131] Fix | Delete

[132] Fix | Delete

return $transient[ $user ];

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Gets the division of SEO scores.

[137] Fix | Delete

[138] Fix | Delete

* @param array $scores The SEO scores.

[139] Fix | Delete

[140] Fix | Delete

* @return array|bool The division of SEO scores, false if there are no posts.

[141] Fix | Delete

[142] Fix | Delete

private function get_seo_score_division( array $scores ) {

[143] Fix | Delete

$total = 0;

[144] Fix | Delete

$division = [];

[145] Fix | Delete

[146] Fix | Delete

foreach ( $scores as $score ) {

[147] Fix | Delete

$total += $score['count'];

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

if ( $total === 0 ) {

[151] Fix | Delete

return false;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

foreach ( $scores as $score ) {

[155] Fix | Delete

$division[ $score['seo_rank'] ] = ( $score['count'] / $total );

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

return $division;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* Get all SEO ranks and data associated with them.

[163] Fix | Delete

[164] Fix | Delete

* @return array An array of SEO scores and associated data.

[165] Fix | Delete

[166] Fix | Delete

private function get_seo_scores_with_post_count() {

[167] Fix | Delete

$ranks = WPSEO_Rank::get_all_ranks();

[168] Fix | Delete

[169] Fix | Delete

return array_map( [ $this, 'map_rank_to_widget' ], $ranks );

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

/**

[173] Fix | Delete

* Converts a rank to data usable in the dashboard widget.

[174] Fix | Delete

[175] Fix | Delete

* @param WPSEO_Rank $rank The rank to map.

[176] Fix | Delete

[177] Fix | Delete

* @return array The mapped rank.

[178] Fix | Delete

[179] Fix | Delete

private function map_rank_to_widget( WPSEO_Rank $rank ) {

[180] Fix | Delete

return [

[181] Fix | Delete

'seo_rank' => $rank->get_rank(),

[182] Fix | Delete

'label' => $this->get_label_for_rank( $rank ),

[183] Fix | Delete

'count' => $this->statistics->get_post_count( $rank ),

[184] Fix | Delete

'link' => $this->get_link_for_rank( $rank ),

[185] Fix | Delete

];

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Returns a dashboard widget label to use for a certain rank.

[190] Fix | Delete

[191] Fix | Delete

* @param WPSEO_Rank $rank The rank to return a label for.

[192] Fix | Delete

[193] Fix | Delete

* @return string The label for the rank.

[194] Fix | Delete

[195] Fix | Delete

private function get_label_for_rank( WPSEO_Rank $rank ) {

[196] Fix | Delete

return $this->labels[ $rank->get_rank() ];

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Determines the labels for the various scoring ranks that are known within Yoast SEO.

[201] Fix | Delete

[202] Fix | Delete

* @return array Array containing the translatable labels.

[203] Fix | Delete

[204] Fix | Delete

private function labels() {

[205] Fix | Delete

return [

[206] Fix | Delete

WPSEO_Rank::NO_FOCUS => sprintf(

[207] Fix | Delete

/* translators: %1$s expands to an opening strong tag, %2$s expands to a closing strong tag */

[208] Fix | Delete

__( 'Posts %1$swithout%2$s a focus keyphrase', 'wordpress-seo' ),

[209] Fix | Delete

'',

[210] Fix | Delete

''

[211] Fix | Delete

[212] Fix | Delete

WPSEO_Rank::BAD => sprintf(

[213] Fix | Delete

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

[214] Fix | Delete

__( 'Posts with the SEO score: %s', 'wordpress-seo' ),

[215] Fix | Delete

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

[216] Fix | Delete

[217] Fix | Delete

WPSEO_Rank::OK => sprintf(

[218] Fix | Delete

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

[219] Fix | Delete

__( 'Posts with the SEO score: %s', 'wordpress-seo' ),

[220] Fix | Delete

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

[221] Fix | Delete

[222] Fix | Delete

WPSEO_Rank::GOOD => sprintf(

[223] Fix | Delete

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

[224] Fix | Delete

__( 'Posts with the SEO score: %s', 'wordpress-seo' ),

[225] Fix | Delete

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

[226] Fix | Delete

[227] Fix | Delete

WPSEO_Rank::NO_INDEX => __( 'Posts that should not show up in search results', 'wordpress-seo' ),

[228] Fix | Delete

];

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

/**

[232] Fix | Delete

* Filter items if they have a count of zero.

[233] Fix | Delete

[234] Fix | Delete

* @param array $item The item to potentially filter out.

[235] Fix | Delete

[236] Fix | Delete

* @return bool Whether or not the count is zero.

[237] Fix | Delete

[238] Fix | Delete

private function filter_items( $item ) {

[239] Fix | Delete

return $item['count'] !== 0;

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

/**

[243] Fix | Delete

* Returns a link for the overview of posts of a certain rank.

[244] Fix | Delete

[245] Fix | Delete

* @param WPSEO_Rank $rank The rank to return a link for.

[246] Fix | Delete

[247] Fix | Delete

* @return string The link that shows an overview of posts with that rank.

[248] Fix | Delete

[249] Fix | Delete

private function get_link_for_rank( WPSEO_Rank $rank ) {

[250] Fix | Delete

if ( current_user_can( 'edit_others_posts' ) === false ) {

[251] Fix | Delete

return esc_url( admin_url( 'edit.php?post_status=publish&post_type=post&seo_filter=' . $rank->get_rank() . '&author=' . get_current_user_id() ) );

[252] Fix | Delete

}

[253] Fix | Delete

[254] Fix | Delete

return esc_url( admin_url( 'edit.php?post_status=publish&post_type=post&seo_filter=' . $rank->get_rank() ) );

[255] Fix | Delete

}

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete