File: /var/www/studis.kauko.lt/wp-content/plugins/polylang/include/Options/Business/Domains.php
<?php
/**
* @package Polylang
*/
namespace WP_Syntex\Polylang\Options\Business;
use WP_Error;
use WP_Syntex\Polylang\Options\Abstract_Option;
use WP_Syntex\Polylang\Options\Options;
use WP_Syntex\Polylang\Model\Languages;
defined( 'ABSPATH' ) || exit;
/**
* Class defining single associative array of domain as value and language slug as key option.
* /!\ Sanitization depends on `force_lang`: this option must be set AFTER `force_lang`.
*
* @since 3.7
*
* @phpstan-type DomainsValue array<non-falsy-string, string>
*/
class Domains extends Abstract_Option {
/**
* Returns option key.
*
* @since 3.7
*
* @return string
*
* @phpstan-return 'domains'
*/
public static function key(): string {
return 'domains';
}
/**
* Returns the default value.
*
* @since 3.7
*
* @return array
*/
protected function get_default() {
return array();
}
/**
* Returns the JSON schema part specific to this option.
*
* @since 3.7
*
* @return array Partial schema.
*
* @phpstan-return array{
* type: 'object',
* patternProperties: non-empty-array<non-empty-string, array{type: 'string', format: 'uri'}>,
* additionalProperties: false
* }
*/
protected function get_data_structure(): array {
return array(
'type' => 'object', // Correspond to associative array in PHP, @see{https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#primitive-types}.
'patternProperties' => array(
Languages::SLUG_PATTERN => array( // Language slug as key.
'type' => 'string',
'format' => 'uri',
),
),
'additionalProperties' => false,
);
}
/**
* Sanitizes option's value.
* Can populate the `$errors` property with blocking and non-blocking errors: in case of non-blocking errors,
* the value is sanitized and can be stored.
*
* @since 3.7
*
* @param array $value Value to sanitize.
* @param Options $options All options.
* @return array|WP_Error The sanitized value. An instance of `WP_Error` in case of blocking error.
*
* @phpstan-return DomainsValue|WP_Error
*/
protected function sanitize( $value, Options $options ) {
// Sanitize new URLs.
$value = parent::sanitize( $value, $options );
if ( is_wp_error( $value ) ) {
// Blocking error.
return $value;
}
/** @phpstan-var DomainsValue */
$current_value = $this->get();
/** @phpstan-var DomainsValue $value */
$all_values = array(); // Previous and new values.
$missing_langs = array(); // Lang names corresponding to the empty values.
$language_terms = $this->get_language_terms();
// Detect empty values, fill missing keys with previous values.
foreach ( $language_terms as $lang ) {
if ( array_key_exists( $lang->slug, $value ) ) {
// Use the new value.
$all_values[ $lang->slug ] = $value[ $lang->slug ];
unset( $value[ $lang->slug ] );
} else {
// Use previous value.
$all_values[ $lang->slug ] = $current_value[ $lang->slug ] ?? '';
}
if ( empty( $all_values[ $lang->slug ] ) ) {
// The value is empty.
$missing_langs[] = $lang->name;
}
}
// Detect invalid language slugs.
if ( ! empty( $value ) ) {
// Non-blocking error.
$this->add_unknown_languages_warning( array_keys( $value ) );
}
if ( 3 === $options->get( 'force_lang' ) && ! empty( $missing_langs ) ) {
// Non-blocking error.
if ( 1 === count( $missing_langs ) ) {
/* translators: %s is a native language name. */
$message = __( 'Please enter a valid URL for %s.', 'polylang' );
} else {
/* translators: %s is a list of native language names. */
$message = __( 'Please enter valid URLs for %s.', 'polylang' );
}
$this->errors->add(
'pll_empty_domains',
sprintf( $message, wp_sprintf_l( '%l', $missing_langs ) ),
'warning'
);
}
// Ping all URLs to make sure they are valid.
if ( $options->get( 'force_lang' ) > 1 ) {
$failed_urls = array();
foreach ( array_filter( $all_values ) as $url ) {
$url = add_query_arg( 'deactivate-polylang', 1, $url );
// Don't redefine vip_safe_wp_remote_get() as it has not the same signature as wp_remote_get().
$response = function_exists( 'vip_safe_wp_remote_get' ) ? vip_safe_wp_remote_get( $url ) : wp_remote_get( $url );
if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
$failed_urls[] = $url;
}
}
if ( ! empty( $failed_urls ) ) {
// Non-blocking error.
if ( 1 === count( $failed_urls ) ) {
/* translators: %s is a URL. */
$message = __( 'Polylang was unable to access the %s URL. Please check that the URL is valid.', 'polylang' );
} else {
/* translators: %s is a list of URLs. */
$message = __( 'Polylang was unable to access the %s URLs. Please check that the URLs are valid.', 'polylang' );
}
$this->errors->add(
'pll_invalid_domains',
sprintf( $message, wp_sprintf_l( '%l', $failed_urls ) ),
'warning'
);
}
}
/** @phpstan-var DomainsValue */
return $all_values;
}
/**
* Returns the description used in the JSON schema.
*
* @since 3.7
*
* @return string
*/
protected function get_description(): string {
return __( 'Domains used when the language is set from different domains.', 'polylang' );
}
}