Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Builders;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Exceptions\Indexable\Not_Built_Exception;

[4] Fix | Delete

use Yoast\WP\SEO\Exceptions\Indexable\Source_Exception;

[5] Fix | Delete

use Yoast\WP\SEO\Helpers\Indexable_Helper;

[6] Fix | Delete

use Yoast\WP\SEO\Models\Indexable;

[7] Fix | Delete

use Yoast\WP\SEO\Repositories\Indexable_Repository;

[8] Fix | Delete

use Yoast\WP\SEO\Services\Indexables\Indexable_Version_Manager;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Builder for the indexables.

[12] Fix | Delete

[13] Fix | Delete

* Creates all the indexables.

[14] Fix | Delete

[15] Fix | Delete

class Indexable_Builder {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* The author builder.

[19] Fix | Delete

[20] Fix | Delete

* @var Indexable_Author_Builder

[21] Fix | Delete

[22] Fix | Delete

private $author_builder;

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* The post builder.

[26] Fix | Delete

[27] Fix | Delete

* @var Indexable_Post_Builder

[28] Fix | Delete

[29] Fix | Delete

private $post_builder;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* The term builder.

[33] Fix | Delete

[34] Fix | Delete

* @var Indexable_Term_Builder

[35] Fix | Delete

[36] Fix | Delete

private $term_builder;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* The home page builder.

[40] Fix | Delete

[41] Fix | Delete

* @var Indexable_Home_Page_Builder

[42] Fix | Delete

[43] Fix | Delete

private $home_page_builder;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* The post type archive builder.

[47] Fix | Delete

[48] Fix | Delete

* @var Indexable_Post_Type_Archive_Builder

[49] Fix | Delete

[50] Fix | Delete

private $post_type_archive_builder;

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* The data archive builder.

[54] Fix | Delete

[55] Fix | Delete

* @var Indexable_Date_Archive_Builder

[56] Fix | Delete

[57] Fix | Delete

private $date_archive_builder;

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* The system page builder.

[61] Fix | Delete

[62] Fix | Delete

* @var Indexable_System_Page_Builder

[63] Fix | Delete

[64] Fix | Delete

private $system_page_builder;

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* The indexable hierarchy builder.

[68] Fix | Delete

[69] Fix | Delete

* @var Indexable_Hierarchy_Builder

[70] Fix | Delete

[71] Fix | Delete

private $hierarchy_builder;

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* The primary term builder

[75] Fix | Delete

[76] Fix | Delete

* @var Primary_Term_Builder

[77] Fix | Delete

[78] Fix | Delete

private $primary_term_builder;

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* The link builder

[82] Fix | Delete

[83] Fix | Delete

* @var Indexable_Link_Builder

[84] Fix | Delete

[85] Fix | Delete

private $link_builder;

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* The indexable repository.

[89] Fix | Delete

[90] Fix | Delete

* @var Indexable_Repository

[91] Fix | Delete

[92] Fix | Delete

private $indexable_repository;

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* The indexable helper.

[96] Fix | Delete

[97] Fix | Delete

* @var Indexable_Helper

[98] Fix | Delete

[99] Fix | Delete

protected $indexable_helper;

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* The Indexable Version Manager.

[103] Fix | Delete

[104] Fix | Delete

* @var Indexable_Version_Manager

[105] Fix | Delete

[106] Fix | Delete

protected $version_manager;

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Returns the instance of this class constructed through the ORM Wrapper.

[110] Fix | Delete

[111] Fix | Delete

* @param Indexable_Author_Builder $author_builder The author builder for creating missing indexables.

[112] Fix | Delete

* @param Indexable_Post_Builder $post_builder The post builder for creating missing indexables.

[113] Fix | Delete

* @param Indexable_Term_Builder $term_builder The term builder for creating missing indexables.

[114] Fix | Delete

* @param Indexable_Home_Page_Builder $home_page_builder The front page builder for creating missing indexables.

[115] Fix | Delete

* @param Indexable_Post_Type_Archive_Builder $post_type_archive_builder The post type archive builder for creating missing indexables.

[116] Fix | Delete

* @param Indexable_Date_Archive_Builder $date_archive_builder The date archive builder for creating missing indexables.

[117] Fix | Delete

* @param Indexable_System_Page_Builder $system_page_builder The search result builder for creating missing indexables.

[118] Fix | Delete

* @param Indexable_Hierarchy_Builder $hierarchy_builder The hierarchy builder for creating the indexable hierarchy.

[119] Fix | Delete

* @param Primary_Term_Builder $primary_term_builder The primary term builder for creating primary terms for posts.

[120] Fix | Delete

* @param Indexable_Helper $indexable_helper The indexable helper.

[121] Fix | Delete

* @param Indexable_Version_Manager $version_manager The indexable version manager.

[122] Fix | Delete

* @param Indexable_Link_Builder $link_builder The link builder for creating missing SEO links.

[123] Fix | Delete

[124] Fix | Delete

public function __construct(

[125] Fix | Delete

Indexable_Author_Builder $author_builder,

[126] Fix | Delete

Indexable_Post_Builder $post_builder,

[127] Fix | Delete

Indexable_Term_Builder $term_builder,

[128] Fix | Delete

Indexable_Home_Page_Builder $home_page_builder,

[129] Fix | Delete

Indexable_Post_Type_Archive_Builder $post_type_archive_builder,

[130] Fix | Delete

Indexable_Date_Archive_Builder $date_archive_builder,

[131] Fix | Delete

Indexable_System_Page_Builder $system_page_builder,

[132] Fix | Delete

Indexable_Hierarchy_Builder $hierarchy_builder,

[133] Fix | Delete

Primary_Term_Builder $primary_term_builder,

[134] Fix | Delete

Indexable_Helper $indexable_helper,

[135] Fix | Delete

Indexable_Version_Manager $version_manager,

[136] Fix | Delete

Indexable_Link_Builder $link_builder

[137] Fix | Delete

) {

[138] Fix | Delete

$this->author_builder = $author_builder;

[139] Fix | Delete

$this->post_builder = $post_builder;

[140] Fix | Delete

$this->term_builder = $term_builder;

[141] Fix | Delete

$this->home_page_builder = $home_page_builder;

[142] Fix | Delete

$this->post_type_archive_builder = $post_type_archive_builder;

[143] Fix | Delete

$this->date_archive_builder = $date_archive_builder;

[144] Fix | Delete

$this->system_page_builder = $system_page_builder;

[145] Fix | Delete

$this->hierarchy_builder = $hierarchy_builder;

[146] Fix | Delete

$this->primary_term_builder = $primary_term_builder;

[147] Fix | Delete

$this->indexable_helper = $indexable_helper;

[148] Fix | Delete

$this->version_manager = $version_manager;

[149] Fix | Delete

$this->link_builder = $link_builder;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Sets the indexable repository. Done to avoid circular dependencies.

[154] Fix | Delete

[155] Fix | Delete

* @required

[156] Fix | Delete

[157] Fix | Delete

* @param Indexable_Repository $indexable_repository The indexable repository.

[158] Fix | Delete

[159] Fix | Delete

* @return void

[160] Fix | Delete

[161] Fix | Delete

public function set_indexable_repository( Indexable_Repository $indexable_repository ) {

[162] Fix | Delete

$this->indexable_repository = $indexable_repository;

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Creates a clean copy of an Indexable to allow for later database operations.

[167] Fix | Delete

[168] Fix | Delete

* @param Indexable $indexable The Indexable to copy.

[169] Fix | Delete

[170] Fix | Delete

* @return bool|Indexable

[171] Fix | Delete

[172] Fix | Delete

protected function deep_copy_indexable( $indexable ) {

[173] Fix | Delete

return $this->indexable_repository

[174] Fix | Delete

->query()

[175] Fix | Delete

->create( $indexable->as_array() );

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* Creates an indexable by its ID and type.

[180] Fix | Delete

[181] Fix | Delete

* @param int $object_id The indexable object ID.

[182] Fix | Delete

* @param string $object_type The indexable object type.

[183] Fix | Delete

* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.

[184] Fix | Delete

[185] Fix | Delete

* @return bool|Indexable Instance of indexable. False when unable to build.

[186] Fix | Delete

[187] Fix | Delete

public function build_for_id_and_type( $object_id, $object_type, $indexable = false ) {

[188] Fix | Delete

$defaults = [

[189] Fix | Delete

'object_type' => $object_type,

[190] Fix | Delete

'object_id' => $object_id,

[191] Fix | Delete

];

[192] Fix | Delete

[193] Fix | Delete

$indexable = $this->build( $indexable, $defaults );

[194] Fix | Delete

[195] Fix | Delete

return $indexable;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

/**

[199] Fix | Delete

* Creates an indexable for the homepage.

[200] Fix | Delete

[201] Fix | Delete

* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.

[202] Fix | Delete

[203] Fix | Delete

* @return Indexable The home page indexable.

[204] Fix | Delete

[205] Fix | Delete

public function build_for_home_page( $indexable = false ) {

[206] Fix | Delete

return $this->build( $indexable, [ 'object_type' => 'home-page' ] );

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

/**

[210] Fix | Delete

* Creates an indexable for the date archive.

[211] Fix | Delete

[212] Fix | Delete

* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.

[213] Fix | Delete

[214] Fix | Delete

* @return Indexable The date archive indexable.

[215] Fix | Delete

[216] Fix | Delete

public function build_for_date_archive( $indexable = false ) {

[217] Fix | Delete

return $this->build( $indexable, [ 'object_type' => 'date-archive' ] );

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Creates an indexable for a post type archive.

[222] Fix | Delete

[223] Fix | Delete

* @param string $post_type The post type.

[224] Fix | Delete

* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.

[225] Fix | Delete

[226] Fix | Delete

* @return Indexable The post type archive indexable.

[227] Fix | Delete

[228] Fix | Delete

public function build_for_post_type_archive( $post_type, $indexable = false ) {

[229] Fix | Delete

$defaults = [

[230] Fix | Delete

'object_type' => 'post-type-archive',

[231] Fix | Delete

'object_sub_type' => $post_type,

[232] Fix | Delete

];

[233] Fix | Delete

return $this->build( $indexable, $defaults );

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

/**

[237] Fix | Delete

* Creates an indexable for a system page.

[238] Fix | Delete

[239] Fix | Delete

* @param string $page_type The type of system page.

[240] Fix | Delete

* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.

[241] Fix | Delete

[242] Fix | Delete

* @return Indexable The search result indexable.

[243] Fix | Delete

[244] Fix | Delete

public function build_for_system_page( $page_type, $indexable = false ) {

[245] Fix | Delete

$defaults = [

[246] Fix | Delete

'object_type' => 'system-page',

[247] Fix | Delete

'object_sub_type' => $page_type,

[248] Fix | Delete

];

[249] Fix | Delete

return $this->build( $indexable, $defaults );

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* Ensures we have a valid indexable. Creates one if false is passed.

[254] Fix | Delete

[255] Fix | Delete

* @param Indexable|false $indexable The indexable.

[256] Fix | Delete

* @param array $defaults The initial properties of the Indexable.

[257] Fix | Delete

[258] Fix | Delete

* @return Indexable The indexable.

[259] Fix | Delete

[260] Fix | Delete

protected function ensure_indexable( $indexable, $defaults = [] ) {

[261] Fix | Delete

if ( ! $indexable ) {

[262] Fix | Delete

return $this->indexable_repository->query()->create( $defaults );

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

return $indexable;

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

/**

[269] Fix | Delete

* Build and author indexable from an author id if it does not exist yet, or if the author indexable needs to be upgraded.

[270] Fix | Delete

[271] Fix | Delete

* @param int $author_id The author id.

[272] Fix | Delete

[273] Fix | Delete

* @return Indexable|false The author indexable if it has been built, `false` if it could not be built.

[274] Fix | Delete

[275] Fix | Delete

protected function maybe_build_author_indexable( $author_id ) {

[276] Fix | Delete

$author_indexable = $this->indexable_repository->find_by_id_and_type(

[277] Fix | Delete

$author_id,

[278] Fix | Delete

'user',

[279] Fix | Delete

false

[280] Fix | Delete

);

[281] Fix | Delete

if ( ! $author_indexable || $this->version_manager->indexable_needs_upgrade( $author_indexable ) ) {

[282] Fix | Delete

// Try to build the author.

[283] Fix | Delete

$author_defaults = [

[284] Fix | Delete

'object_type' => 'user',

[285] Fix | Delete

'object_id' => $author_id,

[286] Fix | Delete

];

[287] Fix | Delete

$author_indexable = $this->build( $author_indexable, $author_defaults );

[288] Fix | Delete

}

[289] Fix | Delete

return $author_indexable;

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* Checks if the indexable type is one that is not supposed to have object ID for.

[294] Fix | Delete

[295] Fix | Delete

* @param string $type The type of the indexable.

[296] Fix | Delete

[297] Fix | Delete

* @return bool Whether the indexable type is one that is not supposed to have object ID for.

[298] Fix | Delete

[299] Fix | Delete

protected function is_type_with_no_id( $type ) {

[300] Fix | Delete

return \in_array( $type, [ 'home-page', 'date-archive', 'post-type-archive', 'system-page' ], true );

[301] Fix | Delete

}

[302] Fix | Delete

[303] Fix | Delete

// phpcs:disable Squiz.Commenting.FunctionCommentThrowTag.Missing -- Exceptions are handled by the catch statement in the method.

[304] Fix | Delete

[305] Fix | Delete

/**

[306] Fix | Delete

* Rebuilds an Indexable from scratch.

[307] Fix | Delete

[308] Fix | Delete

* @param Indexable $indexable The Indexable to (re)build.

[309] Fix | Delete

* @param array|null $defaults The object type of the Indexable.

[310] Fix | Delete

[311] Fix | Delete

* @return Indexable|false The resulting Indexable.

[312] Fix | Delete

[313] Fix | Delete

public function build( $indexable, $defaults = null ) {

[314] Fix | Delete

// Backup the previous Indexable, if there was one.

[315] Fix | Delete

$indexable_before = ( $indexable ) ? $this->deep_copy_indexable( $indexable ) : null;

[316] Fix | Delete

[317] Fix | Delete

// Make sure we have an Indexable to work with.

[318] Fix | Delete

$indexable = $this->ensure_indexable( $indexable, $defaults );

[319] Fix | Delete

[320] Fix | Delete

try {

[321] Fix | Delete

if ( $indexable->object_id === 0 ) {

[322] Fix | Delete

throw Not_Built_Exception::invalid_object_id( $indexable->object_id );

[323] Fix | Delete

}

[324] Fix | Delete

switch ( $indexable->object_type ) {

[325] Fix | Delete

[326] Fix | Delete

case 'post':

[327] Fix | Delete

$indexable = $this->post_builder->build( $indexable->object_id, $indexable );

[328] Fix | Delete

[329] Fix | Delete

// Save indexable, to make sure it can be queried when building related objects like the author indexable and hierarchy.

[330] Fix | Delete

$indexable = $this->indexable_helper->save_indexable( $indexable, $indexable_before );

[331] Fix | Delete

[332] Fix | Delete

// For attachments, we have to make sure to patch any potentially previously cleaned up SEO links.

[333] Fix | Delete

if ( \is_a( $indexable, Indexable::class ) && $indexable->object_sub_type === 'attachment' ) {

[334] Fix | Delete

$this->link_builder->patch_seo_links( $indexable );

[335] Fix | Delete

}

[336] Fix | Delete

[337] Fix | Delete

// Always rebuild the primary term.

[338] Fix | Delete

$this->primary_term_builder->build( $indexable->object_id );

[339] Fix | Delete

[340] Fix | Delete

// Always rebuild the hierarchy; this needs the primary term to run correctly.

[341] Fix | Delete

$this->hierarchy_builder->build( $indexable );

[342] Fix | Delete

[343] Fix | Delete

$this->maybe_build_author_indexable( $indexable->author_id );

[344] Fix | Delete

[345] Fix | Delete

// The indexable is already saved, so return early.

[346] Fix | Delete

return $indexable;

[347] Fix | Delete

[348] Fix | Delete

case 'user':

[349] Fix | Delete

$indexable = $this->author_builder->build( $indexable->object_id, $indexable );

[350] Fix | Delete

break;

[351] Fix | Delete

[352] Fix | Delete

case 'term':

[353] Fix | Delete

$indexable = $this->term_builder->build( $indexable->object_id, $indexable );

[354] Fix | Delete

[355] Fix | Delete

// Save indexable, to make sure it can be queried when building hierarchy.

[356] Fix | Delete

$indexable = $this->indexable_helper->save_indexable( $indexable, $indexable_before );

[357] Fix | Delete

[358] Fix | Delete

$this->hierarchy_builder->build( $indexable );

[359] Fix | Delete

[360] Fix | Delete

// The indexable is already saved, so return early.

[361] Fix | Delete

return $indexable;

[362] Fix | Delete

[363] Fix | Delete

case 'home-page':

[364] Fix | Delete

$indexable = $this->home_page_builder->build( $indexable );

[365] Fix | Delete

break;

[366] Fix | Delete

[367] Fix | Delete

case 'date-archive':

[368] Fix | Delete

$indexable = $this->date_archive_builder->build( $indexable );

[369] Fix | Delete

break;

[370] Fix | Delete

[371] Fix | Delete

case 'post-type-archive':

[372] Fix | Delete

$indexable = $this->post_type_archive_builder->build( $indexable->object_sub_type, $indexable );

[373] Fix | Delete

break;

[374] Fix | Delete

[375] Fix | Delete

case 'system-page':

[376] Fix | Delete

$indexable = $this->system_page_builder->build( $indexable->object_sub_type, $indexable );

[377] Fix | Delete

break;

[378] Fix | Delete

}

[379] Fix | Delete

[380] Fix | Delete

return $this->indexable_helper->save_indexable( $indexable, $indexable_before );

[381] Fix | Delete

}

[382] Fix | Delete

catch ( Source_Exception $exception ) {

[383] Fix | Delete

if ( ! $this->is_type_with_no_id( $indexable->object_type ) && ( ! isset( $indexable->object_id ) || \is_null( $indexable->object_id ) ) ) {

[384] Fix | Delete

return false;

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

/**

[388] Fix | Delete

* The current indexable could not be indexed. Create a placeholder indexable, so we can

[389] Fix | Delete

* skip this indexable in future indexing runs.

[390] Fix | Delete

[391] Fix | Delete

* @var Indexable $indexable

[392] Fix | Delete

[393] Fix | Delete

$indexable = $this->ensure_indexable(

[394] Fix | Delete

$indexable,

[395] Fix | Delete

[

[396] Fix | Delete

'object_id' => $indexable->object_id,

[397] Fix | Delete

'object_type' => $indexable->object_type,

[398] Fix | Delete

'post_status' => 'unindexed',

[399] Fix | Delete

'version' => 0,

[400] Fix | Delete

]

[401] Fix | Delete

);

[402] Fix | Delete

// If we already had an existing indexable, mark it as unindexed. We cannot rely on its validity anymore.

[403] Fix | Delete

$indexable->post_status = 'unindexed';

[404] Fix | Delete

// Make sure that the indexing process doesn't get stuck in a loop on this broken indexable.

[405] Fix | Delete

$indexable = $this->version_manager->set_latest( $indexable );

[406] Fix | Delete

[407] Fix | Delete

return $this->indexable_helper->save_indexable( $indexable, $indexable_before );

[408] Fix | Delete

}

[409] Fix | Delete

catch ( Not_Built_Exception $exception ) {

[410] Fix | Delete

return false;

[411] Fix | Delete

}

[412] Fix | Delete

}

[413] Fix | Delete

[414] Fix | Delete

// phpcs:enable

[415] Fix | Delete

}

[416] Fix | Delete

[417] Fix | Delete