<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\Lib;

[2] Fix | Delete

[3] Fix | Delete

use Exception;

[4] Fix | Delete

use WPSEO_Utils;

[5] Fix | Delete

use Yoast\WP\Lib\Dependency_Injection\Container_Registry;

[6] Fix | Delete

use Yoast\WP\SEO\Exceptions\Forbidden_Property_Mutation_Exception;

[7] Fix | Delete

use Yoast\WP\SEO\Loader;

[8] Fix | Delete

use YoastSEO_Vendor\Symfony\Component\DependencyInjection\ContainerInterface;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Abstract class to extend for the main class in a plugin.

[12] Fix | Delete

*/

[13] Fix | Delete

abstract class Abstract_Main {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* The DI container.

[17] Fix | Delete

*

[18] Fix | Delete

* @var ContainerInterface|null

[19] Fix | Delete

*/

[20] Fix | Delete

protected $container;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* A cache for previously requested and constructed surfaces.

[24] Fix | Delete

*

[25] Fix | Delete

* @var mixed[]

[26] Fix | Delete

*/

[27] Fix | Delete

private $cached_surfaces = [];

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Loads the plugin.

[31] Fix | Delete

*

[32] Fix | Delete

* @return void

[33] Fix | Delete

*

[34] Fix | Delete

* @throws Exception If loading fails and YOAST_ENVIRONMENT is development.

[35] Fix | Delete

*/

[36] Fix | Delete

public function load() {

[37] Fix | Delete

if ( $this->container ) {

[38] Fix | Delete

return;

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

try {

[42] Fix | Delete

$this->container = $this->get_container();

[43] Fix | Delete

Container_Registry::register( $this->get_name(), $this->container );

[44] Fix | Delete

[45] Fix | Delete

if ( ! $this->container ) {

[46] Fix | Delete

return;

[47] Fix | Delete

}

[48] Fix | Delete

if ( ! $this->container->has( Loader::class ) ) {

[49] Fix | Delete

return;

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

$this->container->get( Loader::class )->load();

[53] Fix | Delete

} catch ( Exception $e ) {

[54] Fix | Delete

if ( $this->is_development() ) {

[55] Fix | Delete

throw $e;

[56] Fix | Delete

}

[57] Fix | Delete

// Don't crash the entire site, simply don't load.

[58] Fix | Delete

}

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Magic getter for retrieving a property from a surface.

[63] Fix | Delete

*

[64] Fix | Delete

* @param string $property The property to retrieve.

[65] Fix | Delete

*

[66] Fix | Delete

* @return mixed The value of the property.

[67] Fix | Delete

*

[68] Fix | Delete

* @throws Exception When the property doesn't exist.

[69] Fix | Delete

*/

[70] Fix | Delete

public function __get( $property ) {

[71] Fix | Delete

if ( \array_key_exists( $property, $this->cached_surfaces ) ) {

[72] Fix | Delete

return $this->cached_surfaces[ $property ];

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

$surfaces = $this->get_surfaces();

[76] Fix | Delete

[77] Fix | Delete

if ( isset( $surfaces[ $property ] ) ) {

[78] Fix | Delete

$this->cached_surfaces[ $property ] = $this->container->get( $surfaces[ $property ] );

[79] Fix | Delete

[80] Fix | Delete

return $this->cached_surfaces[ $property ];

[81] Fix | Delete

}

[82] Fix | Delete

throw new Exception( \sprintf( 'Property $%s does not exist.', $property ) );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Checks if the given property exists as a surface.

[87] Fix | Delete

*

[88] Fix | Delete

* @param string $property The property to retrieve.

[89] Fix | Delete

*

[90] Fix | Delete

* @return bool True when property is set.

[91] Fix | Delete

*/

[92] Fix | Delete

public function __isset( $property ) {

[93] Fix | Delete

if ( \array_key_exists( $property, $this->cached_surfaces ) ) {

[94] Fix | Delete

return true;

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

$surfaces = $this->get_surfaces();

[98] Fix | Delete

[99] Fix | Delete

if ( ! isset( $surfaces[ $property ] ) ) {

[100] Fix | Delete

return false;

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

return $this->container->has( $surfaces[ $property ] );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Prevents setting dynamic properties and unsetting declared properties

[108] Fix | Delete

* from an inaccessible context.

[109] Fix | Delete

*

[110] Fix | Delete

* @param string $name The property name.

[111] Fix | Delete

* @param mixed $value The property value.

[112] Fix | Delete

*

[113] Fix | Delete

* @return void

[114] Fix | Delete

*

[115] Fix | Delete

* @throws Forbidden_Property_Mutation_Exception Set is never meant to be called.

[116] Fix | Delete

*/

[117] Fix | Delete

public function __set( $name, $value ) { // @phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- __set must have a name and value - PHPCS #3715.

[118] Fix | Delete

throw Forbidden_Property_Mutation_Exception::cannot_set_because_property_is_immutable( $name );

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/**

[122] Fix | Delete

* Prevents unsetting dynamic properties and unsetting declared properties

[123] Fix | Delete

* from an inaccessible context.

[124] Fix | Delete

*

[125] Fix | Delete

* @param string $name The property name.

[126] Fix | Delete

*

[127] Fix | Delete

* @return void

[128] Fix | Delete

*

[129] Fix | Delete

* @throws Forbidden_Property_Mutation_Exception Unset is never meant to be called.

[130] Fix | Delete

*/

[131] Fix | Delete

public function __unset( $name ) {

[132] Fix | Delete

throw Forbidden_Property_Mutation_Exception::cannot_unset_because_property_is_immutable( $name );

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Loads the DI container.

[137] Fix | Delete

*

[138] Fix | Delete

* @return ContainerInterface|null The DI container.

[139] Fix | Delete

*

[140] Fix | Delete

* @throws Exception If something goes wrong generating the DI container.

[141] Fix | Delete

*/

[142] Fix | Delete

abstract protected function get_container();

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Gets the name of the plugin.

[146] Fix | Delete

*

[147] Fix | Delete

* @return string The name.

[148] Fix | Delete

*/

[149] Fix | Delete

abstract protected function get_name();

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Gets the surfaces of this plugin.

[153] Fix | Delete

*

[154] Fix | Delete

* @return array A mapping of surface name to the responsible class.

[155] Fix | Delete

*/

[156] Fix | Delete

abstract protected function get_surfaces();

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* Returns whether or not we're in an environment for Yoast development.

[160] Fix | Delete

*

[161] Fix | Delete

* @return bool Whether or not to load in development mode.

[162] Fix | Delete

*/

[163] Fix | Delete

protected function is_development() {

[164] Fix | Delete

try {

[165] Fix | Delete

return WPSEO_Utils::is_development_mode();

[166] Fix | Delete

}

[167] Fix | Delete

catch ( Exception $exception ) {

[168] Fix | Delete

// E.g. when WordPress and/or WordPress SEO are not loaded.

[169] Fix | Delete

return \defined( 'YOAST_ENVIRONMENT' ) && \YOAST_ENVIRONMENT === 'development';

[170] Fix | Delete

}

[171] Fix | Delete

}

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete