Jaxon\Utils\Template\Engine

Complexity

Total Complexity

11

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	1
A	pagination()	0	4	1
A	_render()	0	19	2
A	render()	0	27	4
A	addNamespace()	0	13	3

<?php

/**
 * Template.php - Template engine
 *
 * Generate templates with template vars.
 *
 * @package jaxon-core

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2016 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon\Utils\Template;

use stdClass;

class Engine

Missing doc comment for class Engine

{
    /**
     * The namespaces
     *
     * @var array   $aNamespaces
     */
    protected $aNamespaces;

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

    /**
     * The constructor
     *
     * @param   string      $sTemplateDir       The template directory

Expected 1 spaces after parameter type; 6 found

Expected 1 spaces after parameter name; 7 found

     */
    public function __construct($sTemplateDir)

Expected 2 blank lines before function; 1 found

    {
        $sTemplateDir = rtrim(trim($sTemplateDir), '/\\');

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

Consider using a different name than the parameter $sTemplateDir. This often makes code more readable.

        $this->aNamespaces = [
            'jaxon' => [
                'directory' => $sTemplateDir . DIRECTORY_SEPARATOR,
                'extension' => '.php',
            ],
            'pagination' => [
                'directory' => $sTemplateDir . DIRECTORY_SEPARATOR . 'pagination' . DIRECTORY_SEPARATOR,
                'extension' => '.php',
            ],
        ];
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a namespace to the template system
     *
     * @param string        $sNamespace         The namespace name

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 9 found

     * @param string        $sDirectory         The namespace directory

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 9 found

     * @param string        $sExtension         The extension to append to template names

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 9 found

     *
     * @return void
     */
    public function addNamespace($sNamespace, $sDirectory, $sExtension = '')
    {
        // The 'jaxon' key cannot be overriden
        if($sNamespace == 'jaxon' || $sNamespace == 'pagination')
        {
            return;
        }
        // Save the namespace
        $this->aNamespaces[$sNamespace] = [
            'directory' => rtrim(trim($sDirectory), "/\\") . DIRECTORY_SEPARATOR,
            'extension' => $sExtension,
        ];
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set a new directory for pagination templates
     *
     * @param string        $sDirectory             The directory path

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 13 found

     *
     * @return void
     */
    public function pagination($sDirectory)
    {
        $this->aNamespaces['pagination']['directory'] = $sDirectory;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render a template
     *
     * @param string        $sPath                The path to the template

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 16 found

     * @param array         $aVars                The template vars

Expected 2 spaces after parameter type; 9 found

Expected 1 spaces after parameter name; 16 found

     *
     * @return string
     */
    private function _render($sPath, array $aVars)
    {
        // Make the template vars available as attributes
        $xData = new stdClass();
        foreach($aVars as $sName => $xValue)
        {
            $sName = (string)$sName;

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

            $xData->$sName = $xValue;
        }
        // Render the template
        $cRenderer = function() use($sPath) {
            ob_start();
            include($sPath);
            return ob_get_clean();
        };
        // Call the closure in the context of the $xData object.
        // So the keyworg '$this' in the template will refer to the $xData object.
        return \call_user_func($cRenderer->bindTo($xData));
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render a template
     *
     * @param string        $sTemplate            The name of template to be rendered

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 12 found

     * @param array         $aVars                The template vars

Expected 2 spaces after parameter type; 9 found

Expected 5 spaces after parameter name; 16 found

     *
     * @return string
     */
    public function render($sTemplate, array $aVars = [])
    {
        $sTemplate = trim($sTemplate);

Consider using a different name than the parameter $sTemplate. This often makes code more readable.

        // Get the namespace name
        $sNamespace = '';

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

        $iSeparatorPosition = strrpos($sTemplate, '::');
        if($iSeparatorPosition !== false)
        {
            $sNamespace = substr($sTemplate, 0, $iSeparatorPosition);
            $sTemplate = substr($sTemplate, $iSeparatorPosition + 2);

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

Consider using a different name than the parameter $sTemplate. This often makes code more readable.

        }
        // The default namespace is 'jaxon'
        if(!($sNamespace = trim($sNamespace)))

Variable assignment found within a condition. Did you mean to do a comparison ?

        {
            $sNamespace = 'jaxon';
        }
        // Check if the namespace is defined
        if(!key_exists($sNamespace, $this->aNamespaces))
        {
            return '';
        }
        $aNamespace = $this->aNamespaces[$sNamespace];
        // Get the template path
        $sTemplatePath = $aNamespace['directory'] . $sTemplate . $aNamespace['extension'];
        // Render the template
        return $this->_render($sTemplatePath, $aVars);
    }

Expected 2 blank lines after function; 0 found

}