Core\Controller

Complexity

Total Complexity

25

Size/Duplication

Total Lines	266
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	loadModule()	0	14	3
A	getView()	0	4	1
A	__construct()	0	19	2
A	getModuleNamespace()	0	22	4
A	addToDevHelper()	0	10	3
A	sendSessionVars()	0	3	1
A	renderView()	0	15	3
A	devHelper()	0	15	1
A	getSessionVars()	0	3	1
A	index()	0	7	2
A	onlyPost()	0	6	2
A	onlyUser()	0	5	2

<?php

namespace Core;

use Twig\Template;
use Core\Traits\StringFunctions;

/**
 * Class Controller
 * @package Core
 *
 * PHP version 7
 */
abstract class Controller
{
    use StringFunctions;

The trait Core\Traits\StringFunctions requires the property $childNodes which is not provided by Core\Controller.

    /**
     * the data that will be pushed to the view
     * @var array
     */
    protected $data = [];

    /**
     * @var Container dependency injector
     */
    protected $container;

    /**
     * @var Dependency\Session the session handler
     */
    protected $session;

    /**
     * The request object to handle all gets and posts
     * @var Dependency\Request
     *
     */
    protected $request;

    /**
     * The response module to handle response messages
     * @var Dependency\Response
     */
    protected $response;

    protected $cookie;

    /**
     * this will automaticly load all the modules listed and store them as $moduleName in tle class
     * Child classes can call aditional modules by calling $this->
     * @var array List of modules to load
     */
    protected $loadModules = [
        'Csrf',
        'AlertBox',
        'Auth',
        'pagination'
    ];

    /**
     * We need to declare out modules here, else they will be public
     * @var object
     */
    protected $csrf;
    protected $alertBox;
    protected $auth;
    protected $pagination;

    /**
     * Controller constructor.
     * We get the module list and construct it. We can also over wright the module in app but sill has to inherit from core module
     * @param Container $container
     *
     * @throws \ErrorException on module loading error
     * @throws \ReflectionException should never be thrown since only child classes call this
     */
    public function __construct(Container $container)
    {
        $this->container = $container;

        //removing any duplicates that could have been passed in child classes
        $this->loadModules = array_unique($this->loadModules);

        //We load all our module objects into our object
        foreach ($this->loadModules as $loadModule) {
            $this->loadModule($loadModule);
        }
        $this->session = $this->container->getSession();

        $this->request = $container->getRequest(); //adding our request object as it will be needed in the ajax calls
        $this->response = $container->getResponse();
        $this->cookie = $container->getCookie();

        //Setting up csrf token security for all calls
        $this->data['csrf_token'] = $this->csrf->getCsrfKey(); //storing the security id into the data array to be sent to the view and added in the meta head
    }

    /**
     * load the module to the object
     * We look for module in the namespace, then in app and finally in the core.
     * This enables us to over-ride the core or app module with a custom module for the namespace.
     * @param $loadModule string the module to search for and load
     * @throws \ErrorException if module doesn't exits
     * @throws \ReflectionException
     */
    private function loadModule($loadModule)
    {
        $loadModuleName = lcfirst($loadModule);
        $loadModuleObj = $this->getModuleNamespace($loadModule);
        //Modules must be children of the Module template
        if (!is_subclass_of($loadModuleObj, 'Core\Modules\Module')) {
            throw new \ErrorException('Module ' . $loadModuleName . ' must be a sub class of module');
        }
        $loadedModule = new $loadModuleObj($this->container);
        //we are not allowed to create public modules, they must be a placeholder ready
        if (!property_exists($this, $loadModuleName)) {
            throw new \ErrorException('the protected or private variable of ' . $loadModuleName . ' is not present');
        }
        $this->$loadModuleName = $loadedModule;
    }

    /**
     * takes a module to load and verifies if exists in the current namespace modules, app modules or core modules
     * @param $loadModule string Module to look for
     * @return string the full module namespace
     * @throws \ErrorException if no module is found
     * @throws \ReflectionException Should never happen since we are calling on $this
     */
    private function getModuleNamespace($loadModule)
    {
        $childClass = new \ReflectionClass(get_class($this));
        $childClassNamespace = $childClass->getNamespaceName();
        //check in classNameSpace
        if (class_exists($childClassNamespace . '\\Modules\\' . $loadModule)) {
            $this->addToDevHelper('module ' . $loadModule . ' loaded', $childClassNamespace . '\\' . $loadModule);
            return $childClassNamespace . '\\' . $loadModule;
        }
        //check in app
        if (class_exists('App\\Modules\\' . $loadModule)) {
            $this->addToDevHelper('module ' . $loadModule . ' loaded', 'App\\Modules\\' . $loadModule);
            return 'App\\Modules\\' . $loadModule;
        }
        //check in core, send error popup if overcharged
        if (class_exists('Core\\Modules\\' . $loadModule)) {
            $this->addToDevHelper('module ' . $loadModule . ' loaded', 'Core\\Modules\\' . $loadModule);
            return 'Core\\Modules\\' . $loadModule;
        }

        //if we are here then no module found
        throw new \ErrorException('module ' . $loadModule . ' does not exist or not loaded');

    }

    public function index()
    {
        //if no index, then redirect to the home page or throw an error if in dev; just for debugging purposes
        if (Config::DEV_ENVIRONMENT) {
            throw new \ErrorException("no index() available in controller call");
        }
        $this->container->getResponse()->redirect();
    }

    /**
     * Calls the templating engine and returns the rendered view
     *
     * @param $template string the template file name. .twig will be appended
     * @return string the rendered template
     * @throws \Twig_Error_Loader
     * @throws \Twig_Error_Runtime
     * @throws \Twig_Error_Syntax
     */
    public function getView($template)
    {
        $twig = $this->container->getTemplate();
        return $twig->render($template . '.twig', $this->data);
    }

    /**
     * rendering the view
     *
     * @param $template string the template file
     * @throws \Twig_Error_Loader
     * @throws \Twig_Error_Runtime
     * @throws \Twig_Error_Syntax
     * @throws \ReflectionException
     */
    public function renderView($template): void
    {
        //checking if any alerts and pas the to the template
        if ($this->alertBox->alertsPending()) {
            $this->data['alert_messages'] = $this->alertBox->getAlerts();
        }
        //adding the session vars to the page
        $this->sendSessionVars();
        //adding the dev helper to the page
        if (Config::DEV_ENVIRONMENT) {
            $this->devHelper();
        }

        $twig = $this->container->getTemplate();
        $twig->display($template . '.twig', $this->data);
    }

    /**
     * construct a dev helper panel
     * @throws \ReflectionException
     */
    protected function devHelper()
    {
        $this->data['dev'] = true;

        $this->addToDevHelper('Class Methods', get_class_methods(get_class($this)));
        $this->addToDevHelper('Session Vars', $this->session->getAllSessionVars());
        $this->addToDevHelper('uri', $this->container->getRequest()->getUri());
        $childClassNamespace = new \ReflectionClass(get_class($this));
        $childClassNamespace = $childClassNamespace->getNamespaceName();
        $this->addToDevHelper('Child Namespace', $childClassNamespace);

        //for our object variables, we don't want the devinfo
        $objVars = get_object_vars($this);
        unset($objVars['data']['dev_info']);
        $this->addToDevHelper('Object Variables', $objVars);
    }

    /**
     * add info to our dev helper panel
     * @param $name
     * @param $var
     */
    protected function addToDevHelper($name, $var)
    {
        //only populate if in dev environment
        if (Config::DEV_ENVIRONMENT) {
            $classMethods = [];
            $classMethods[$name] = $var;
            if (!isset($this->data['dev_info'])) {
                $this->data['dev_info'] = [];
            }
            $this->data['dev_info'] += $classMethods;
        }
    }

    /**
     * get all the session variables
     * @return mixed
     */
    protected function getSessionVars()
    {
        return $this->container->getSession()->getAllSessionVars();
    }

    /**
     * Send the session variables to the data variable to enable access in twig
     */
    protected function sendSessionVars()
    {
        $this->data['session'] = $this->getSessionVars();
    }

    /**
     * Only allow post messages
     */
    protected function onlyPost()
    {
        //is post
        if (!$this->request->isPost()) {
            $this->alertBox->setAlert('Only post messages allowed', 'error');
            $this->response->redirect('/');
        }
    }

    /**
     * only allow registered users
     */
    protected function onlyUser()
    {
        if (!$this->auth->isUser()) {
            $this->alertBox->setAlert("Only registered users can access this", 'error');
            $this->container->getResponse()->redirect();
        }
    }
}