# solid-performance/1.3.2/src/Performance/Page_Cache/Cache_Handler.php

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

- Page: https://pluginprobe.com/plugins/solid-performance/1.3.2/code/src/Performance/Page_Cache/Cache_Handler.php
- Raw: https://pluginprobe.com/plugins/solid-performance/1.3.2/raw/src/Performance/Page_Cache/Cache_Handler.php
- Modified: 2024-10-09T17:31:38+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.3.2/code/src/Performance/Page_Cache/Cache_Handler.php#L10-L20`.

```php
<?php
/**
 * Handles managing cache files.
 *
 * @package SolidWP\Performance
 */

declare( strict_types=1 );

namespace SolidWP\Performance\Page_Cache;

use RuntimeException;
use SolidWP\Performance\Http\Request;
use SolidWP\Performance\Page_Cache\Compression\Collection;
use SolidWP\Performance\Page_Cache\Compression\Contracts\Compressible;
use SolidWP\Performance\Page_Cache\Compression\Exceptions\CompressionFailedException;

/**
 * Handles managing cache files.
 *
 * @package SolidWP\Performance
 */
final class Cache_Handler {

	/**
	 * @var Request
	 */
	private Request $request;

	/**
	 * @var Compressible
	 */
	private Compressible $compressor;

	/**
	 * @var Debug
	 */
	private Debug $debug;

	/**
	 * @var Expiration
	 */
	private Expiration $expiration;

	/**
	 * @var Cache_Path
	 */
	private Cache_Path $cache_path;

	/**
	 * @param  Collection $compressors The collection of compression algorithms.
	 * @param  Request    $request The current request.
	 * @param  Debug      $debug The debugger.
	 * @param  Expiration $expiration The expiration manager.
	 * @param  Cache_Path $cache_path The server path to the cache directory.
	 */
	public function __construct(
		Collection $compressors,
		Request $request,
		Debug $debug,
		Expiration $expiration,
		Cache_Path $cache_path
	) {
		$this->request    = $request;
		$this->compressor = $compressors->get_by_header( (string) $request->header->get( 'accept-encoding' ) );
		$this->debug      = $debug;
		$this->expiration = $expiration;
		$this->cache_path = $cache_path;
	}

	/**
	 * Save a file to the cache based on the type of compression the browser is asking for
	 * and what the server supports.
	 *
	 * @param  string $output Output to save in the cached file.
	 *
	 * @throws RuntimeException If the cache directory or cache file can't be created.
	 *
	 * @return void
	 */
	public function save( string $output ): void {
		$this->ensure_cache_dir_exists();

		$file = $this->get_file_path();

		// Append HTML debug comment, if enabled.
		$output .= $this->debug->get_debug_comment( $this->request, $this->compressor );

		// Append HTML generated by comment if debugging is DISABLED.
		$output .= $this->debug->get_generated_by_comment();

		// Don't save any fails that failed to compress their content.
		try {
			$compressed = $this->compressor->compress( $output );
		} catch ( CompressionFailedException $e ) {
			swpsp_log( sprintf( 'Failed to compress content using "%s" compression: %s', $this->compressor->encoding(), $e->getMessage() ) );

			return;
		}

		$result = swpsp_direct_filesystem()->put_contents( $file, $compressed, swpsp_get_file_mode() );

		if ( $result === false ) {
			throw new RuntimeException( sprintf( 'File could not be saved to cache: %s', $file ) );
		}
	}

	/**
	 * Converts a URL into a directory structure.
	 *
	 * All cached requests will be saved to a directory structure that matches
	 * the relative URL. This provides a way to consistently get the cached
	 * resource from the URL.
	 *
	 * @throws RuntimeException When URL does not have valid host.
	 *
	 * @return string
	 */
	public function get_file_path(): string {
		$path = $this->cache_path->get_path_from_url( $this->request->uri );
		$ext  = $this->compressor->extension();

		return "$path.$ext";
	}

	/**
	 * Whether the current cache file exists and is not expired.
	 *
	 * @return bool
	 */
	public function is_valid(): bool {
		return file_exists( $this->get_file_path() ) && ! $this->expiration->file_expired( $this->get_file_path() );
	}

	/**
	 * Get the current compression strategy.
	 *
	 * @return Compressible
	 */
	public function compressor(): Compressible {
		return $this->compressor;
	}

	/**
	 * Make sure the complete directory we'll be saving our file to, actually exists.
	 *
	 * @throws RuntimeException If the cache directory can't be created.
	 *
	 * @return void
	 */
	private function ensure_cache_dir_exists(): void {
		$dir = dirname( $this->get_file_path() );

		// If the file's directory structure does not exist yet, create it.
		if ( ! is_dir( $dir ) ) {
			$result = wp_mkdir_p( $dir );

			if ( ! $result ) {
				throw new RuntimeException( 'Unable to make directory: ' . $dir );
			}
		}
	}
}

```