Jaxon\Ui\View\ViewRenderer

Complexity

Total Complexity

10

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	store()	0	7	2
A	share()	0	4	1
A	shareValues()	0	7	2
A	set()	0	4	1
A	render()	0	27	3
A	__construct()	0	3	1

<?php

Missing file doc comment

namespace Jaxon\Ui\View;

use function strrpos;
use function substr;
use function array_merge;

class ViewRenderer

Missing doc comment for class ViewRenderer

{
    /**
     * The view data store
     *
     * @var Store
     */
    protected $xStore = null;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * The view global data
     *
     * @var array
     */
    protected $aViewData = [];

    /**
     * The view manager
     *
     * @var ViewManager
     */
    protected $xViewManager;

    /**

Parameter $xViewManager should have a doc-comment as per coding-style.

     * The constructor
     */
    public function __construct(ViewManager $xViewManager)

Expected 2 blank lines before function; 1 found

    {
        $this->xViewManager = $xViewManager;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the current store or create a new store
     *
     * @return Store
     */
    protected function store(): Store
    {
        if(!$this->xStore)
        {
            $this->xStore = new Store();
        }
        return $this->xStore;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make a piece of data available for the rendered view
     *
     * @param string $sName    The data name

Expected 2 spaces after parameter name; 4 found

     * @param mixed $xValue    The data value

Expected 1 spaces after parameter name; 4 found

Expected 2 spaces after parameter type; 1 found

     *
     * @return ViewRenderer
     */
    public function set(string $sName, $xValue): ViewRenderer
    {
        $this->store()->with($sName, $xValue);
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make a piece of data available for all views
     *
     * @param string $sName    The data name

Expected 2 spaces after parameter name; 4 found

     * @param mixed $xValue    The data value

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return ViewRenderer
     */
    public function share(string $sName, $xValue): ViewRenderer
    {
        $this->aViewData[$sName] = $xValue;
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make an array of data available for all views
     *
     * @param array $aValues    The data values

Expected 1 spaces after parameter name; 4 found

     *
     * @return ViewRenderer
     */
    public function shareValues(array $aValues): ViewRenderer
    {
        foreach($aValues as $sName => $xValue)
        {
            $this->share($sName, $xValue);
        }
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render a view using a store
     *
     * The store returned by this function will later be used with the make() method to render the view.
     *
     * @param string $sViewName    The view name

Expected 1 spaces after parameter name; 4 found

     * @param array $aViewData    The view data

Expected 1 spaces after parameter name; 4 found

Expected 2 spaces after parameter type; 1 found

     *
     * @return null|Store   A store populated with the view data
     */
    public function render(string $sViewName, array $aViewData = []): ?Store
    {
        // Get the store
        $xStore = $this->store();

        // Get the default view namespace
        $sNamespace = $this->xViewManager->getDefaultNamespace();
        // Get the namespace from the view name
        $nSeparatorPosition = strrpos($sViewName, '::');
        if($nSeparatorPosition !== false)
        {
            $sNamespace = substr($sViewName, 0, $nSeparatorPosition);
        }

        $xRenderer = $this->xViewManager->getNamespaceRenderer($sNamespace);
        if(!$xRenderer)
        {
            // Cannot render a view if there's no renderer corresponding to the namespace.
            return null;
        }

        $xStore->setData(array_merge($this->aViewData, $aViewData))
            ->setView($xRenderer, $sNamespace, $sViewName);

Space found before object operator

        // Set the store to null so a new store will be created for the next view.
        $this->xStore = null;
        // Return the store
        return $xStore;
    }

Expected 2 blank lines after function; 0 found

}