Germania\Renderer\PhpRenderer

Complexity

Total Complexity

19

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	5
C	__invoke()	0	77	11
A	buildPath()	0	10	3

<?php
namespace Germania\Renderer;

use \Psr\Log\LoggerInterface;
use \Psr\Log\LoggerAwareTrait;
use \Psr\Log\LoggerAwareInterface;
use \Psr\Log\NullLogger;
use Psr\Http\Message\ResponseInterface;



class PhpRenderer implements RendererInterface, LoggerAwareInterface {

    use LoggerAwareTrait;

    /**
     * @var string[]
     */
    public $base_path;


    /**
     * @param string|string[]|null $base_path Optional: Base path. Defaults to PHP's getcwd()'.
     * @param LoggerInterface|null $logger Optional: PSR-3 Logger
     */
    public function __construct ( $base_path = null, LoggerInterface $logger = null )
    {

        if (is_string($base_path) or !$base_path):
            $this->base_path = array($base_path ?: getcwd());

It seems like array($base_path ?: getcwd()) of type array<integer,array<integer,string>|string,{"0":"array<integer,string>|string"}> is incompatible with the declared type array<integer,string> of property $base_path.

        else:
            $this->base_path = $base_path;
        endif;

        $this->setLogger( $logger ?: new NullLogger );
    }


    /**
     * Returns parsed template output.
     *
     * @param  string   $template The template file

There is no parameter named $template. Was it maybe removed?

     * @param  array    $context  Associative tempalte variables array
     * @param  Callable $callable Optional Callback handler for output buffering

There is no parameter named $callable. Was it maybe removed?

     *
     * @return string|ResponseInterface   Template output or ResponseInterface instance
     *
     * @throws RuntimeException when include file is not readable somehow.
     */
    public function __invoke( $inc, array $context = array(), Callable $callback = null)
    {
        $this->logger->info("Render PHP include file: " . $inc, [
            'context'   => $context,
            'callback'  => $callback ?: "(not set)",
            'base_path' => $this->base_path
        ]);


        // Blank message
        $error_message = false;

        // Build path based on base path
        $path = $this->buildPath( $inc );

        if (is_readable( $path )):

            $this->logger->debug("Extract variables to include scope", $context);
            extract( $context );

            $this->logger->debug("Start output buffer");
            ob_start( $callback );

            $this->logger->debug("Include PHP file " . $inc);
            $result = include $path;


            $content_length = ob_get_length();


            if ($result instanceOf ResponseInterface):

                $this->logger->debug("Included PHP file returned ResponseInterface instance", [
                    'file' => $inc,
                    'ResponseInterface' => get_class( $result )
                ]);

                if ($echo_result = ob_get_clean()):
                    $this->logger->warning("Include file should not fill output buffer (echo et.al.) when returning ResponseInterface instance. To avoid data loss, content from output buffer is appended to ResponseInterface instance's body stream.", [
                        'file' => $inc,
                        'content_length' => $content_length
                    ]);
                    $result->getBody()->write( $echo_result );
                endif;


                // Return ResponseInterface
                $this->logger->info("Return ResponseInterface instance", [
                    'file' => $inc,
                    'ResponseInterface' => get_class( $result )
                ]);
                return $result;

The return type of return $result; (Psr\Http\Message\ResponseInterface) is incompatible with the return type declared by the interface Germania\Renderer\RendererInterface::__invoke of type string.

            endif;



            // Return string
            $this->logger->info("Return include file output from output buffer", [
                'file' => $inc,
                'content_length' => $content_length
            ]);
            return ob_get_clean();

        elseif ($path === false):
            $error_message  = "PhpRenderer: Could not find include in any base path.";
        elseif (!is_file($path)):
            $error_message  = "PhpRenderer: Include file does not exist: " . ($path ?: "(none)");
        else:
            $error_message = "PhpRenderer: Include file not readable: " . ($path ?: "(none)");
        endif;

        if (!empty($error_message) and is_string( $error_message )):
            $this->logger->error( $error_message );
            throw new \RuntimeException( $error_message );
        endif;

    }


    /**
     * @param  string $inc The file to locate
     * @return string      Full path
     */
    public function buildPath( $inc )
    {
        foreach($this->base_path as $path):
            if ($file = realpath(join(\DIRECTORY_SEPARATOR, [$path, $inc ]))) {
                return $file;
            }
        endforeach;

        return false;
    }
}