Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Helpers;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* A helper to determine the status of ftc and front-end related configuration.

[5] Fix | Delete

[6] Fix | Delete

class First_Time_Configuration_Notice_Helper {

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* The options' helper.

[10] Fix | Delete

[11] Fix | Delete

* @var Options_Helper

[12] Fix | Delete

[13] Fix | Delete

private $options_helper;

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* The indexing helper.

[17] Fix | Delete

[18] Fix | Delete

* @var Indexing_Helper

[19] Fix | Delete

[20] Fix | Delete

private $indexing_helper;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Whether we show the alternate mesage.

[24] Fix | Delete

[25] Fix | Delete

* @var bool

[26] Fix | Delete

[27] Fix | Delete

private $show_alternate_message;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* First_Time_Configuration_Notice_Integration constructor.

[31] Fix | Delete

[32] Fix | Delete

* @param Options_Helper $options_helper The options helper.

[33] Fix | Delete

* @param Indexing_Helper $indexing_helper The indexing helper.

[34] Fix | Delete

[35] Fix | Delete

public function __construct(

[36] Fix | Delete

Options_Helper $options_helper,

[37] Fix | Delete

Indexing_Helper $indexing_helper

[38] Fix | Delete

) {

[39] Fix | Delete

$this->options_helper = $options_helper;

[40] Fix | Delete

$this->indexing_helper = $indexing_helper;

[41] Fix | Delete

$this->show_alternate_message = false;

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Determines whether and where the "First-time SEO Configuration" admin notice should be displayed.

[46] Fix | Delete

[47] Fix | Delete

* @return bool Whether the "First-time SEO Configuration" admin notice should be displayed.

[48] Fix | Delete

[49] Fix | Delete

public function should_display_first_time_configuration_notice() {

[50] Fix | Delete

if ( ! $this->options_helper->get( 'dismiss_configuration_workout_notice', false ) === false ) {

[51] Fix | Delete

return false;

[52] Fix | Delete

}

[53] Fix | Delete

if ( ! $this->on_wpseo_admin_page_or_dashboard() ) {

[54] Fix | Delete

return false;

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

return $this->first_time_configuration_not_finished();

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Gets the first time configuration title based on the show_alternate_message boolean

[62] Fix | Delete

[63] Fix | Delete

* @return string

[64] Fix | Delete

[65] Fix | Delete

public function get_first_time_configuration_title() {

[66] Fix | Delete

return ( ! $this->show_alternate_message ) ? \__( 'First-time SEO configuration', 'wordpress-seo' ) : \__( 'SEO configuration', 'wordpress-seo' );

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Determines if the first time configuration is completely finished.

[71] Fix | Delete

[72] Fix | Delete

* @return bool

[73] Fix | Delete

[74] Fix | Delete

public function first_time_configuration_not_finished() {

[75] Fix | Delete

if ( ! $this->user_can_do_first_time_configuration() ) {

[76] Fix | Delete

return false;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

if ( $this->is_first_time_configuration_finished() ) {

[80] Fix | Delete

return false;

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

if ( $this->options_helper->get( 'first_time_install', false ) !== false ) {

[84] Fix | Delete

return ! $this->are_site_representation_name_and_logo_set() || $this->indexing_helper->get_unindexed_count() > 0;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

if ( $this->indexing_helper->is_initial_indexing() === false ) {

[88] Fix | Delete

return false;

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

if ( $this->indexing_helper->is_finished_indexables_indexing() === true ) {

[92] Fix | Delete

return false;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

$this->show_alternate_message = true;

[96] Fix | Delete

[97] Fix | Delete

return ! $this->are_site_representation_name_and_logo_set();

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Whether the user can do the first-time configuration.

[102] Fix | Delete

[103] Fix | Delete

* @return bool Whether the current user can do the first-time configuration.

[104] Fix | Delete

[105] Fix | Delete

private function user_can_do_first_time_configuration() {

[106] Fix | Delete

return \current_user_can( 'wpseo_manage_options' );

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* Whether the user is currently visiting one of our admin pages or the WordPress dashboard.

[111] Fix | Delete

[112] Fix | Delete

* @return bool Whether the current page is a Yoast SEO admin page

[113] Fix | Delete

[114] Fix | Delete

private function on_wpseo_admin_page_or_dashboard() {

[115] Fix | Delete

$pagenow = $GLOBALS['pagenow'];

[116] Fix | Delete

[117] Fix | Delete

// Show on the WP Dashboard.

[118] Fix | Delete

if ( $pagenow === 'index.php' ) {

[119] Fix | Delete

return true;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

$page_from_get = \filter_input( \INPUT_GET, 'page' );

[123] Fix | Delete

[124] Fix | Delete

// Show on Yoast SEO pages, with some exceptions.

[125] Fix | Delete

if ( $pagenow === 'admin.php' && \strpos( $page_from_get, 'wpseo' ) === 0 ) {

[126] Fix | Delete

$exceptions = [

[127] Fix | Delete

'wpseo_installation_successful',

[128] Fix | Delete

'wpseo_installation_successful_free',

[129] Fix | Delete

];

[130] Fix | Delete

[131] Fix | Delete

if ( ! \in_array( $page_from_get, $exceptions, true ) ) {

[132] Fix | Delete

return true;

[133] Fix | Delete

}

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

return false;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Whether all steps of the first-time configuration have been finished.

[141] Fix | Delete

[142] Fix | Delete

* @return bool Whether the first-time configuration has been finished.

[143] Fix | Delete

[144] Fix | Delete

private function is_first_time_configuration_finished() {

[145] Fix | Delete

$configuration_finished_steps = $this->options_helper->get( 'configuration_finished_steps', [] );

[146] Fix | Delete

[147] Fix | Delete

return \count( $configuration_finished_steps ) === 3;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Whether the site representation name and logo have been set.

[152] Fix | Delete

[153] Fix | Delete

* @return bool Whether the site representation name and logo have been set.

[154] Fix | Delete

[155] Fix | Delete

private function are_site_representation_name_and_logo_set() {

[156] Fix | Delete

$company_or_person = $this->options_helper->get( 'company_or_person', '' );

[157] Fix | Delete

[158] Fix | Delete

if ( $company_or_person === '' ) {

[159] Fix | Delete

return false;

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

if ( $company_or_person === 'company' ) {

[163] Fix | Delete

return ! empty( $this->options_helper->get( 'company_name' ) ) && ! empty( $this->options_helper->get( 'company_logo', '' ) );

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

return ! empty( $this->options_helper->get( 'company_or_person_user_id' ) ) && ! empty( $this->options_helper->get( 'person_logo', '' ) );

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Getter for the show alternate message boolean.

[171] Fix | Delete

[172] Fix | Delete

* @return bool

[173] Fix | Delete

[174] Fix | Delete

public function should_show_alternate_message() {

[175] Fix | Delete

return $this->show_alternate_message;

[176] Fix | Delete

}

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete