Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Presenters;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Helpers\Robots_Txt_Helper;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Presenter class for the robots.txt file helper.

[7] Fix | Delete

[8] Fix | Delete

class Robots_Txt_Presenter extends Abstract_Presenter {

[9] Fix | Delete

[10] Fix | Delete

public const YOAST_OUTPUT_BEFORE_COMMENT = '# START YOAST BLOCK' . \PHP_EOL . '# ---------------------------' . \PHP_EOL;

[11] Fix | Delete

[12] Fix | Delete

public const YOAST_OUTPUT_AFTER_COMMENT = '# ---------------------------' . \PHP_EOL . '# END YOAST BLOCK';

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Text to be outputted for the allow directive.

[16] Fix | Delete

[17] Fix | Delete

* @var string

[18] Fix | Delete

[19] Fix | Delete

public const ALLOW_DIRECTIVE = 'Allow';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Text to be outputted for the disallow directive.

[23] Fix | Delete

[24] Fix | Delete

* @var string

[25] Fix | Delete

[26] Fix | Delete

public const DISALLOW_DIRECTIVE = 'Disallow';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Text to be outputted for the user-agent rule.

[30] Fix | Delete

[31] Fix | Delete

* @var string

[32] Fix | Delete

[33] Fix | Delete

public const USER_AGENT_FIELD = 'User-agent';

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Text to be outputted for the sitemap rule.

[37] Fix | Delete

[38] Fix | Delete

* @var string

[39] Fix | Delete

[40] Fix | Delete

public const SITEMAP_FIELD = 'Sitemap';

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Holds the Robots_Txt_Helper.

[44] Fix | Delete

[45] Fix | Delete

* @var Robots_Txt_Helper

[46] Fix | Delete

[47] Fix | Delete

protected $robots_txt_helper;

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Constructor.

[51] Fix | Delete

[52] Fix | Delete

* @param Robots_Txt_Helper $robots_txt_helper The robots txt helper.

[53] Fix | Delete

[54] Fix | Delete

public function __construct( Robots_Txt_Helper $robots_txt_helper ) {

[55] Fix | Delete

$this->robots_txt_helper = $robots_txt_helper;

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Generate content to be placed in a robots.txt file.

[60] Fix | Delete

[61] Fix | Delete

* @return string Content to be placed in a robots.txt file.

[62] Fix | Delete

[63] Fix | Delete

public function present() {

[64] Fix | Delete

$robots_txt_content = self::YOAST_OUTPUT_BEFORE_COMMENT;

[65] Fix | Delete

$robots_txt_content = $this->handle_user_agents( $robots_txt_content );

[66] Fix | Delete

[67] Fix | Delete

$robots_txt_content = $this->handle_site_maps( $robots_txt_content );

[68] Fix | Delete

[69] Fix | Delete

return $robots_txt_content . self::YOAST_OUTPUT_AFTER_COMMENT;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Adds user agent directives to the robots txt output string.

[74] Fix | Delete

[75] Fix | Delete

* @param array $user_agents The list if available user agents.

[76] Fix | Delete

* @param string $robots_txt_content The current working robots txt string.

[77] Fix | Delete

[78] Fix | Delete

* @return string

[79] Fix | Delete

[80] Fix | Delete

private function add_user_agent_directives( $user_agents, $robots_txt_content ) {

[81] Fix | Delete

foreach ( $user_agents as $user_agent ) {

[82] Fix | Delete

$robots_txt_content .= self::USER_AGENT_FIELD . ': ' . $user_agent->get_user_agent() . \PHP_EOL;

[83] Fix | Delete

[84] Fix | Delete

$robots_txt_content = $this->add_directive_path( $robots_txt_content, $user_agent->get_disallow_paths(), self::DISALLOW_DIRECTIVE );

[85] Fix | Delete

$robots_txt_content = $this->add_directive_path( $robots_txt_content, $user_agent->get_allow_paths(), self::ALLOW_DIRECTIVE );

[86] Fix | Delete

[87] Fix | Delete

$robots_txt_content .= \PHP_EOL;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

return $robots_txt_content;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Adds user agent directives path content to the robots txt output string.

[95] Fix | Delete

[96] Fix | Delete

* @param string $robots_txt_content The current working robots txt string.

[97] Fix | Delete

* @param array $paths The list of paths for which to add a txt entry.

[98] Fix | Delete

* @param string $directive_identifier The identifier for the directives. (Disallow of Allow).

[99] Fix | Delete

[100] Fix | Delete

* @return string

[101] Fix | Delete

[102] Fix | Delete

private function add_directive_path( $robots_txt_content, $paths, $directive_identifier ) {

[103] Fix | Delete

if ( \count( $paths ) > 0 ) {

[104] Fix | Delete

foreach ( $paths as $path ) {

[105] Fix | Delete

$robots_txt_content .= $directive_identifier . ': ' . $path . \PHP_EOL;

[106] Fix | Delete

}

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

return $robots_txt_content;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

/**

[113] Fix | Delete

* Handles adding user agent content to the robots txt content if there is any.

[114] Fix | Delete

[115] Fix | Delete

* @param string $robots_txt_content The current working robots txt string.

[116] Fix | Delete

[117] Fix | Delete

* @return string

[118] Fix | Delete

[119] Fix | Delete

private function handle_user_agents( $robots_txt_content ) {

[120] Fix | Delete

$user_agents = $this->robots_txt_helper->get_robots_txt_user_agents();

[121] Fix | Delete

[122] Fix | Delete

if ( ! isset( $user_agents['*'] ) ) {

[123] Fix | Delete

$robots_txt_content .= 'User-agent: *' . \PHP_EOL;

[124] Fix | Delete

$robots_txt_content .= 'Disallow:' . \PHP_EOL . \PHP_EOL;

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

$robots_txt_content = $this->add_user_agent_directives( $user_agents, $robots_txt_content );

[128] Fix | Delete

[129] Fix | Delete

return $robots_txt_content;

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Handles adding sitemap content to the robots txt content.

[134] Fix | Delete

[135] Fix | Delete

* @param string $robots_txt_content The current working robots txt string.

[136] Fix | Delete

[137] Fix | Delete

* @return string

[138] Fix | Delete

[139] Fix | Delete

private function handle_site_maps( $robots_txt_content ) {

[140] Fix | Delete

$registered_sitemaps = $this->robots_txt_helper->get_sitemap_rules();

[141] Fix | Delete

[142] Fix | Delete

foreach ( $registered_sitemaps as $sitemap ) {

[143] Fix | Delete

$robots_txt_content .= self::SITEMAP_FIELD . ': ' . $sitemap . \PHP_EOL;

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

return $robots_txt_content;

[147] Fix | Delete

}

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete