PinkCrab\Perique\Services\View\PHP_Engine

Complexity

Total Complexity

22

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	set_component_compiler()	0	2	1
A	__construct()	0	2	1
A	render()	0	7	2
A	maybe_resolve_dot_notation()	0	9	2
A	partial()	0	6	2
A	view_model()	0	2	1
A	render_buffer()	0	26	5
A	resolve_file_path()	0	6	1
A	component()	0	20	4
A	base_view_path()	0	2	1
A	verify_view_path()	0	9	2

<?php

declare(strict_types=1);

/**
 * Basic PHP engine for using the Renderable interface.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @author Glynn Quelch <glynn.quelch@gmail.com>
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 * @package PinkCrab\Perique\View
 */

namespace PinkCrab\Perique\Services\View;

use Exception;
use PinkCrab\Perique\Utils\Object_Helper;
use PinkCrab\Perique\Interfaces\Renderable;
use PinkCrab\Perique\Services\View\View_Model;
use PinkCrab\Perique\Services\View\Component\Component;
use PinkCrab\Perique\Services\View\Component\Component_Compiler;
use function PinkCrab\FunctionConstructors\Strings\endsWith;

final class PHP_Engine implements Renderable {

	/**
	 * The path to base of templates.
	 *
	 * @var string
	 */
	private string $base_view_path;

	/**
	 * Access to the component compiler.
	 *
	 * @var Component_Compiler
	 */
	private ?Component_Compiler $component_compiler = null;

	/**
	 * Creates an instance of the PHP_Engine
	 *
	 * @param string $base_view_path
	 */
	public function __construct( string $base_view_path ) {
		$this->base_view_path = $this->verify_view_path( $base_view_path );
	}

	/**
	 * Sets the component compiler.
	 *
	 * @param Component_Compiler $compiler
	 * @return void
	 */
	public function set_component_compiler( Component_Compiler $compiler ): void {
		$this->component_compiler = $compiler;
	}

	/**
	 * Renders a template with data.
	 *
	 * @param string                  $view
	 * @param iterable<string, mixed> $data
	 * @param boolean                 $print
	 * @return string|null
	 */
	public function render( string $view, iterable $data, bool $print = true ): ?string {
		$view = $this->resolve_file_path( $view );
		if ( $print ) {
			print( $this->render_buffer( $view, $data ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
			return null;
		} else {
			return $this->render_buffer( $view, $data );
		}
	}

	/**
	 * Renders a component.
	 *
	 * @param Component $component
	 * @return string
	 */
	public function component( Component $component, bool $print = true ): ?string {

		// Throw exception of no compiler passed.
		if ( ! Object_Helper::is_a( $this->component_compiler, Component_Compiler::class ) ) {
			throw new Exception( 'No component compiler passed to PHP_Engine' );
		}

		// Compile the component.
		$compiled = $this->component_compiler->compile( $component ); // @phpstan-ignore-line, checked above.

The method compile() does not exist on null.

		$template = $compiled->template();

		$view = file_exists( $template )
			? $template
			: sprintf( '%s%s%s.php', $this->base_view_path, \DIRECTORY_SEPARATOR, trim( $this->maybe_resolve_dot_notation( $template ) ) );

		if ( $print ) {
			print( $this->render_buffer( $view, $compiled->data() ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
			return null;
		} else {
			return $this->render_buffer( $view, $compiled->data() );
		}
	}

	/**
	 * Renders a view Model
	 *
	 * @param View_Model $view_model
	 * @return string|null
	 */
	public function view_model( View_Model $view_model, bool $print = true ): ?string {
		return $this->render( $view_model->template(), $view_model->data(), $print );
	}

	/**
	 * Include a partial sub template
	 *
	 * @param string                  $view
	 * @param iterable<string, mixed> $data
	 * @param boolean                 $print
	 * @return string|null
	 */
	public function partial( string $view, iterable $data = array(), bool $print = true ): ?string {
		if ( $print ) {
			$this->render( $view, $data, $print );
			return null;
		} else {
			return $this->render( $view, $data, $print );
		}
	}

	/**
	 * Builds the view.
	 *
	 * @param string                  $view
	 * @param iterable<string, mixed> $__data
	 * @return string
	 * @throws Exception
	 */
	private function render_buffer( string $view, iterable $__data ): string {

		if ( ! file_exists( $view ) ) {
			throw new Exception( esc_html( "{$view} doesn't exist" ) );
		}

		$output = '';
		ob_start();

		// Set all the data values a parameters.
		foreach ( $__data as $__key => $__value ) {
			if ( is_string( $__key ) ) {
				${\wp_strip_all_tags( $__key )} = $__value;
			}

			// Unset the key and value.
			unset( $__key, $__value );
		}

		// Unset the data.
		unset( $__data );

		include $view;
		$output = ob_get_contents();
		ob_end_clean();
		return $output ?: ''; // phpcs:ignore Universal.Operators.DisallowShortTernary.Found
	}

	/**
	 * Resolves the filepath from a filename.
	 *
	 * @param string $filename
	 * @return string
	 */
	private function resolve_file_path( string $filename ): string {
		$filename = $this->maybe_resolve_dot_notation( $filename );
		return sprintf(
			'%s%s.php',
			$this->base_view_path,
			trim( $filename )
		);
	}

	/**
	 * Replaces dots with directory separator based on OS from $filename
	 *
	 * @param string $filename
	 * @return string
	 */
	private function maybe_resolve_dot_notation( string $filename ): string {
		if ( endsWith( '.php' )( $filename ) ) {
			$filename = substr( $filename, 0, -4 );
		}

		$parts    = explode( '.', $filename );
		$filename = implode( DIRECTORY_SEPARATOR, $parts );

		return $filename;
	}

	/**
	 * Verifies the view path exists and it has the trailing slash.
	 *
	 * @param string $path
	 * @return string
	 * @throws Exception
	 */
	private function verify_view_path( string $path ): string {
		$path = $this->maybe_resolve_dot_notation( $path );
		$path = rtrim( $path, '/' ) . '/';

		if ( ! \is_dir( $path ) ) {
			throw new Exception( esc_html( "{$path} doesn't exist and cant be used as the base view path." ) );
		}

		return $path;
	}

	/**
	 * Returns the base view path.
	 *
	 * @return string
	 * @since 1.4.0
	 */
	public function base_view_path(): string {
		return $this->base_view_path;
	}
}