Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Integrations\Admin;

[2] Fix | Delete

[3] Fix | Delete

use WP_Post;

[4] Fix | Delete

use Yoast\WP\SEO\Conditionals\Admin_Conditional;

[5] Fix | Delete

use Yoast\WP\SEO\Integrations\Integration_Interface;

[6] Fix | Delete

use Yoast\WP\SEO\Models\Indexable;

[7] Fix | Delete

use Yoast\WP\SEO\Repositories\Indexable_Repository;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Admin_Columns_Cache_Integration class.

[11] Fix | Delete

[12] Fix | Delete

class Admin_Columns_Cache_Integration implements Integration_Interface {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Cache of indexables.

[16] Fix | Delete

[17] Fix | Delete

* @var Indexable[]

[18] Fix | Delete

[19] Fix | Delete

protected $indexable_cache = [];

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* The indexable repository.

[23] Fix | Delete

[24] Fix | Delete

* @var Indexable_Repository

[25] Fix | Delete

[26] Fix | Delete

protected $indexable_repository;

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Returns the conditionals based on which this loadable should be active.

[30] Fix | Delete

[31] Fix | Delete

* In this case: only when on an admin page.

[32] Fix | Delete

[33] Fix | Delete

* @return array The conditionals.

[34] Fix | Delete

[35] Fix | Delete

public static function get_conditionals() {

[36] Fix | Delete

return [ Admin_Conditional::class ];

[37] Fix | Delete

}

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Admin_Columns_Cache_Integration constructor.

[41] Fix | Delete

[42] Fix | Delete

* @param Indexable_Repository $indexable_repository The indexable repository.

[43] Fix | Delete

[44] Fix | Delete

public function __construct( Indexable_Repository $indexable_repository ) {

[45] Fix | Delete

$this->indexable_repository = $indexable_repository;

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Registers the appropriate actions and filters to fill the cache with

[50] Fix | Delete

* indexables on admin pages.

[51] Fix | Delete

[52] Fix | Delete

* This cache is used in showing the Yoast SEO columns on the posts overview

[53] Fix | Delete

* page (e.g. keyword score, incoming link count, etc.)

[54] Fix | Delete

[55] Fix | Delete

* @return void

[56] Fix | Delete

[57] Fix | Delete

public function register_hooks() {

[58] Fix | Delete

// Hook into tablenav to calculate links and linked.

[59] Fix | Delete

\add_action( 'manage_posts_extra_tablenav', [ $this, 'maybe_fill_cache' ] );

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Makes sure we calculate all values in one query by filling our cache beforehand.

[64] Fix | Delete

[65] Fix | Delete

* @param string $target Extra table navigation location which is triggered.

[66] Fix | Delete

[67] Fix | Delete

* @return void

[68] Fix | Delete

[69] Fix | Delete

public function maybe_fill_cache( $target ) {

[70] Fix | Delete

if ( $target === 'top' ) {

[71] Fix | Delete

$this->fill_cache();

[72] Fix | Delete

}

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Fills the cache of indexables for all known post IDs.

[77] Fix | Delete

[78] Fix | Delete

* @return void

[79] Fix | Delete

[80] Fix | Delete

public function fill_cache() {

[81] Fix | Delete

global $wp_query;

[82] Fix | Delete

[83] Fix | Delete

// No need to continue building a cache if the main query did not return anything to cache.

[84] Fix | Delete

if ( empty( $wp_query->posts ) ) {

[85] Fix | Delete

return;

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

$posts = $wp_query->posts;

[89] Fix | Delete

$post_ids = [];

[90] Fix | Delete

[91] Fix | Delete

// Post lists return a list of objects.

[92] Fix | Delete

if ( isset( $posts[0] ) && \is_a( $posts[0], 'WP_Post' ) ) {

[93] Fix | Delete

$post_ids = \wp_list_pluck( $posts, 'ID' );

[94] Fix | Delete

}

[95] Fix | Delete

elseif ( isset( $posts[0] ) && \is_object( $posts[0] ) ) {

[96] Fix | Delete

$post_ids = $this->get_current_page_page_ids( $posts );

[97] Fix | Delete

}

[98] Fix | Delete

elseif ( ! empty( $posts ) ) {

[99] Fix | Delete

// Page list returns an array of post IDs.

[100] Fix | Delete

$post_ids = \array_keys( $posts );

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

if ( empty( $post_ids ) ) {

[104] Fix | Delete

return;

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

if ( isset( $posts[0] ) && ! \is_a( $posts[0], WP_Post::class ) ) {

[108] Fix | Delete

// Prime the post caches as core would to avoid duplicate queries.

[109] Fix | Delete

// This needs to be done as this executes before core does.

[110] Fix | Delete

\_prime_post_caches( $post_ids );

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

$indexables = $this->indexable_repository->find_by_multiple_ids_and_type( $post_ids, 'post', false );

[114] Fix | Delete

[115] Fix | Delete

foreach ( $indexables as $indexable ) {

[116] Fix | Delete

if ( $indexable instanceof Indexable ) {

[117] Fix | Delete

$this->indexable_cache[ $indexable->object_id ] = $indexable;

[118] Fix | Delete

}

[119] Fix | Delete

}

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

/**

[123] Fix | Delete

* Returns the indexable for a given post ID.

[124] Fix | Delete

[125] Fix | Delete

* @param int $post_id The post ID.

[126] Fix | Delete

[127] Fix | Delete

* @return Indexable|false The indexable. False if none could be found.

[128] Fix | Delete

[129] Fix | Delete

public function get_indexable( $post_id ) {

[130] Fix | Delete

if ( ! \array_key_exists( $post_id, $this->indexable_cache ) ) {

[131] Fix | Delete

$this->indexable_cache[ $post_id ] = $this->indexable_repository->find_by_id_and_type( $post_id, 'post' );

[132] Fix | Delete

}

[133] Fix | Delete

return $this->indexable_cache[ $post_id ];

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Gets all the page IDs set to be shown on the current page.

[138] Fix | Delete

* This is copied over with some changes from WP_Posts_List_Table::_display_rows_hierarchical.

[139] Fix | Delete

[140] Fix | Delete

* @param array $pages The pages, each containing an ID and post_parent.

[141] Fix | Delete

[142] Fix | Delete

* @return array The IDs of all pages shown on the current page.

[143] Fix | Delete

[144] Fix | Delete

private function get_current_page_page_ids( $pages ) {

[145] Fix | Delete

global $per_page;

[146] Fix | Delete

$pagenum = isset( $_REQUEST['paged'] ) ? \absint( $_REQUEST['paged'] ) : 0;

[147] Fix | Delete

$pagenum = \max( 1, $pagenum );

[148] Fix | Delete

[149] Fix | Delete

[150] Fix | Delete

* Arrange pages into two parts: top level pages and children_pages

[151] Fix | Delete

* children_pages is two dimensional array, eg.

[152] Fix | Delete

* children_pages[10][] contains all sub-pages whose parent is 10.

[153] Fix | Delete

* It only takes O( N ) to arrange this and it takes O( 1 ) for subsequent lookup operations

[154] Fix | Delete

* If searching, ignore hierarchy and treat everything as top level

[155] Fix | Delete

[156] Fix | Delete

if ( empty( $_REQUEST['s'] ) ) {

[157] Fix | Delete

$top_level_pages = [];

[158] Fix | Delete

$children_pages = [];

[159] Fix | Delete

$pages_map = [];

[160] Fix | Delete

[161] Fix | Delete

foreach ( $pages as $page ) {

[162] Fix | Delete

[163] Fix | Delete

// Catch and repair bad pages.

[164] Fix | Delete

if ( $page->post_parent === $page->ID ) {

[165] Fix | Delete

$page->post_parent = 0;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

if ( $page->post_parent === 0 ) {

[169] Fix | Delete

$top_level_pages[] = $page;

[170] Fix | Delete

}

[171] Fix | Delete

else {

[172] Fix | Delete

$children_pages[ $page->post_parent ][] = $page;

[173] Fix | Delete

}

[174] Fix | Delete

$pages_map[ $page->ID ] = $page;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

$pages = $top_level_pages;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

$count = 0;

[181] Fix | Delete

$start = ( ( $pagenum - 1 ) * $per_page );

[182] Fix | Delete

$end = ( $start + $per_page );

[183] Fix | Delete

$to_display = [];

[184] Fix | Delete

[185] Fix | Delete

foreach ( $pages as $page ) {

[186] Fix | Delete

if ( $count >= $end ) {

[187] Fix | Delete

break;

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

if ( $count >= $start ) {

[191] Fix | Delete

$to_display[] = $page->ID;

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

++$count;

[195] Fix | Delete

[196] Fix | Delete

$this->get_child_page_ids( $children_pages, $count, $page->ID, $start, $end, $to_display, $pages_map );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

// If it is the last pagenum and there are orphaned pages, display them with paging as well.

[200] Fix | Delete

if ( isset( $children_pages ) && $count < $end ) {

[201] Fix | Delete

foreach ( $children_pages as $orphans ) {

[202] Fix | Delete

foreach ( $orphans as $op ) {

[203] Fix | Delete

if ( $count >= $end ) {

[204] Fix | Delete

break;

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

if ( $count >= $start ) {

[208] Fix | Delete

$to_display[] = $op->ID;

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

++$count;

[212] Fix | Delete

}

[213] Fix | Delete

}

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

return $to_display;

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

/**

[220] Fix | Delete

* Adds all child pages due to be shown on the current page to the $to_display array.

[221] Fix | Delete

* Copied over with some changes from WP_Posts_List_Table::_page_rows.

[222] Fix | Delete

[223] Fix | Delete

* @param array $children_pages The full map of child pages.

[224] Fix | Delete

* @param int $count The number of pages already processed.

[225] Fix | Delete

* @param int $parent_id The id of the parent that's currently being processed.

[226] Fix | Delete

* @param int $start The number at which the current overview starts.

[227] Fix | Delete

* @param int $end The number at which the current overview ends.

[228] Fix | Delete

* @param int $to_display The page IDs to be shown.

[229] Fix | Delete

* @param int $pages_map A map of page ID to an object with ID and post_parent.

[230] Fix | Delete

[231] Fix | Delete

* @return void

[232] Fix | Delete

[233] Fix | Delete

private function get_child_page_ids( &$children_pages, &$count, $parent_id, $start, $end, &$to_display, &$pages_map ) {

[234] Fix | Delete

if ( ! isset( $children_pages[ $parent_id ] ) ) {

[235] Fix | Delete

return;

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

foreach ( $children_pages[ $parent_id ] as $page ) {

[239] Fix | Delete

if ( $count >= $end ) {

[240] Fix | Delete

break;

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

// If the page starts in a subtree, print the parents.

[244] Fix | Delete

if ( $count === $start && $page->post_parent > 0 ) {

[245] Fix | Delete

$my_parents = [];

[246] Fix | Delete

$my_parent = $page->post_parent;

[247] Fix | Delete

while ( $my_parent ) {

[248] Fix | Delete

// Get the ID from the list or the attribute if my_parent is an object.

[249] Fix | Delete

$parent_id = $my_parent;

[250] Fix | Delete

if ( \is_object( $my_parent ) ) {

[251] Fix | Delete

$parent_id = $my_parent->ID;

[252] Fix | Delete

}

[253] Fix | Delete

[254] Fix | Delete

$my_parent = $pages_map[ $parent_id ];

[255] Fix | Delete

$my_parents[] = $my_parent;

[256] Fix | Delete

if ( ! $my_parent->post_parent ) {

[257] Fix | Delete

break;

[258] Fix | Delete

}

[259] Fix | Delete

$my_parent = $my_parent->post_parent;

[260] Fix | Delete

}

[261] Fix | Delete

while ( $my_parent = \array_pop( $my_parents ) ) {

[262] Fix | Delete

$to_display[] = $my_parent->ID;

[263] Fix | Delete

}

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

if ( $count >= $start ) {

[267] Fix | Delete

$to_display[] = $page->ID;

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

++$count;

[271] Fix | Delete

[272] Fix | Delete

$this->get_child_page_ids( $children_pages, $count, $page->ID, $start, $end, $to_display, $pages_map );

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

unset( $children_pages[ $parent_id ] ); // Required in order to keep track of orphans.

[276] Fix | Delete

}

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete