Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO;

[2] Fix | Delete

[3] Fix | Delete

use Throwable;

[4] Fix | Delete

use WP_CLI;

[5] Fix | Delete

use YoastSEO_Vendor\Symfony\Component\DependencyInjection\ContainerInterface;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Class that manages loading integrations if and only if all their conditionals are met.

[9] Fix | Delete

[10] Fix | Delete

class Loader {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* The registered integrations.

[14] Fix | Delete

[15] Fix | Delete

* @var string[]

[16] Fix | Delete

[17] Fix | Delete

protected $integrations = [];

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* The registered integrations.

[21] Fix | Delete

[22] Fix | Delete

* @var string[]

[23] Fix | Delete

[24] Fix | Delete

protected $initializers = [];

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* The registered routes.

[28] Fix | Delete

[29] Fix | Delete

* @var string[]

[30] Fix | Delete

[31] Fix | Delete

protected $routes = [];

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* The registered commands.

[35] Fix | Delete

[36] Fix | Delete

* @var string[]

[37] Fix | Delete

[38] Fix | Delete

protected $commands = [];

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* The registered migrations.

[42] Fix | Delete

[43] Fix | Delete

* @var string[]

[44] Fix | Delete

[45] Fix | Delete

protected $migrations = [];

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* The dependency injection container.

[49] Fix | Delete

[50] Fix | Delete

* @var ContainerInterface

[51] Fix | Delete

[52] Fix | Delete

protected $container;

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Loader constructor.

[56] Fix | Delete

[57] Fix | Delete

* @param ContainerInterface $container The dependency injection container.

[58] Fix | Delete

[59] Fix | Delete

public function __construct( ContainerInterface $container ) {

[60] Fix | Delete

$this->container = $container;

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Registers an integration.

[65] Fix | Delete

[66] Fix | Delete

* @param string $integration_class The class name of the integration to be loaded.

[67] Fix | Delete

[68] Fix | Delete

* @return void

[69] Fix | Delete

[70] Fix | Delete

public function register_integration( $integration_class ) {

[71] Fix | Delete

$this->integrations[] = $integration_class;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Registers an initializer.

[76] Fix | Delete

[77] Fix | Delete

* @param string $initializer_class The class name of the initializer to be loaded.

[78] Fix | Delete

[79] Fix | Delete

* @return void

[80] Fix | Delete

[81] Fix | Delete

public function register_initializer( $initializer_class ) {

[82] Fix | Delete

$this->initializers[] = $initializer_class;

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Registers a route.

[87] Fix | Delete

[88] Fix | Delete

* @param string $route_class The class name of the route to be loaded.

[89] Fix | Delete

[90] Fix | Delete

* @return void

[91] Fix | Delete

[92] Fix | Delete

public function register_route( $route_class ) {

[93] Fix | Delete

$this->routes[] = $route_class;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

/**

[97] Fix | Delete

* Registers a command.

[98] Fix | Delete

[99] Fix | Delete

* @param string $command_class The class name of the command to be loaded.

[100] Fix | Delete

[101] Fix | Delete

* @return void

[102] Fix | Delete

[103] Fix | Delete

public function register_command( $command_class ) {

[104] Fix | Delete

$this->commands[] = $command_class;

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Registers a migration.

[109] Fix | Delete

[110] Fix | Delete

* @param string $plugin The plugin the migration belongs to.

[111] Fix | Delete

* @param string $version The version of the migration.

[112] Fix | Delete

* @param string $migration_class The class name of the migration to be loaded.

[113] Fix | Delete

[114] Fix | Delete

* @return void

[115] Fix | Delete

[116] Fix | Delete

public function register_migration( $plugin, $version, $migration_class ) {

[117] Fix | Delete

if ( ! \array_key_exists( $plugin, $this->migrations ) ) {

[118] Fix | Delete

$this->migrations[ $plugin ] = [];

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

$this->migrations[ $plugin ][ $version ] = $migration_class;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Loads all registered classes if their conditionals are met.

[126] Fix | Delete

[127] Fix | Delete

* @return void

[128] Fix | Delete

[129] Fix | Delete

public function load() {

[130] Fix | Delete

$this->load_initializers();

[131] Fix | Delete

[132] Fix | Delete

if ( ! \did_action( 'init' ) ) {

[133] Fix | Delete

\add_action( 'init', [ $this, 'load_integrations' ] );

[134] Fix | Delete

}

[135] Fix | Delete

else {

[136] Fix | Delete

$this->load_integrations();

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

\add_action( 'rest_api_init', [ $this, 'load_routes' ] );

[140] Fix | Delete

[141] Fix | Delete

if ( \defined( 'WP_CLI' ) && \WP_CLI ) {

[142] Fix | Delete

$this->load_commands();

[143] Fix | Delete

}

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Returns all registered migrations.

[148] Fix | Delete

[149] Fix | Delete

* @param string $plugin The plugin to get the migrations for.

[150] Fix | Delete

[151] Fix | Delete

* @return string[]|false The registered migrations. False if no migrations were registered.

[152] Fix | Delete

[153] Fix | Delete

public function get_migrations( $plugin ) {

[154] Fix | Delete

if ( ! \array_key_exists( $plugin, $this->migrations ) ) {

[155] Fix | Delete

return false;

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

return $this->migrations[ $plugin ];

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* Loads all registered commands.

[163] Fix | Delete

[164] Fix | Delete

* @return void

[165] Fix | Delete

[166] Fix | Delete

protected function load_commands() {

[167] Fix | Delete

foreach ( $this->commands as $class ) {

[168] Fix | Delete

$command = $this->get_class( $class );

[169] Fix | Delete

[170] Fix | Delete

if ( $command === null ) {

[171] Fix | Delete

continue;

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

WP_CLI::add_command( $class::get_namespace(), $command );

[175] Fix | Delete

}

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* Loads all registered initializers if their conditionals are met.

[180] Fix | Delete

[181] Fix | Delete

* @return void

[182] Fix | Delete

[183] Fix | Delete

protected function load_initializers() {

[184] Fix | Delete

foreach ( $this->initializers as $class ) {

[185] Fix | Delete

if ( ! $this->conditionals_are_met( $class ) ) {

[186] Fix | Delete

continue;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

$initializer = $this->get_class( $class );

[190] Fix | Delete

[191] Fix | Delete

if ( $initializer === null ) {

[192] Fix | Delete

continue;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

$initializer->initialize();

[196] Fix | Delete

}

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Loads all registered integrations if their conditionals are met.

[201] Fix | Delete

[202] Fix | Delete

* @return void

[203] Fix | Delete

[204] Fix | Delete

public function load_integrations() {

[205] Fix | Delete

foreach ( $this->integrations as $class ) {

[206] Fix | Delete

if ( ! $this->conditionals_are_met( $class ) ) {

[207] Fix | Delete

continue;

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

$integration = $this->get_class( $class );

[211] Fix | Delete

[212] Fix | Delete

if ( $integration === null ) {

[213] Fix | Delete

continue;

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

$integration->register_hooks();

[217] Fix | Delete

}

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Loads all registered routes if their conditionals are met.

[222] Fix | Delete

[223] Fix | Delete

* @return void

[224] Fix | Delete

[225] Fix | Delete

public function load_routes() {

[226] Fix | Delete

foreach ( $this->routes as $class ) {

[227] Fix | Delete

if ( ! $this->conditionals_are_met( $class ) ) {

[228] Fix | Delete

continue;

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

$route = $this->get_class( $class );

[232] Fix | Delete

[233] Fix | Delete

if ( $route === null ) {

[234] Fix | Delete

continue;

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

$route->register_routes();

[238] Fix | Delete

}

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

/**

[242] Fix | Delete

* Checks if all conditionals of a given loadable are met.

[243] Fix | Delete

[244] Fix | Delete

* @param string $loadable_class The class name of the loadable.

[245] Fix | Delete

[246] Fix | Delete

* @return bool Whether all conditionals of the loadable are met.

[247] Fix | Delete

[248] Fix | Delete

protected function conditionals_are_met( $loadable_class ) {

[249] Fix | Delete

// In production environments do not fatal if the class does not exist but log and fail gracefully.

[250] Fix | Delete

if ( \YOAST_ENVIRONMENT === 'production' && ! \class_exists( $loadable_class ) ) {

[251] Fix | Delete

if ( \defined( 'WP_DEBUG' ) && \WP_DEBUG ) {

[252] Fix | Delete

// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log

[253] Fix | Delete

\error_log(

[254] Fix | Delete

\sprintf(

[255] Fix | Delete

/* translators: %1$s expands to Yoast SEO, %2$s expands to the name of the class that could not be found. */

[256] Fix | Delete

\__( '%1$s attempted to load the class %2$s but it could not be found.', 'wordpress-seo' ),

[257] Fix | Delete

'Yoast SEO',

[258] Fix | Delete

$loadable_class

[259] Fix | Delete

)

[260] Fix | Delete

);

[261] Fix | Delete

}

[262] Fix | Delete

return false;

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

$conditionals = $loadable_class::get_conditionals();

[266] Fix | Delete

foreach ( $conditionals as $class ) {

[267] Fix | Delete

$conditional = $this->get_class( $class );

[268] Fix | Delete

if ( $conditional === null || ! $conditional->is_met() ) {

[269] Fix | Delete

return false;

[270] Fix | Delete

}

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

return true;

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Gets a class from the container.

[278] Fix | Delete

[279] Fix | Delete

* @param string $class_name The class name.

[280] Fix | Delete

[281] Fix | Delete

* @return object|null The class or, in production environments, null if it does not exist.

[282] Fix | Delete

[283] Fix | Delete

* @throws Throwable If the class does not exist in development environments.

[284] Fix | Delete

[285] Fix | Delete

protected function get_class( $class_name ) {

[286] Fix | Delete

try {

[287] Fix | Delete

return $this->container->get( $class_name );

[288] Fix | Delete

} catch ( Throwable $e ) {

[289] Fix | Delete

// In production environments do not fatal if the class could not be constructed but log and fail gracefully.

[290] Fix | Delete

if ( \YOAST_ENVIRONMENT === 'production' ) {

[291] Fix | Delete

if ( \defined( 'WP_DEBUG' ) && \WP_DEBUG ) {

[292] Fix | Delete

// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log

[293] Fix | Delete

\error_log( $e->getMessage() );

[294] Fix | Delete

}

[295] Fix | Delete

return null;

[296] Fix | Delete

}

[297] Fix | Delete

throw $e;

[298] Fix | Delete

}

[299] Fix | Delete

}

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete