<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Surfaces;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Exceptions\Forbidden_Property_Mutation_Exception;

[4] Fix | Delete

use Yoast\WP\SEO\Helpers;

[5] Fix | Delete

use YoastSEO_Vendor\Symfony\Component\DependencyInjection\ContainerInterface;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Class Helpers_Surface.

[9] Fix | Delete

*

[10] Fix | Delete

* Surface for the indexables.

[11] Fix | Delete

*

[12] Fix | Delete

* @property Helpers\Asset_Helper $asset

[13] Fix | Delete

* @property Helpers\Author_Archive_Helper $author_archive

[14] Fix | Delete

* @property Helpers\Blocks_Helper $blocks

[15] Fix | Delete

* @property Helpers\Capability_Helper $capability

[16] Fix | Delete

* @property Helpers\Current_Page_Helper $current_page

[17] Fix | Delete

* @property Helpers\Date_Helper $date

[18] Fix | Delete

* @property Helpers\Environment_Helper $environment

[19] Fix | Delete

* @property Helpers\First_Time_Configuration_Notice_Helper $first_time_configuration_notice

[20] Fix | Delete

* @property Helpers\Home_Url_Helper $home_url

[21] Fix | Delete

* @property Helpers\Image_Helper $image

[22] Fix | Delete

* @property Helpers\Indexable_Helper $indexable

[23] Fix | Delete

* @property Helpers\Indexing_Helper $indexing

[24] Fix | Delete

* @property Helpers\Input_Helper $input

[25] Fix | Delete

* @property Helpers\Language_Helper $language

[26] Fix | Delete

* @property Helpers\Meta_Helper $meta

[27] Fix | Delete

* @property Helpers\Notification_Helper $notification

[28] Fix | Delete

* @property Helpers\Options_Helper $options

[29] Fix | Delete

* @property Helpers\Pagination_Helper $pagination

[30] Fix | Delete

* @property Helpers\Permalink_Helper $permalink

[31] Fix | Delete

* @property Helpers\Post_Helper $post

[32] Fix | Delete

* @property Helpers\Post_Type_Helper $post_type

[33] Fix | Delete

* @property Helpers\Primary_Term_Helper $primary_term

[34] Fix | Delete

* @property Helpers\Product_Helper $product

[35] Fix | Delete

* @property Helpers\Redirect_Helper $redirect

[36] Fix | Delete

* @property Helpers\Request_Helper $request

[37] Fix | Delete

* @property Helpers\Require_File_Helper $require_file

[38] Fix | Delete

* @property Helpers\Robots_Helper $robots

[39] Fix | Delete

* @property Helpers\Short_Link_Helper $short_link

[40] Fix | Delete

* @property Helpers\Site_Helper $site

[41] Fix | Delete

* @property Helpers\String_Helper $string

[42] Fix | Delete

* @property Helpers\Social_Profiles_Helper $social_profiles

[43] Fix | Delete

* @property Helpers\Taxonomy_Helper $taxonomy

[44] Fix | Delete

* @property Helpers\Url_Helper $url

[45] Fix | Delete

* @property Helpers\User_Helper $user

[46] Fix | Delete

* @property Helpers\Woocommerce_Helper $woocommerce

[47] Fix | Delete

* @property Helpers\Wordpress_Helper $wordpress

[48] Fix | Delete

*/

[49] Fix | Delete

class Helpers_Surface {

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* The DI container.

[53] Fix | Delete

*

[54] Fix | Delete

* @var ContainerInterface

[55] Fix | Delete

*/

[56] Fix | Delete

private $container;

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* The open_graph helper namespace

[60] Fix | Delete

*

[61] Fix | Delete

* @var Open_Graph_Helpers_Surface

[62] Fix | Delete

*/

[63] Fix | Delete

public $open_graph;

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* The schema helper namespace

[67] Fix | Delete

*

[68] Fix | Delete

* @var Schema_Helpers_Surface

[69] Fix | Delete

*/

[70] Fix | Delete

public $schema;

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* The twitter helper namespace

[74] Fix | Delete

*

[75] Fix | Delete

* @var Twitter_Helpers_Surface

[76] Fix | Delete

*/

[77] Fix | Delete

public $twitter;

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Loader constructor.

[81] Fix | Delete

*

[82] Fix | Delete

* @param ContainerInterface $container The dependency injection container.

[83] Fix | Delete

* @param Open_Graph_Helpers_Surface $open_graph The OpenGraph helpers surface.

[84] Fix | Delete

* @param Schema_Helpers_Surface $schema The Schema helpers surface.

[85] Fix | Delete

* @param Twitter_Helpers_Surface $twitter The Twitter helpers surface.

[86] Fix | Delete

*/

[87] Fix | Delete

public function __construct(

[88] Fix | Delete

ContainerInterface $container,

[89] Fix | Delete

Open_Graph_Helpers_Surface $open_graph,

[90] Fix | Delete

Schema_Helpers_Surface $schema,

[91] Fix | Delete

Twitter_Helpers_Surface $twitter

[92] Fix | Delete

) {

[93] Fix | Delete

$this->container = $container;

[94] Fix | Delete

$this->open_graph = $open_graph;

[95] Fix | Delete

$this->schema = $schema;

[96] Fix | Delete

$this->twitter = $twitter;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Magic getter for getting helper classes.

[101] Fix | Delete

*

[102] Fix | Delete

* @param string $helper The helper to get.

[103] Fix | Delete

*

[104] Fix | Delete

* @return mixed The helper class.

[105] Fix | Delete

*/

[106] Fix | Delete

public function __get( $helper ) {

[107] Fix | Delete

return $this->container->get( $this->get_helper_class( $helper ) );

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Magic isset for ensuring helper exists.

[112] Fix | Delete

*

[113] Fix | Delete

* @param string $helper The helper to get.

[114] Fix | Delete

*

[115] Fix | Delete

* @return bool Whether the helper exists.

[116] Fix | Delete

*/

[117] Fix | Delete

public function __isset( $helper ) {

[118] Fix | Delete

return $this->container->has( $this->get_helper_class( $helper ) );

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/**

[122] Fix | Delete

* Prevents setting 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

* @param mixed $value The property value.

[127] Fix | Delete

*

[128] Fix | Delete

* @return void

[129] Fix | Delete

*

[130] Fix | Delete

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

[131] Fix | Delete

*/

[132] Fix | Delete

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

[133] Fix | Delete

throw Forbidden_Property_Mutation_Exception::cannot_set_because_property_is_immutable( $name );

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Prevents unsetting dynamic properties and unsetting declared properties

[138] Fix | Delete

* from an inaccessible context.

[139] Fix | Delete

*

[140] Fix | Delete

* @param string $name The property name.

[141] Fix | Delete

*

[142] Fix | Delete

* @return void

[143] Fix | Delete

*

[144] Fix | Delete

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

[145] Fix | Delete

*/

[146] Fix | Delete

public function __unset( $name ) {

[147] Fix | Delete

throw Forbidden_Property_Mutation_Exception::cannot_unset_because_property_is_immutable( $name );

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Get the class name from a helper slug

[152] Fix | Delete

*

[153] Fix | Delete

* @param string $helper The name of the helper.

[154] Fix | Delete

*

[155] Fix | Delete

* @return string

[156] Fix | Delete

*/

[157] Fix | Delete

protected function get_helper_class( $helper ) {

[158] Fix | Delete

$helper = \implode( '_', \array_map( 'ucfirst', \explode( '_', $helper ) ) );

[159] Fix | Delete

[160] Fix | Delete

return "Yoast\WP\SEO\Helpers\\{$helper}_Helper";

[161] Fix | Delete

}

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete