WPEmerge\View\PhpViewFilesystemFinder

Complexity

Total Complexity

16

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setDirectories()	0	2	1
A	exists()	0	2	1
A	getDirectories()	0	2	1
A	canonical()	0	2	1
A	__construct()	0	2	1
A	resolveFilepath()	0	8	2
A	resolveFromAbsoluteFilepath()	0	8	4
A	resolveFromCustomDirectories()	0	19	5

<?php
/**
 * @package   WPEmerge
 * @author    Atanas Angelov <hi@atanas.dev>
 * @copyright 2017-2019 Atanas Angelov
 * @license   https://www.gnu.org/licenses/gpl-2.0.html GPL-2.0
 * @link      https://wpemerge.com/
 */

namespace WPEmerge\View;

use WPEmerge\Helpers\MixedType;

/**
 * Render view files with php.
 */
class PhpViewFilesystemFinder implements ViewFinderInterface {
	/**
	 * Custom views directories to check first.
	 *
	 * @var string[]
	 */
	protected $directories = [];

	/**
	 * Constructor.
	 *
	 * @codeCoverageIgnore
	 * @param string[] $directories
	 */
	public function __construct( $directories = [] ) {
		$this->setDirectories( $directories );
	}

	/**
	 * Get the custom views directories.
	 *
	 * @codeCoverageIgnore
	 * @return string[]
	 */
	public function getDirectories() {
		return $this->directories;
	}

	/**
	 * Set the custom views directories.
	 *
	 * @codeCoverageIgnore
	 * @param  string[] $directories
	 * @return void
	 */
	public function setDirectories( $directories ) {
		$this->directories = array_filter( array_map( [MixedType::class, 'removeTrailingSlash'], $directories ) );
	}

	/**
	 * {@inheritDoc}
	 */
	public function exists( $view ) {
		return ! empty( $this->resolveFilepath( $view ) );
	}

	/**
	 * {@inheritDoc}
	 */
	public function canonical( $view ) {
		return $this->resolveFilepath( $view );
	}

	/**
	 * Resolve a view to an absolute filepath.
	 *
	 * @param  string $view
	 * @return string
	 */
	public function resolveFilepath( $view ) {
		$file = $this->resolveFromAbsoluteFilepath( $view );

		if ( ! $file ) {
			$file = $this->resolveFromCustomDirectories( $view );
		}

		return $file;
	}

	/**
	 * Resolve a view if it is a valid absolute filepath.
	 *
	 * @param  string $view
	 * @return string
	 */
	protected function resolveFromAbsoluteFilepath( $view ) {
		$path = realpath( MixedType::normalizePath( $view ) );

		if ( ! empty( $path ) && ! is_file( $path ) ) {
			$path = '';
		}

		return $path ? $path : '';
	}

	/**
	 * Resolve a view if it exists in the custom views directories.
	 *
	 * @param  string $view
	 * @return string
	 */
	protected function resolveFromCustomDirectories( $view ) {
		$directories = $this->getDirectories();

		foreach ( $directories as $directory ) {
			$file = MixedType::normalizePath( $directory . DIRECTORY_SEPARATOR . $view );

			if ( ! is_file( $file ) ) {
				// Try adding a .php extension.
				$file .= '.php';
			}

			$file = realpath( $file );

			if ( $file && is_file( $file ) ) {
				return $file;
			}
		}

		return '';
	}
}