ntentan\honam\engines\PhpEngine

Complexity

Total Complexity

8

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	partial()	0	4	1
A	unescape()	0	8	2
A	renderFromFileTemplate()	0	23	3
A	renderFromStringTemplate()	0	6	1

<?php

/*
 * Ntentan Framework
 * Copyright (c) 2010-2015 James Ekow Abaka Ainooson
 * 
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
 */

namespace ntentan\honam\engines;

use ntentan\honam\engines\php\HelpersLoader;
use ntentan\honam\engines\php\Janitor;
use ntentan\honam\TemplateEngine;
use ntentan\honam\engines\php\Variable;

/**
 * The PHP engine is a template engine built into honam which uses raw PHP as
 * the template language. By virtue of this, the PHP engine can boast of high
 * performance. Since this engine uses PHP, it has access to all the language's
 * features. This could sometimes create a problem since some of these features
 * are not intended for templating use.
 */
class PhpEngine extends AbstractEngine
{
    private $helpersLoader;
    private $janitor;

    public function __construct(HelpersLoader $helpersLoader, Janitor $janitor)

The parameter $janitor is not used and could be removed.

    {
        $this->helpersLoader = $helpersLoader;
    }

    function partial($template, $templateData = array())

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->templateRenderer->render($template, $templateData);
    }

    function unescape($item)

The return type could not be reliably inferred; please add a @return annotation.

It is generally recommended to explicitly declare the visibility for methods.

    {
        if($item instanceof ntentan\honam\template_engines\php\Variable) {

The class ntentan\honam\engines\ntentan\honam\template_engines\php\Variable does not exist. Did you forget a USE statement, or did you not list all dependencies?

            return $item->unescape();
        } else {
            return $item;
        }
    }

    /**
     * Passes the data to be rendered to the template engine instance.
     */
    public function renderFromFileTemplate(string $filePath, array $data) : string
    {
        // Escape each variable by passing it through the variable class.
        // Users would have to unescape them by calling the escape method directly
        // on the variable.
        foreach ($data as $_key => $_value) {
            $$_key = Variable::initialize($_value);
        }

        // Expose helpers
        $helpers = $this->helpersLoader;

        // Start trapping the output buffer and include the PHP template for
        // execution.
        ob_start();
        try {
            include $filePath;
        } catch (\Exception $e) {
            ob_get_flush();
            throw $e;
        }
        return ob_get_clean();
    }

    /**
     * Passes a template string and data to be rendered to the template engine
     * instance.
     */
    public function renderFromStringTemplate(string $string, array $data) : string
    {
        \ntentan\utils\StringStream::register();
        file_put_contents('string://template', $string);
        return $this->renderFromFileTemplate('string://template', $data);
    }

//    public function generate($templateVariables)
//    {
//        // Escape each variable by passing it through the variable class.
//        // Users would have to unescape them by calling the escape method directly
//        // on the variable.
//        foreach ($templateVariables as $_key => $_value) {
//            $$_key = php\Variable::initialize($_value);
//        }
//
//        // Expose helpers
//        $helpers = $this->getHelpersLoader();
//
//        // Start trapping the output buffer and include the PHP template for
//        // execution.
//        ob_start();
//        try {
//            include $this->template;
//        } catch (\Exception $e) {
//            ob_get_flush();
//            throw $e;
//        }
//        return ob_get_clean();
//    }
//
//    /**
//     * A utility function to strip the text of all HTML code. This function
//     * removes all HTML tags instead of escaping them.
//     *
//     * @param string $text
//     * @return string
//     */
//    public function strip($text) {
//        return php\Janitor::cleanHtml($text, true);
//    }
//
//    /**
//     * A utility function to cut long pieces of text into meaningful short
//     * chunks. The function is very good in cases where you want to show just
//     * a short preview snippet of a long text. The function cuts the long string
//     * without cutting through words and appends some sort of ellipsis
//     * terminator to the text.
//     *
//     * @param string $text The text to be truncated.
//     * @param string $length The maximum lenght of the truncated string. Might
//     *      return a shorter string if the lenght ends in the middle of a word.
//     * @param string $terminator The ellipsis terminator to use for the text.
//     * @return string
//     */
//    public function truncate($text, $length, $terminator = ' ...') {
//        while (mb_substr($text, $length, 1) != ' ' && $length > 0) {
//            $length--;
//        }
//        return mb_substr($text, 0, $length) . $terminator;
//    }
//
//    protected function generateFromString($string, $data) {
//        \ntentan\utils\StringStream::register();
//        file_put_contents('string://template', $string);
//        $this->template = 'string://template';
//        return $this->generate($data);
//    }
//
//    public function __destruct() {
//        \ntentan\utils\StringStream::unregister();
//    }

}