# solid-performance/1.5.0/src/Performance/Page_Cache/Debug.php

Solid Performance – Your No-Code Caching, Performance, & Page Speed Solution, version 1.5.0. 160 lines.

- Page: https://pluginprobe.com/plugins/solid-performance/1.5.0/code/src/Performance/Page_Cache/Debug.php
- Raw: https://pluginprobe.com/plugins/solid-performance/1.5.0/raw/src/Performance/Page_Cache/Debug.php
- Modified: 2025-02-13T01:04:32+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/solid-performance/1.5.0/code/src/Performance/Page_Cache/Debug.php#L10-L20`.

```php
<?php
/**
 * The class that handles debug functionality for the page cache.
 *
 * @since 0.1.0
 *
 * @package SolidWP\Performance
 */

declare( strict_types=1 );

namespace SolidWP\Performance\Page_Cache;

use DateTimeImmutable;
use SolidWP\Performance\Config\Config;
use SolidWP\Performance\Http\Request;
use SolidWP\Performance\Page_Cache\Compression\Contracts\Compressible;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Handles the debug functionality for the page cache.
 *
 * @since 0.1.0
 *
 * @package SolidWP\Performance
 */
class Debug {

	/**
	 * The padding to insert between definition labels and values.
	 *
	 * @since 0.1.0
	 *
	 * @var int
	 */
	private int $pad = 23;

	/**
	 * @var Config
	 */
	private Config $config;

	/**
	 * @param  Config $config  The config object.
	 */
	public function __construct( Config $config ) {
		$this->config = $config;
	}

	/**
	 * Get the content for the page cache debug comment.
	 *
	 * @since 0.1.0
	 *
	 * @param Request      $request The current request to output information about.
	 * @param Compressible $compressor The compressor used to save the cache file.
	 *
	 * @return string
	 */
	public function get_debug_comment( Request $request, Compressible $compressor ): string {
		if ( $this->config->get( 'page_cache.debug' ) !== true ) {
			return '';
		}

		$date_time     = $this->get_timestamp();
		$engine        = str_pad( 'Engine:', $this->pad ) . 'Disk';
		$creation_time = str_pad( 'Creation Time:', $this->pad ) . $request->start . 's';
		$host          = filter_var( $request->server['HTTP_HOST'], FILTER_SANITIZE_SPECIAL_CHARS );

		$encoding    = $compressor->encoding() ?: 'None';
		$compression = str_pad( 'Compression Algorithm:', $this->pad ) . $encoding;

		$header_content = $this->get_headers(
			$request,
			[
				'X-Powered-By'  => 'HTTP_X_POWERED_BY',
				'Expires'       => '',
				'Cache Control' => 'HTTP_CACHE_CONTROL',
				'Content-Type'  => 'HTTP_CONTENT_TYPE',
			]
		);
		return "
<!--
Solid Performance page optimization. Learn more: https://solidwp.com/performance

Page cache debug info:

$engine
$creation_time
$compression

Header Info:

$header_content

Served from: $host @ $date_time by Solid Performance
-->";
	}

	/**
	 * Gets a list of headers to output in a list of labels and values.
	 *
	 * @since 0.1.0
	 *
	 * @param Request              $request The request in which to get headers.
	 * @param array<string,string> $headers The labels and headers to output.
	 *
	 * @return string
	 */
	public function get_headers( Request $request, array $headers = [] ): string {

		$header_content = '';

		foreach ( $headers as $label => $header ) {
			if ( isset( $request->server[ $header ] ) ) {
				$label           = sprintf(
					'%s:',
					$label
				);
				$header_content .= str_pad( $label, $this->pad ) . $request->server[ $header ];
			}
		}

		if ( strlen( $header_content ) > 0 ) {
			return $header_content;
		}

		return '';
	}

	/**
	 * Get the generated comment, shown on cached pages when debugging is DISABLED.
	 *
	 * @return string
	 */
	public function get_generated_by_comment(): string {
		if ( $this->config->get( 'page_cache.debug' ) ) {
			return '';
		}

		return sprintf(
			'
<!-- Cached page generated by Solid Performance on %s -->',
			esc_html( $this->get_timestamp() )
		);
	}

	/**
	 * Get a timestamp using the configured timezone from the WP dashboard.
	 *
	 * @return string
	 */
	private function get_timestamp(): string {
		return ( new DateTimeImmutable( 'now', wp_timezone() ) )->format( 'Y-m-d H:i:s T' );
	}
}

```