themichaelhall/bluemvc-core

<?php

/**
 * This file is a part of the bluemvc-core package.
 *
 * Read more at https://bluemvc.com/
 */

declare(strict_types=1);

namespace BlueMvc\Core;

use BlueMvc\Core\Exceptions\InvalidViewFileException;
use BlueMvc\Core\Exceptions\MissingViewRendererException;
use BlueMvc\Core\Exceptions\ViewFileNotFoundException;
use BlueMvc\Core\Interfaces\ApplicationInterface;
use BlueMvc\Core\Interfaces\Collections\ViewItemCollectionInterface;
use BlueMvc\Core\Interfaces\RequestInterface;
use BlueMvc\Core\Interfaces\ResponseInterface;
use BlueMvc\Core\Interfaces\ViewInterface;
use DataTypes\System\FilePath;

/**
 * Class representing a view.
 *
 * @since 1.0.0
 */
class View implements ViewInterface
{
    /**
     * Constructs the view.
     *
     * @since 1.0.0
     *
     * @param mixed|null  $model The model.
     * @param string|null $file  The file.
     *
     * @throws InvalidViewFileException If the file is invalid.
     */
    public function __construct(mixed $model = null, ?string $file = null)
    {
        if ($file !== null && preg_match('/[^a-zA-Z0-9._-]/', $file, $matches)) {
            throw new InvalidViewFileException('View file "' . $file . '" contains invalid character "' . $matches[0] . '".');
        }

        $this->model = $model;
        $this->file = $file;
    }

    /**
     * Returns the file.
     *
     * @since 1.0.0
     *
     * @return string|null The file.
     */
    public function getFile(): ?string
    {
        return $this->file;
    }

    /**
     * Returns the model.
     *
     * @since 1.0.0
     *
     * @return mixed The model.
     */
    public function getModel(): mixed
    {
        return $this->model;
    }

    /**
     * Updates the response.
     *
     * @since 1.0.0
     *
     * @param ApplicationInterface        $application The application.
     * @param RequestInterface            $request     The request.
     * @param ResponseInterface           $response    The response.
     * @param string                      $viewPath    The relative path to the view.
     * @param string                      $action      The action.
     * @param ViewItemCollectionInterface $viewItems   The view items.
     *
     * @throws MissingViewRendererException If no view renderer was added to the application.
     * @throws ViewFileNotFoundException    If a suitable view file could not be found.
     */
    public function updateResponse(ApplicationInterface $application, RequestInterface $request, ResponseInterface $response, string $viewPath, string $action, ViewItemCollectionInterface $viewItems): void
    {
        $viewRenderers = $application->getViewRenderers();
        if (count($viewRenderers) === 0) {
            throw new MissingViewRendererException('No view renderer was added to application.');
        }

        $viewPathsToCheck = $application->getViewPaths();

        // Try the view renderers until a match is found.
        $testedViewFiles = [];

        foreach ($viewRenderers as $viewRenderer) {
            foreach ($viewPathsToCheck as $viewPathToCheck) {
                $viewFile = FilePath::parse($viewPath . DIRECTORY_SEPARATOR . ($this->getFile() ?: $action) . '.' . $viewRenderer->getViewFileExtension());
                $fullViewFile = $viewPathToCheck->withFilePath($viewFile);

                if (file_exists($fullViewFile->__toString())) {
                    $response->setContent($viewRenderer->renderView($application, $request, $viewFile, $this->getModel(), $viewItems));

                    return;
                }

                $testedViewFiles[] = '"' . $fullViewFile->__toString() . '"';
            }
        }

        throw new ViewFileNotFoundException('Could not find view file ' . implode(' or ', $testedViewFiles));
    }

    /**
     * @var mixed The model.
     */
    private mixed $model;

    /**
     * @var string|null The file.
     */
    private ?string $file;
}