File Editor

Directories:

Files:

Create New File

Edit File: Host.php

<?php

namespace Yoast\WHIPv2;

/**
 * Represents a host.
 */
class Host {

/**
	 * Key to an environment variable which should be set to the name of the host.
	 *
	 * @var string
	 */
	const HOST_NAME_KEY = 'WHIP_NAME_OF_HOST';

/**
	 * Filter name for the filter which allows for pointing to the WP hosting page instead of the Yoast version.
	 *
	 * @var string
	 */
	const HOSTING_PAGE_FILTER_KEY = 'whip_hosting_page_url_wordpress';

/**
	 * Retrieves the name of the host if set.
	 *
	 * @return string The name of the host.
	 */
	public static function name() {
		$name = (string) \getenv( self::HOST_NAME_KEY );

return self::filterName( $name );
	}

/**
	 * Filters the name if we are in a WordPress context.
	 * In a non-WordPress content this function just returns the passed name.
	 *
	 * @param string $name The current name of the host.
	 *
	 * @return string The filtered name of the host.
	 */
	private static function filterName( $name ) {
		if ( \function_exists( 'apply_filters' ) ) {
			return (string) \apply_filters( \strtolower( self::HOST_NAME_KEY ), $name );
		}

return $name;
	}

/**
	 * Retrieves the message from the host if set.
	 *
	 * @param string $messageKey The key to use as the environment variable.
	 *
	 * @return string The message as set by the host.
	 */
	public static function message( $messageKey ) {
		$message = (string) \getenv( $messageKey );

return self::filterMessage( $messageKey, $message );
	}

/**
	 * Filters the message if we are in a WordPress context.
	 * In a non-WordPress content this function just returns the passed message.
	 *
	 * @param string $messageKey The key used for the environment variable.
	 * @param string $message    The current message from the host.
	 *
	 * @return string
	 */
	private static function filterMessage( $messageKey, $message ) {
		if ( \function_exists( 'apply_filters' ) ) {
			return (string) \apply_filters( \strtolower( $messageKey ), $message );
		}

return $message;
	}

/**
	 * Returns the URL for the hosting page.
	 *
	 * @return string The URL to the hosting overview page.
	 */
	public static function hostingPageUrl() {
		$url = 'https://yoa.st/w3';

return self::filterHostingPageUrl( $url );
	}

/**
	 * Filters the hosting page url if we are in a WordPress context.
	 * In a non-WordPress context this function just returns a link to the Yoast hosting page.
	 *
	 * @param string $url The previous URL.
	 *
	 * @return string The new URL to the hosting overview page.
	 */
	private static function filterHostingPageUrl( $url ) {
		if ( \function_exists( 'apply_filters' ) && \apply_filters( self::HOSTING_PAGE_FILTER_KEY, false ) ) {
			return 'https://wordpress.org/hosting/';
		}

return $url;
	}
}

File Editor

Directories:

Files:

Create New File

Edit File: Host.php

Rename File