jaxon-php / jaxon-core

src/App/View/Store.php

<?php

Missing file doc comment

namespace Jaxon\App\View;

use JsonSerializable;

use function array_merge;

class Store implements JsonSerializable

Missing doc comment for class Store

{
    /**
     * The view renderer
     *
     * @var ViewInterface
     */
    protected $xRenderer;

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

    /**
     * The view namespace
     *
     * @var string
     */
    protected $sNamespace;

    /**
     * The view name
     *
     * @var string
     */
    protected $sViewName;

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

    /**
     * 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 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return Store
     */
    public function with(string $sName, $xValue): Store

Expected 2 blank lines before function; 1 found

    {
        $this->aViewData[$sName] = $xValue;
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the data to be rendered
     *
     * @param array $aViewData    The view data

Expected 1 spaces after parameter name; 4 found

     *
     * @return Store
     */
    public function setData(array $aViewData): Store
    {
        $this->aViewData = array_merge($this->aViewData, $aViewData);
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the view to be rendered, with optional data
     *
     * @param ViewInterface $xRenderer    The view renderer

Expected 2 spaces after parameter name; 4 found

     * @param string $sNamespace    The view namespace

Expected 8 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param string $sViewName    The view name

Expected 8 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 4 found

     * @param array $aViewData    The view data

Expected 9 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 4 found

     *
     * @return Store
     */
    public function setView(ViewInterface $xRenderer, string $sNamespace, string $sViewName, array $aViewData = []): Store
    {
        $this->xRenderer = $xRenderer;
        $this->sNamespace = trim($sNamespace);
        $this->sViewName = trim($sViewName);
        $this->aViewData = array_merge($this->aViewData, $aViewData);
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the view namespace
     *
     * @return string        The view namespace
     */
    public function getNamespace(): string
    {
        return $this->sNamespace;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the view name
     *
     * @return string        The view name
     */
    public function getViewName(): string
    {
        return $this->sViewName;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the view data
     *
     * @return array         The view data
     */
    public function getViewData(): array
    {
        return $this->aViewData;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render a view using third party view system
     *
     * @return string        The string representation of the view
     */
    public function __toString()
    {
        return ($this->xRenderer) ? $this->xRenderer->render($this) : '';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Convert this object to string for json.
     *
     * This is a method of the JsonSerializable interface.
     *
     * @return string
     */
    public function jsonSerialize(): string
    {
        return $this->__toString();
    }

Expected 2 blank lines after function; 0 found

}