bytic / controllers

src/Traits/HasViewTrait.php

<?php

declare(strict_types=1);

namespace Nip\Controllers\Traits;

use Nip\Controllers\View\ControllerViewHydrator;
use Nip\Http\Request;
use Nip\View;

/**
 * Trait HasViewTrait
 * @package Nip\Controllers\Traits
 */
trait HasViewTrait
{
    use AbstractControllerTrait;

    /**
     * @var View
     */
    protected $view;

    /**
     * @var string
     */
    protected $layout = 'default';

    /**
     * @param bool $return
     * @return bool|string|null
     */
    public function loadView($return = false)
    {
        $view = $this->getView();
        $this->populateView($view);
        $content = $view->load($this->getLayoutPath());
        if ($return == true) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            return $content;
        }
        echo $content;
        return null;
    }

    /**
     * @return View
     */
    public function getView()
    {
        if (!$this->view) {
            $this->view = $this->initView();
        }

        return $this->view;
    }

    /**
     * @param View $view
     */
    public function setView($view)
    {
        $this->view = $view;
    }

    /**
     * @return View
     */
    protected function initView()
    {
        $request = $this->getRequest();
        if ($request instanceof Request) {

$request is always a sub-type of Nip\Http\Request.

            if (isset($request->_view) && $request->_view instanceof View) {
                return $request->_view;
            }
        }

        $view = $this->getViewObject();

        if ($request instanceof Request) {

$request is always a sub-type of Nip\Http\Request.

            $request->_view = $view;

The property _view does not seem to exist on Nip\Request.

        }

        return $view;
    }

    /**
     * @return View
     */
    protected function getViewObject()
    {
        return new View();
    }

    /**
     * @param View $view
     *
     * @return View
     */
    public function populateView($view)
    {
        $this->populateViewPath($view);

The function Nip\Controllers\Traits\HasViewTrait::populateViewPath() has been deprecated: Rely on Response Payload Transformer to call this method. Use RegisterViewPaths if necessary

        $view = $this->initViewVars($view);

        // @deprecated Rely on Response Payload Transformer to call this method
//        $view = $this->initViewContentBlocks($view);

        return $view;
    }

    public function registerViewPaths(View\View $view): void

The parameter $view is not used and could be removed.

    {
    }

    /**
     * @deprecated Rely on Response Payload Transformer to call this method. Use RegisterViewPaths if necessary
     */
    protected function populateViewPath($view)
    {
        return ControllerViewHydrator::populatePath($view, $this);

$this of type Nip\Controllers\Traits\HasViewTrait is incompatible with the type Nip\Controllers\Controller expected by parameter $controller of Nip\Controllers\View\ControllerViewHydrator::populatePath().

    }

    /**
     * @param View $view
     *
     * @return View
     */
    protected function initViewVars($view)
    {
        return ControllerViewHydrator::initVars($view, $this);

$this of type Nip\Controllers\Traits\HasViewTrait is incompatible with the type Nip\Controllers\Controller|null expected by parameter $controller of Nip\Controllers\View\ControllerViewHydrator::initVars().

    }

    /**
     * @param View $view
     *
     * @return View
     */
    protected function initViewContentBlocks($view)
    {
        return ControllerViewHydrator::initContentBlocks($view, $this);
    }

    /**
     * @return string
     */
    public function getLayoutPath()
    {
        return '/layouts/' . $this->getLayout();
    }

    /**
     * @return string
     */
    public function getLayout()
    {
        return $this->layout;
    }

    /**
     * @param string $layout
     */
    public function setLayout($layout)
    {
        $this->layout = $layout;
    }
}