reformo / rslim

src/RSlim.php

<?php

namespace RSlim;

use \Psr\Http\Message\RequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;

class RSlim
{
    public $config = [
        'base_dir' => null,
        'app_dir' => 'apps/_skel',
        'base_url' => null,
        'app_name' => 'www',
        'default_return_type' => 'html',
        'bypass_error_handlers' => true
    ];
    public $container = null;
    public $app = null;
    public $twig = null;
    public $controller = null;
    public $method = null;

    public function __construct($config)
    {
        $this->config = array_merge($this->config, $config);
        define('RSLIM_DEFAULT_RETURN_TYPE',$this->config['default_return_type']);
        ini_set("default_charset", "utf-8");
        ini_set('date.timezone', $config['app']['timezone']);
        $configuration = [
            'settings' => [
                'displayErrorDetails' => $config['app']['debug'],
            ],
        ];
        $this->container = new \Slim\Container($configuration);
        $this->app = new \Slim\App($this->container);
    }

    public function runRoute($request, $response, $route, $action = 'main', $returnType = RSLIM_DEFAULT_RETURN_TYPE, $args = [])
    {
        $this->controller = $route;
        $this->method = $action;
        $controller = $this->config['base_dir'] . '/' . $this->config['app_dir'] . '/controllers/' . $route . '/' . $action . '.php';
        $template   = '/' . $this->config['app_dir'] . '/templates/' . $route . '/' . $action . '.html';

        if (file_exists($controller)) {
            require_once($controller);

            $functionName = $route . '_' . $action;

            if ($returnType == 'html') {
                $this->useTwig($request);
            }
            if (!function_exists($functionName)) {
                $message = 'Controller ' . $route . '/' . $action . " has not " . $functionName . " function";
                return $this->notFound($response, $returnType, $message);
            }
            if ($returnType == 'json') {
                return $this->returnJson($functionName, $request, $args, $response);
            }
            return $this->returnHtml($functionName, $request, $args, $response, $route, $action, $template);
        }
        $message = 'Controller ' . $route . '/' . $action . " not found";
        return $this->notFound($response, $returnType, $message);
    }
    
    public function register($requestMethod, $pattern, $controller, $returnType = RSLIM_DEFAULT_RETURN_TYPE)
    {
        $this->app->map([strtoupper($requestMethod)], $pattern, function(Request $req, Response $res, $args) {
            list($route, $action) = explode("/", $args['controller']);
            return $args['RSlim']->runRoute($req, $res, $route, $action, $args['returnType'], $args);
        })->setArguments(['controller'=>$controller, 'returnType'=>$returnType, 'RSlim'=>$this]);
    }
    
    public function run()
    {
        $this->container['notFoundHandler'] = function($c) {
            return function(Request $req, Response $res) use ($c) {

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

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

                return $c['response']
                ->withStatus(404)
                ->withHeader('Content-Type', 'text/html')->withHeader('X-Powered-By', "reformo/rslim")
                ->write('<h1>404 - Requested URL not found</h1>');
            };
        };
        if ($this->config['bypass_error_handlers'] === true) {
            $this->container['errorHandler'] = function($container) {

This code seems to be duplicated across your project.

                return function($request, $response, $exception) use ($container) {
                    $response->getBody()->rewind();
                    return $response->withStatus(500)
                    ->withHeader('Content-Type', 'text/html')
                    ->write($exception->getMessage());
                };
            };
            $this->container['phpErrorHandler'] = function($container) {

This code seems to be duplicated across your project.

                return function($request, $response, $error) use ($container) {
                    $response->getBody()->rewind();
                    return $response->withStatus(500)
                    ->withHeader('Content-Type', 'text/html')
                    ->write($error->getMessage());
                };
            };
        }
        $this->app->run();
    }    
    
    private function returnJson($functionName, $request, $args, $response)
    {
        $functionOutput = call_user_func($functionName, $request, $args);
        if (isset($functionOutput['redirect'])) {
            return $response->withRedirect($functionOutput['redirect']);
        }
        if (!is_array($functionOutput)) {
            $functionOutput = ["status" => 500, "error" => "Internal Server Error"];
        } elseif (!isset($functionOutput['status'])) {
            $functionOutput['status'] = 200;
        }
        $status = (int) $functionOutput['status'];
        $response->getBody()->write(json_encode($functionOutput));
        return $response->withHeader('Content-Type', 'application/json;charset=utf-8')->withHeader('X-Powered-By', "reformo/rslim")->withStatus($status);
    }
    
    private function returnHtml($functionName, $request, $args, $response, $route, $action, $template){
        if (!file_exists($this->config['base_dir'] . $template)) {

This code seems to be duplicated across your project.

            throw new \Exception("<strong>Template file not found!</strong> " . $route . '/' . $action . " needs a template file at:" . $template);
        }
        $functionOutput = call_user_func($functionName, $request, $args);
        if (isset($functionOutput['redirect'])) {
            return $response->withRedirect($functionOutput['redirect']);
        }
        if (!isset($functionOutput['data'])) {
            $functionOutput['data'] = [];
        }
        
        $functionOutput['app_content'] = $this->twig->render($template, $functionOutput['data']);
        $mainTemplateName = 'default';
        if (isset($functionOutput['app_main_template'])) {
            $mainTemplateName = $functionOutput['app_main_template'];
        }
        $mainTemplate = '/' . $this->config['app_dir'] . '/templates/_' . $mainTemplateName . '.html';

        if (!file_exists($this->config['base_dir'] . $mainTemplate)) {

This code seems to be duplicated across your project.

            throw new \Exception("<strong>Main emplate file not found!</strong> " . $route . '/' . $action .
                " needs a main template file at:" . $mainTemplate);
        }
        $appContent = $this->twig->render($mainTemplate, $functionOutput);
        $newResponse = $response->withHeader('X-Powered-By', "reformo/rslim");
        $newResponse->write($appContent);
        return $newResponse;
    }
    
    public function useTwig($request)
    {
        $loader     = new \Twig_Loader_Filesystem($this->config['base_dir']);
        $this->twig = new \Twig_Environment($loader, [
            'cache'         => '/tmp',
            'debug'         => $this->config['app']['debug'],
            'auto_reload'   => 1
        ]);
        $filter = new \Twig_SimpleFunction(
            'rwidget_*_*',
            function($widgetName, $widgetAction, $args = []) {
                $widgetFile = $this->config['base_dir'] . '/' . $this->config['app_dir'] . '/widgets/' . $widgetName . '/' . $widgetAction . ".php";
                $widgetTemplate = '/' . $this->config['app_dir'] . '/templates/_widgets/' . $widgetName . '/' . $widgetAction . '.html';
                if (!file_exists($widgetFile)) {
                    throw new \Exception("<strong>Widget file not found!</strong> " . $widgetName . '/' . $widgetAction . "!");
                }
                require_once $widgetFile;
                $widgetContentFunc = "rwidget_" . $widgetName . "_" . $widgetAction;
                if (function_exists($widgetContentFunc)) {
                    $widgetContent = call_user_func($widgetContentFunc, $args);
                    if (!file_exists($this->config['base_dir'] . $widgetTemplate)) {

This code seems to be duplicated across your project.

                        throw new \Exception("<strong>Widget should return string:</strong> " . $widgetName . '/' . $widgetAction . "!");
                    }
                    return $this->twig->render($widgetTemplate, $widgetContent);
                }
                throw new \Exception("<strong>Widget function not found!</strong> " . $widgetName . '/' . $widgetAction . "!");
            },
            array('is_safe' => array('html'))
        );
        $this->twig->addFunction($filter);
        $this->twig->addGlobal('runtime_config', $this->config);
        $this->twig->addGlobal('url_params', $request->getParams());
    }

    private function notFound($response, $returnType = 'html', $message = "")
    {

        $notFoundTemplate = '/' . $this->config['app_dir'] . '/templates/_404.html';
        if ($returnType == 'json') {
            $response->getBody()->write(json_encode(['status'=>404, 'message'=>$message]));
            return $response->withHeader('Content-Type', 'application/json;charset=utf-8')
                ->withHeader('X-Powered-By', "reformo/rslim")->withStatus(404);
        }
        return $response->withStatus(404)
            ->withHeader('Content-Type', 'text/html')->withHeader('X-Powered-By', "reformo/rslim")
            ->write($this->twig->render($notFoundTemplate, ['message'=>$message]));

    }

}