Jaxon\Di\Traits\ViewTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getDialogLibraryManager()	0	3	1
A	getQuestionLibrary()	0	4	2
A	getDialogLibrary()	0	3	1
A	getPaginator()	0	3	1
A	getViewRenderer()	0	3	1
A	getModalLibrary()	0	4	2
A	getMessageLibrary()	0	4	2
A	registerDialogLibrary()	0	14	1
A	registerViews()	0	35	1

<?php

Missing file doc comment

namespace Jaxon\Di\Traits;

use Jaxon\App\Config\ConfigManager;
use Jaxon\App\Dialog\Library\AlertLibrary;
use Jaxon\App\Dialog\Library\DialogLibraryHelper;
use Jaxon\App\Dialog\Library\DialogLibraryManager;
use Jaxon\App\Dialog\LibraryInterface;
use Jaxon\App\Dialog\MessageInterface;
use Jaxon\App\Dialog\ModalInterface;
use Jaxon\App\Dialog\QuestionInterface;
use Jaxon\App\I18n\Translator;
use Jaxon\App\View\PaginationRenderer;
use Jaxon\App\View\TemplateView;
use Jaxon\App\View\ViewRenderer;
use Jaxon\Di\Container;
use Jaxon\Request\Call\Paginator;
use Jaxon\Utils\Template\TemplateEngine;

use function call_user_func;
use function rtrim;
use function trim;

trait ViewTrait

Missing doc comment for trait ViewTrait

{
    /**
     * Register the values into the container
     *
     * @return void
     */
    private function registerViews()

Expected 2 blank lines before function; 0 found

    {
        // Jaxon template view
        $this->set(TemplateView::class, function($di) {

It seems like set() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return new TemplateView($di->g(TemplateEngine::class));
        });
        // View Renderer
        $this->set(ViewRenderer::class, function($di) {
            $xViewRenderer = new ViewRenderer($di->g(Container::class));
            // Add the default view renderer
            $xViewRenderer->addRenderer('jaxon', function($di) {
                return $di->g(TemplateView::class);
            });
            $sTemplateDir = rtrim(trim($di->g('jaxon.core.dir.template')), '/\\');

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

            $sPaginationDir = $sTemplateDir . DIRECTORY_SEPARATOR . 'pagination';
            // By default, render pagination templates with Jaxon.
            $xViewRenderer->addNamespace('jaxon', $sTemplateDir, '.php', 'jaxon');
            $xViewRenderer->addNamespace('pagination', $sPaginationDir, '.php', 'jaxon');
            return $xViewRenderer;
        });

        // Pagination Paginator
        $this->set(Paginator::class, function($di) {
            return new Paginator($di->g(PaginationRenderer::class));
        });
        // Pagination Renderer
        $this->set(PaginationRenderer::class, function($di) {
            return new PaginationRenderer($di->g(ViewRenderer::class));
        });

        // Dialog library manager
        $this->set(DialogLibraryManager::class, function($di) {
            return new DialogLibraryManager($di->g(Container::class), $di->g(ConfigManager::class), $di->g(Translator::class));
        });
        $this->val(AlertLibrary::class, new AlertLibrary());

It seems like val() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

Expected 2 blank lines after function; 1 found

    /**
     * Register a javascript dialog library adapter.
     *
     * @param string $sClass

Missing parameter comment

     * @param string $sLibraryName

Missing parameter comment

     *
     * @return void
     */
    public function registerDialogLibrary(string $sClass, string $sLibraryName)
    {
        $this->set($sClass, function($di) use($sClass) {
            // Set the protected attributes of the library
            $cSetter = function() use($di) {
                $this->xHelper = new DialogLibraryHelper($this, $di->g(ConfigManager::class), $di->g(TemplateEngine::class));

The property xHelper does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

$this of type Jaxon\Di\Traits\ViewTrait is incompatible with the type Jaxon\App\Dialog\LibraryInterface expected by parameter $xDialogLibrary of Jaxon\App\Dialog\Library\DialogLibraryHelper::__construct().

            };
            // Can now access protected attributes
            $xLibrary = $di->make($sClass);
            call_user_func($cSetter->bindTo($xLibrary, $xLibrary));
            return $xLibrary;
        });
        // Set the alias, so the libraries can be found by their names.
        $this->alias("dialog_library_$sLibraryName", $sClass);

It seems like alias() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get a dialog library
     *
     * @param string $sLibraryName

Missing parameter comment

     *
     * @return LibraryInterface
     */
    public function getDialogLibrary(string $sLibraryName): LibraryInterface
    {
        return $this->g("dialog_library_$sLibraryName");

It seems like g() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the QuestionInterface library
     *
     * @param string $sLibraryName

Missing parameter comment

     *
     * @return QuestionInterface
     */
    public function getQuestionLibrary(string $sLibraryName): QuestionInterface
    {
        $sKey = "dialog_library_$sLibraryName";
        return $this->h($sKey) ? $this->g($sKey) : $this->g(AlertLibrary::class);

It seems like h() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the MessageInterface library
     *
     * @param string $sLibraryName

Missing parameter comment

     *
     * @return MessageInterface
     */
    public function getMessageLibrary(string $sLibraryName): MessageInterface
    {
        $sKey = "dialog_library_$sLibraryName";
        return $this->h($sKey) ? $this->g($sKey) : $this->g(AlertLibrary::class);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the ModalInterface library
     *
     * @param string $sLibraryName

Missing parameter comment

     *
     * @return ModalInterface|null
     */
    public function getModalLibrary(string $sLibraryName): ?ModalInterface
    {
        $sKey = "dialog_library_$sLibraryName";
        return $this->h($sKey) ? $this->g($sKey) : null;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the dialog library manager
     *
     * @return DialogLibraryManager
     */
    public function getDialogLibraryManager(): DialogLibraryManager
    {
        return $this->g(DialogLibraryManager::class);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Get the paginator
     *
     * @return Paginator
     */
    public function getPaginator(): Paginator
    {
        return $this->g(Paginator::class);
    }

Expected 2 blank lines after function; 0 found

}