Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Helpers\Schema;

[2] Fix | Delete

[3] Fix | Delete

use Closure;

[4] Fix | Delete

use WPSEO_Replace_Vars;

[5] Fix | Delete

use Yoast\WP\SEO\Conditionals\No_Conditionals;

[6] Fix | Delete

use Yoast\WP\SEO\Config\Schema_IDs;

[7] Fix | Delete

use Yoast\WP\SEO\Context\Meta_Tags_Context;

[8] Fix | Delete

use Yoast\WP\SEO\Helpers\Date_Helper;

[9] Fix | Delete

use Yoast\WP\SEO\Presentations\Indexable_Presentation;

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Registers the Schema replace variables and exposes a method to replace variables on a Schema graph.

[13] Fix | Delete

[14] Fix | Delete

class Replace_Vars_Helper {

[15] Fix | Delete

[16] Fix | Delete

use No_Conditionals;

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* The replace vars.

[20] Fix | Delete

[21] Fix | Delete

* @var WPSEO_Replace_Vars

[22] Fix | Delete

[23] Fix | Delete

protected $replace_vars;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* The Schema ID helper.

[27] Fix | Delete

[28] Fix | Delete

* @var ID_Helper

[29] Fix | Delete

[30] Fix | Delete

protected $id_helper;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* The date helper.

[34] Fix | Delete

[35] Fix | Delete

* @var Date_Helper

[36] Fix | Delete

[37] Fix | Delete

protected $date_helper;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Replace_Vars_Helper constructor.

[41] Fix | Delete

[42] Fix | Delete

* @param WPSEO_Replace_Vars $replace_vars The replace vars.

[43] Fix | Delete

* @param ID_Helper $id_helper The Schema ID helper.

[44] Fix | Delete

* @param Date_Helper $date_helper The date helper.

[45] Fix | Delete

[46] Fix | Delete

public function __construct(

[47] Fix | Delete

WPSEO_Replace_Vars $replace_vars,

[48] Fix | Delete

ID_Helper $id_helper,

[49] Fix | Delete

Date_Helper $date_helper

[50] Fix | Delete

) {

[51] Fix | Delete

$this->replace_vars = $replace_vars;

[52] Fix | Delete

$this->id_helper = $id_helper;

[53] Fix | Delete

$this->date_helper = $date_helper;

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Replaces the variables.

[58] Fix | Delete

[59] Fix | Delete

* @param array $schema_data The Schema data.

[60] Fix | Delete

* @param Indexable_Presentation $presentation The indexable presentation.

[61] Fix | Delete

[62] Fix | Delete

* @return array The array with replaced vars.

[63] Fix | Delete

[64] Fix | Delete

public function replace( array $schema_data, Indexable_Presentation $presentation ) {

[65] Fix | Delete

foreach ( $schema_data as $key => $value ) {

[66] Fix | Delete

if ( \is_array( $value ) ) {

[67] Fix | Delete

$schema_data[ $key ] = $this->replace( $value, $presentation );

[68] Fix | Delete

[69] Fix | Delete

continue;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

$schema_data[ $key ] = $this->replace_vars->replace( $value, $presentation->source );

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

return $schema_data;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Registers the Schema-related replace vars.

[80] Fix | Delete

[81] Fix | Delete

* @param Meta_Tags_Context $context The meta tags context.

[82] Fix | Delete

[83] Fix | Delete

* @return void

[84] Fix | Delete

[85] Fix | Delete

public function register_replace_vars( $context ) {

[86] Fix | Delete

$replace_vars = [

[87] Fix | Delete

'main_schema_id' => $context->main_schema_id,

[88] Fix | Delete

'author_id' => $this->id_helper->get_user_schema_id( $context->indexable->author_id, $context ),

[89] Fix | Delete

'person_id' => $context->site_url . Schema_IDs::PERSON_HASH,

[90] Fix | Delete

'primary_image_id' => $context->canonical . Schema_IDs::PRIMARY_IMAGE_HASH,

[91] Fix | Delete

'webpage_id' => $context->main_schema_id,

[92] Fix | Delete

'website_id' => $context->site_url . Schema_IDs::WEBSITE_HASH,

[93] Fix | Delete

'organization_id' => $context->site_url . Schema_IDs::ORGANIZATION_HASH,

[94] Fix | Delete

];

[95] Fix | Delete

[96] Fix | Delete

if ( $context->post ) {

[97] Fix | Delete

// Post does not always exist, e.g. on term pages.

[98] Fix | Delete

$replace_vars['post_date'] = $this->date_helper->format( $context->post->post_date, \DATE_ATOM );

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

foreach ( $replace_vars as $var => $value ) {

[102] Fix | Delete

$this->register_replacement( $var, $value );

[103] Fix | Delete

}

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Registers a replace var and its value.

[108] Fix | Delete

[109] Fix | Delete

* @param string $variable The replace variable.

[110] Fix | Delete

* @param string $value The value that the variable should be replaced with.

[111] Fix | Delete

[112] Fix | Delete

* @return void

[113] Fix | Delete

[114] Fix | Delete

protected function register_replacement( $variable, $value ) {

[115] Fix | Delete

$this->replace_vars->safe_register_replacement(

[116] Fix | Delete

$variable,

[117] Fix | Delete

$this->get_identity_function( $value )

[118] Fix | Delete

);

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/**

[122] Fix | Delete

* Returns an anonymous function that in turn just returns the given value.

[123] Fix | Delete

[124] Fix | Delete

* @param mixed $value The value that the function should return.

[125] Fix | Delete

[126] Fix | Delete

* @return Closure A function that returns the given value.

[127] Fix | Delete

[128] Fix | Delete

protected function get_identity_function( $value ) {

[129] Fix | Delete

return static function () use ( $value ) {

[130] Fix | Delete

return $value;

[131] Fix | Delete

};

[132] Fix | Delete

}

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete