Controller

Complexity

Total Complexity

14

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setModuleNameFromRouter()	0	4	3
A	__construct()	0	30	2
A	setCacheFromParamOrConfig()	0	9	4
A	setLanguages()	0	9	3
A	loadRequiredResources()	0	9	1
A	get_instance()	0	2	1

<?php
    defined('ROOT_PATH') || exit('Access denied');
    /**
     * TNH Framework
     *
     * A simple PHP framework using HMVC architecture
     *
     * This content is released under the GNU GPL License (GPL)
     *
     * Copyright (C) 2017 Tony NGUEREZA
     *
     * This program is free software; you can redistribute it and/or
     * modify it under the terms of the GNU General Public License
     * as published by the Free Software Foundation; either version 3
     * of the License, or (at your option) any later version.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program; if not, write to the Free Software
     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
     */

    class Controller extends BaseClass {
		
        /**
         * The name of the module if this controller belong to an module
         * @var string
         */
        public $moduleName = null;

        /**
         * The singleton of the super object
         * @var Controller
         */
        private static $instance;


        /**
         * Class constructor
         */
        public function __construct() {
            parent::__construct();
			
            //instance of the super object
            self::$instance = & $this;

            //Load the resources loaded during the application bootstrap
            $this->logger->debug('Adding the loaded classes to the super instance');
            foreach (class_loaded() as $var => $class) {
                $this->$var = & class_loader($class);
            }
			
            //set module using the router
            $this->setModuleNameFromRouter();

            //load the required resources
            $this->loadRequiredResources();

            //set application
            $this->setLanguages();
			
            //set the cache using the configuration
            $this->setCacheFromParamOrConfig(null);
			
            //set application session configuration
            $this->logger->debug('Setting PHP application session handler');
            set_session_config();

            //dispatch the loaded instance of super controller event
            $this->eventdispatcher->dispatch('SUPER_CONTROLLER_CREATED');
        }


        /**
         * This is a very useful method it's used to get the super object instance
         * @return Controller the super object instance
         */
        public static function &get_instance(){
            return self::$instance;
        }

        /**
         * This method is used to set the module name
         */
        protected function setModuleNameFromRouter() {
            //set the module using the router instance
            if (isset($this->router) && $this->router->getModule()) {
                $this->moduleName = $this->router->getModule();
            }
        }

        /**
         * Set the cache using the argument otherwise will use the configuration
         * @param CacheInterface $cache the implementation of CacheInterface if null will use the configured
         */
        protected function setCacheFromParamOrConfig(CacheInterface $cache = null) {
            $this->logger->debug('Setting the cache handler instance');
            //set cache handler instance
            if (get_config('cache_enable', false)) {
                if ($cache !== null) {
                    $this->cache = $cache;

The property cache does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                } else if (isset($this->{strtolower(get_config('cache_handler'))})) {
                    $this->cache = $this->{strtolower(get_config('cache_handler'))};
                    unset($this->{strtolower(get_config('cache_handler'))});
                } 
            }
        }


        /**
         * This method is used to load the required resources for framework to work
         * @return void 
         */
        private function loadRequiredResources() {
            $this->logger->debug('Loading the required classes into super instance');
            $this->eventdispatcher = & class_loader('EventDispatcher', 'classes');

The property eventdispatcher does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->loader = & class_loader('Loader', 'classes');
            $this->lang = & class_loader('Lang', 'classes');
            $this->request = & class_loader('Request', 'classes');
            //dispatch the request instance created event
            $this->eventdispatcher->dispatch('REQUEST_CREATED');
            $this->response = & class_loader('Response', 'classes', 'classes');
        }

        /**
         * Set the application supported languages
         */
        private function setLanguages() {
            //add the supported languages ('key', 'display name')
            $languages = get_config('languages', null);
            if (!empty($languages)) {
                foreach ($languages as $key => $displayName) {
                    $this->lang->addLang($key, $displayName);
                }
            }
            unset($languages);
        }

    }