jaxon-php / jaxon-core

src/App/CallableClass.php

<?php

Missing file doc comment

namespace Jaxon\App;

use Jaxon\App\Session\SessionInterface;
use Jaxon\App\View\ViewRenderer;
use Jaxon\Exception\SetupException;
use Jaxon\Plugin\Request\CallableClass\CallableClassHelper;
use Jaxon\Plugin\Response\DataBag\DataBagContext;
use Jaxon\Plugin\Response\JQuery\DomSelector;
use Jaxon\Request\Factory\RequestFactory;
use Jaxon\Request\TargetInterface;
use Jaxon\Response\Response;
use Psr\Log\LoggerInterface;

class CallableClass

Missing doc comment for class CallableClass

{
    /**
     * @var Response
     */
    protected $response = null;

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

    /**
     * @var CallableClassHelper
     */
    protected $xCallableClassHelper = null;

    /**
     * Get the Jaxon request target
     *
     * @return TargetInterface
     */
    protected function target(): TargetInterface

Expected 2 blank lines before function; 1 found

    {
        return $this->xCallableClassHelper->xTarget;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get an instance of a Jaxon class by name
     *
     * @param string $sClassName the class name
     *
     * @return mixed
     * @throws SetupException
     */
    public function cl(string $sClassName)
    {
        return $this->xCallableClassHelper->cl($sClassName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the request factory.
     *
     * @param string $sClassName

Missing parameter comment

     *
     * @return RequestFactory
     */
    public function rq(string $sClassName = ''): RequestFactory
    {
        return $this->xCallableClassHelper->rq($sClassName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the logger
     *
     * @return LoggerInterface
     */
    public function logger(): LoggerInterface
    {
        return $this->xCallableClassHelper->xLogger;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the view renderer
     *
     * @return ViewRenderer
     */
    public function view(): ViewRenderer
    {
        return $this->xCallableClassHelper->xViewRenderer;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the session manager
     *
     * @return SessionInterface
     */
    public function session(): SessionInterface
    {
        return $this->xCallableClassHelper->xSessionManager;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the uploaded files
     *
     * @return array
     */
    public function files(): array
    {
        return $this->xCallableClassHelper->xUploadHandler->files();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create a JQuery DomSelector, and link it to the response attribute.
     *
     * @param string $sPath    The jQuery selector path
     * @param mixed $xContext    A context associated to the selector

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return DomSelector
     */
    public function jq(string $sPath = '', $xContext = null): DomSelector
    {
        return $this->response->jq($sPath, $xContext);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get a data bag.
     *
     * @param string  $sBagName

Expected 1 spaces after parameter type; 2 found

Missing parameter comment

     *
     * @return DataBagContext
     */
    public function bag(string $sBagName): DataBagContext
    {
        return $this->response->bag($sBagName);
    }

Expected 2 blank lines after function; 0 found

}