o2system / framework

src/Framework.php

<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System;

// ------------------------------------------------------------------------

/*
 * ---------------------------------------------------------------
 * ERROR REPORTING
 * ---------------------------------------------------------------
 *
 * Different environments will require different levels of error reporting.
 * By default development will show errors but testing and live will hide them.
 */

use O2System\Kernel\Http\Message\Uri;

switch (strtoupper(ENVIRONMENT)) {

The constant O2System\ENVIRONMENT was not found. Maybe you did not declare it correctly or list all dependencies?

    case 'DEVELOPMENT':
        error_reporting(-1);
        ini_set('display_errors', 1);
        break;
    case 'TESTING':
    case 'PRODUCTION':
        ini_set('display_errors', 0);
        error_reporting(E_ALL & ~E_NOTICE & ~E_DEPRECATED & ~E_STRICT & ~E_USER_NOTICE & ~E_USER_DEPRECATED);
        break;
    default:
        header('HTTP/1.1 503 Service Unavailable.', true, 503);
        echo 'The application environment is not set correctly.';
        exit(1); // EXIT_ERROR
}

/*
 *---------------------------------------------------------------
 * VENDOR PATH
 *---------------------------------------------------------------
 *
 * RealPath to vendor folder.
 *
 * WITH TRAILING SLASH!
 */
if ( ! defined('PATH_VENDOR')) {
    define('PATH_VENDOR', PATH_ROOT . 'vendor' . DIRECTORY_SEPARATOR);

The constant O2System\PATH_ROOT was not found. Maybe you did not declare it correctly or list all dependencies?

}

/*
 *---------------------------------------------------------------
 * FRAMEWORK PATH
 *---------------------------------------------------------------
 *
 * RealPath to framework folder.
 *
 * WITH TRAILING SLASH!
 */
if ( ! defined('PATH_FRAMEWORK')) {
    define('PATH_FRAMEWORK', __DIR__ . DIRECTORY_SEPARATOR);
}

/*
 *---------------------------------------------------------------
 * APP PATH
 *---------------------------------------------------------------
 *
 * RealPath to application folder.
 *
 * WITH TRAILING SLASH!
 */
if ( ! defined('PATH_APP')) {
    define('PATH_APP', PATH_ROOT . DIR_APP . DIRECTORY_SEPARATOR);

The constant O2System\DIR_APP was not found. Maybe you did not declare it correctly or list all dependencies?

}

/*
 *---------------------------------------------------------------
 * PUBLIC PATH
 *---------------------------------------------------------------
 *
 * RealPath to public folder.
 *
 * WITH TRAILING SLASH!
 */
if ( ! defined('PATH_PUBLIC')) {
    define('PATH_PUBLIC', PATH_ROOT . DIR_PUBLIC . DIRECTORY_SEPARATOR);

The constant O2System\DIR_PUBLIC was not found. Maybe you did not declare it correctly or list all dependencies?

}

/*
 *---------------------------------------------------------------
 * CACHE PATH
 *---------------------------------------------------------------
 *
 * RealPath to writable caching folder.
 *
 * WITH TRAILING SLASH!
 */
if ( ! defined('PATH_CACHE')) {
    define('PATH_CACHE', PATH_ROOT . DIR_CACHE . DIRECTORY_SEPARATOR);

The constant O2System\DIR_CACHE was not found. Maybe you did not declare it correctly or list all dependencies?

}

/*
 *---------------------------------------------------------------
 * STORAGE PATH
 *---------------------------------------------------------------
 *
 * RealPath to writable storage folder.
 *
 * WITH TRAILING SLASH!
 */
if ( ! defined('PATH_STORAGE')) {
    define('PATH_STORAGE', PATH_ROOT . DIR_STORAGE . DIRECTORY_SEPARATOR);

The constant O2System\DIR_STORAGE was not found. Maybe you did not declare it correctly or list all dependencies?

}

/*
 *---------------------------------------------------------------
 * RESOURCES PATH
 *---------------------------------------------------------------
 *
 * RealPath to writable resources folder.
 *
 * WITH TRAILING SLASH!
 */
if ( ! defined('PATH_RESOURCES')) {
    define('PATH_RESOURCES', PATH_ROOT . DIR_RESOURCES . DIRECTORY_SEPARATOR);

The constant O2System\DIR_RESOURCES was not found. Maybe you did not declare it correctly or list all dependencies?

}

/*
 *---------------------------------------------------------------
 * DATABASE PATH
 *---------------------------------------------------------------
 *
 * RealPath to writable database folder.
 *
 * WITH TRAILING SLASH!
 */
if ( ! defined('PATH_DATABASE')) {
    define('PATH_DATABASE', PATH_ROOT . DIR_DATABASE . DIRECTORY_SEPARATOR);

The constant O2System\DIR_DATABASE was not found. Maybe you did not declare it correctly or list all dependencies?

}

/*
 *---------------------------------------------------------------
 * FRAMEWORK CONSTANTS
 *---------------------------------------------------------------
 */
require __DIR__ . '/Config/Constants.php';

/*
 *---------------------------------------------------------------
 * FRAMEWORK HELPERS
 *---------------------------------------------------------------
 */
require __DIR__ . '/Helpers/Framework.php';

/**
 * Class Framework
 *
 * @package O2System
 */
class Framework extends Kernel
{
    /**
     * Framework::$config
     *
     * Framework Container Config
     *
     * @var Framework\Containers\Config
     */
    public $config;

    /**
     * Framework::$globals
     *
     * Framework Container Globals
     *
     * @var Framework\Containers\Globals
     */
    public $globals;

    /**
     * Framework::$environment
     *
     * Framework Container Environment
     *
     * @var Framework\Containers\Environment
     */
    public $environment;

    /**
     * Framework::$models
     *
     * Framework Container Models
     *
     * @var Framework\Containers\Models
     */
    public $models;

    /**
     * Framework::$modules
     *
     * Framework Container Modules
     *
     * @var Framework\Containers\Modules
     */
    public $modules;

    // ------------------------------------------------------------------------

    /**
     * Framework::__construct
     */
    protected function __construct()
    {
        parent::__construct();

        if (profiler() !== false) {
            profiler()->watch('Starting O2System Framework Hooks Pre System');
        }

        $this->services->load(Framework\Services\Hooks::class, 'hooks');

        hooks()->callEvent(Framework\Services\Hooks::PRE_SYSTEM);

        if (profiler() !== false) {
            profiler()->watch('Starting O2System Framework');
        }

        // Add App Views Folder
        output()->addFilePath(PATH_APP);

        if (profiler() !== false) {
            profiler()->watch('Starting Framework Services');
        }

        $services = [
            'Services\Shutdown' => 'shutdown',
            'Services\Logger'   => 'logger',
            'Services\Loader'   => 'loader',
        ];

        foreach ($services as $className => $classOffset) {
            $this->services->load($className, $classOffset);
        }

        // Instantiate Config Container
        if (profiler() !== false) {
            profiler()->watch('Starting Config Container');
        }
        $this->config = new Framework\Containers\Config();

        // Instantiate Globals Container
        if (profiler() !== false) {
            profiler()->watch('Starting Globals Container');
        }
        $this->globals = new Framework\Containers\Globals();

        // Instantiate Environment Container
        if (profiler() !== false) {
            profiler()->watch('Starting Environment Container');
        }
        $this->environment = new Framework\Containers\Environment();

        // Instantiate Models Container
        if (profiler() !== false) {
            profiler()->watch('Starting Models Container');
        }
        $this->models = new Framework\Containers\Models();

        // Instantiate Modules Container
        if (profiler() !== false) {
            profiler()->watch('Starting Modules Container');
        }
        $this->modules = new Framework\Containers\Modules();

        if (config()->loadFile('cache') === true) {

The method loadFile() does not exist on O2System\Kernel\DataStructures\Config.

            // Instantiate Cache Service
            if (profiler() !== false) {
                profiler()->watch('Starting Cache Service');
            }

            $this->services->add(new Framework\Services\Cache(config('cache', true)), 'cache');

It seems like config('cache', true) can also be of type O2System\Framework\Containers\Config; however, parameter $config of O2System\Framework\Services\Cache::__construct() does only seem to accept O2System\Cache\DataStructures\Config, maybe add an additional type check?

            // Language Service Load Registry
            if (profiler() !== false) {
                profiler()->watch('Loading Language Registry');
            }

            language()->loadRegistry();

The method loadRegistry() does not exist on O2System\Kernel\Services\Language. Are you sure you never get this type here, but always one of the subclasses?

            // Modules Service Load Registry
            if (profiler() !== false) {
                profiler()->watch('Loading Modules Registry');
            }
            $this->modules->loadRegistry();
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Framework::__reconstruct
     */
    protected function __reconstruct()
    {
        // Modules default app
        if (null !== ($defaultApp = config('app'))) {

The condition null !== $defaultApp = config('app') is always true.

            if (false !== ($defaultModule = modules()->getApp($defaultApp))) {

It seems like $defaultApp can also be of type O2System\Framework\Containers\Config; however, parameter $segment of O2System\Framework\Containers\Modules::getApp() does only seem to accept string, maybe add an additional type check?

The method getApp() does not exist on O2System\Framework\Containers\Modules\DataStructures\Module.

                // Register Domain App Module Namespace
                loader()->addNamespace($defaultModule->getNamespace(), $defaultModule->getRealPath());

                // Push Domain App Module
                modules()->push($defaultModule);

The method push() does not exist on O2System\Framework\Containers\Modules\DataStructures\Module.

            } elseif (false !== ($defaultModule = modules()->getModule($defaultApp))) {

It seems like $defaultApp can also be of type O2System\Framework\Containers\Config; however, parameter $segments of O2System\Framework\Containers\Modules::getModule() does only seem to accept array|string, maybe add an additional type check?

The method getModule() does not exist on O2System\Framework\Containers\Modules\DataStructures\Module.

                // Register Path Module Namespace
                loader()->addNamespace($defaultModule->getNamespace(), $defaultModule->getRealPath());

                // Push Path Module
                modules()->push($defaultModule);
            }
        }

        if (profiler() !== false) {
            profiler()->watch('Calling Hooks Service: Post System');
        }
        hooks()->callEvent(Framework\Services\Hooks::POST_SYSTEM);

        if (is_cli()) {
            $this->cliHandler();
        } else {
            $this->httpHandler();
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Framework::cliHandler
     *
     * @return void
     * @throws \O2System\Spl\Exceptions\RuntimeException
     * @throws \ReflectionException
     */
    private function cliHandler()
    {
        // Instantiate CLI Router Service
        $this->services->load(Kernel\Cli\Router::class);

        if (profiler() !== false) {
            profiler()->watch('Parse Router Request');
        }
        router()->handle();

        if ($commander = router()->getCommander()) {

The method getCommander() does not exist on O2System\Framework\Http\Router.

            if ($commander instanceof Kernel\Cli\Router\DataStructures\Commander) {

$commander is always a sub-type of O2System\Kernel\Cli\Router\DataStructures\Commander.

                // Autoload Language
                language()->loadFile($commander->getParameter());
                language()->loadFile($commander->getRequestMethod());
                language()->loadFile($commander->getParameter() . '/' . $commander->getRequestMethod());

                $modules = $this->modules->getArrayCopy();

                // Run Module Autoloader
                foreach ($modules as $module) {
                    if (in_array($module->getType(), ['KERNEL', 'FRAMEWORK'])) {
                        continue;
                    }
                    $module->loadModel();
                }

                // Autoload Model
                $modelClassName = str_replace('Commanders', 'Models', $commander->getName());

                if (class_exists($modelClassName)) {
                    $this->models->load($modelClassName, 'commander');
                }

                // Initialize Commander
                if (profiler() !== false) {
                    profiler()->watch('Calling Hooks Service: Pre Commander');
                }
                hooks()->callEvent(Framework\Services\Hooks::PRE_COMMANDER);

                if (profiler() !== false) {
                    profiler()->watch('Instantiating Requested Commander: ' . $commander->getClass());
                }
                $requestCommander = $commander->getInstance();

                if (profiler() !== false) {
                    profiler()->watch('Calling Hooks Service: Post Commander');
                }
                hooks()->callEvent(Framework\Services\Hooks::POST_COMMANDER);

                if (profiler() !== false) {
                    profiler()->watch('Execute Requested Commander: ' . $commander->getClass());
                }

                $requestCommander->__call($commander->getRequestMethod());

                exit(EXIT_SUCCESS);

Using exit here is not recommended.

            }
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Framework::httpHandler
     *
     * @return void
     * @throws \O2System\Spl\Exceptions\RuntimeException
     * @throws \ReflectionException
     */
    private function httpHandler()
    {
        if (config()->loadFile('view') === true) {
            // Instantiate Http UserAgent Service
            $this->services->load(Framework\Http\UserAgent::class, 'userAgent');

            // Instantiate Http View Service
            $this->services->load(Framework\Http\Parser::class);

            // Instantiate Http View Service
            $this->services->load(Framework\Http\View::class);

            // Instantiate Http Presenter Service
            $this->services->load(Framework\Http\Presenter::class);
        }

        // Instantiate Http Router Service
        $this->services->load(Framework\Http\Router::class);

        if (profiler() !== false) {
            profiler()->watch('Parse Router Request');
        }
        router()->handle(new Uri());

The call to O2System\Kernel\Cli\Router::handle() has too many arguments starting with new O2System\Kernel\Http\Message\Uri().

        if (config()->loadFile('session') === true) {

            // Instantiate Session Service
            $session = new Session(config('session', true));

It seems like config('session', true) can also be of type O2System\Framework\Containers\Config; however, parameter $config of O2System\Session::__construct() does only seem to accept O2System\Kernel\DataStructures\Config, maybe add an additional type check?

            $session->setLogger($this->services->get('logger'));

            if ( ! $session->isStarted()) {
                $session->start();
            }

            $this->services->add($session, 'session');

            if ($session->has('language') and $this->services->has('language')) {
                language()->setDefault($session->get('language'));

It seems like $session->get('language') can also be of type false; however, parameter $default of O2System\Kernel\Services\Language::setDefault() does only seem to accept string, maybe add an additional type check?

            } else {
                $session->set('language', language()->getDefault());
            }

            if (config('security')->protection[ 'csrf' ] === true) {

The property protection does not exist on O2System\Framework\Containers\Config. Since you implemented __get, consider adding a @property annotation.

                $csrfProtection = new Security\Protections\Csrf();
                $this->services->add($csrfProtection, 'csrfProtection');
            }

            if (config('security')->protection[ 'xss' ] === true) {
                $xssProtection = new Security\Protections\Xss();
                $this->services->add($xssProtection, 'xssProtection');
            }
        }

        // Instantiate Http Middleware Service
        $this->services->load(Framework\Http\Middleware::class);

        if (profiler() !== false) {
            profiler()->watch('Running Middleware Service: Pre Controller');
        }
        middleware()->run();

        if ($this->services->has('controller')) {
            $controller = $this->services->get('controller');

            $controllerParameter = dash($controller->getParameter());
            $controllerRequestMethod = dash($controller->getRequestMethod());

            $modules = $this->modules->getArrayCopy();
            
            // Run Module Autoloader
            foreach ($modules as $module) {
                if (in_array($module->getType(), ['KERNEL', 'FRAMEWORK'])) {
                    continue;
                }

                // Autoload Module Language
                if ($this->services->has('language')) {
                    language()->loadFile($module->getParameter());
                }

                // Autoload Module Model
                $module->loadModel();

                // Add View Resource Directory
                if($this->services->has('view')) {
                    view()->addFilePath($module->getResourcesDir());
                    presenter()->assets->pushFilePath($module->getResourcesDir());
                }
            }
            
            if ($this->services->has('view')) {
                presenter()->initialize();
            }

            // Autoload Language
            if ($this->services->has('language')) {
                language()->loadFile($controller->getParameter());
                language()->loadFile($controller->getRequestMethod());
                language()->loadFile($controller->getParameter() . '/' . $controller->getRequestMethod());
            }

            // Autoload Model
            $modelClassName = str_replace(['Controllers', 'Presenters'], 'Models', $controller->getName());

            if (class_exists($modelClassName)) {
                $this->models->load($modelClassName, 'controller');
            }

            if ($this->services->has('view')) {
                // Autoload Presenter
                $presenterClassName = str_replace('Controllers', 'Presenters', $controller->getName());

                if (class_exists($presenterClassName)) {
                    $presenterClassObject = new $presenterClassName();
                    if ($presenterClassObject instanceof Framework\Http\Presenter) {
                        $this->services->add($presenterClassObject, 'presenter');
                    }
                }
            }

            // Initialize Controller
            if (profiler() !== false) {
                profiler()->watch('Calling Hooks Service: Pre Controller');
            }

            hooks()->callEvent(Framework\Services\Hooks::PRE_CONTROLLER);

            if (profiler() !== false) {
                profiler()->watch('Instantiating Requested Controller: ' . $controller->getClass());
            }

            $requestController = $controller->getInstance();

            if (method_exists($requestController, '__reconstruct')) {
                $requestController->__reconstruct();
            }

            if (profiler() !== false) {
                profiler()->watch('Calling Hooks Service: Post Controller');
            }
            hooks()->callEvent(Framework\Services\Hooks::POST_CONTROLLER);

            if (profiler() !== false) {
                profiler()->watch('Calling Middleware Service: Post Controller');
            }
            middleware()->run();

            $requestMethod = $controller->getRequestMethod();
            $requestMethodArgs = $controller->getRequestMethodArgs();

            // Call the requested controller method
            if (profiler() !== false) {
                profiler()->watch('Execute Requested Controller Method');
            }

            ob_start();
            $requestController->__call($requestMethod, $requestMethodArgs);
            $requestControllerOutput = ob_get_contents();
            ob_end_clean();

            if (is_numeric($requestControllerOutput)) {
                output()->sendError($requestControllerOutput);

$requestControllerOutput of type string is incompatible with the type integer expected by parameter $code of O2System\Kernel\Cli\Output::sendError().

$requestControllerOutput of type string is incompatible with the type integer expected by parameter $code of O2System\Kernel\Http\Output::sendError().

            } elseif (is_bool($requestControllerOutput)) {

The condition is_bool($requestControllerOutput) is always false.

                if ($requestControllerOutput === true) {
                    output()->sendError(200);
                } elseif ($requestControllerOutput === false) {
                    output()->sendError(204);
                }
            } elseif (is_array($requestControllerOutput) or is_object($requestControllerOutput)) {

The condition is_object($requestControllerOutput) is always false.

                output()->sendPayload($requestControllerOutput);
            } elseif ($requestController instanceof Framework\Http\Controllers\Restful) {
                if (empty($requestControllerOutput)) {
                    $requestController->sendError(204);
                } elseif (is_string($requestControllerOutput)) {

The condition is_string($requestControllerOutput) is always true.

                    if (is_json($requestControllerOutput)) {
                        output()->setContentType('application/json');

The method setContentType() does not exist on O2System\Kernel\Cli\Output.

                    } else {
                        output()->setContentType('text/plain');
                    }

                    echo $requestControllerOutput;
                }
            } elseif (is_string($requestControllerOutput)) {

The condition is_string($requestControllerOutput) is always true.

                if (is_json($requestControllerOutput)) {
                    output()->setContentType('application/json');
                    echo $requestControllerOutput;
                } elseif ($this->services->has('view')) {
                    if (empty($requestControllerOutput)) {
                        $filenames = [
                            $controllerRequestMethod,
                            $controllerParameter . DIRECTORY_SEPARATOR . $controllerRequestMethod,
                        ];

                        if ($controllerRequestMethod === 'index') {
                            array_unshift($filenames, $controllerParameter);
                        }

                        foreach ($filenames as $filename) {
                            if (false !== ($filePath = view()->getFilePath($filename))) {
                                view()->load($filePath);
                                break;
                            }
                        }
                    } else {
                        presenter()->partials->offsetSet('content', $requestControllerOutput);
                    }

                    if (presenter()->partials->offsetExists('content')) {
                        if(is_ajax()) {
                            echo presenter()->partials->content;

The property content does not exist on O2System\Framework\Http\Presenter\Repositories\Partials. Since you implemented __get, consider adding a @property annotation.

                        } else {
                            $htmlOutput = view()->render();

                            if (empty($htmlOutput)) {
                                output()->sendError(204);
                            } else {
                                output()->setContentType('text/html');
                                output()->send($htmlOutput);

The method send() does not exist on O2System\Kernel\Cli\Output.

                            }
                        }
                    } else {
                        output()->sendError(204);
                    }
                } elseif (empty($requestControllerOutput) or $requestControllerOutput === '') {
                    output()->sendError(204);
                } else {
                    output()->setContentType('text/plain');
                    output()->send($requestControllerOutput);
                }
            }
        } else {
            // Show Error (404) Page Not Found
            output()->sendError(404);
        }
    }
}