XCube_Controller.class.php

<?php
 
if ( ! defined( 'XCUBE_CORE_PATH' ) ) {
    define( 'XCUBE_CORE_PATH', __DIR__ );
}
 
require_once XCUBE_CORE_PATH . '/XCube_Root.class.php';
 
require_once XCUBE_CORE_PATH . '/XCube_ActionFilter.class.php';
require_once XCUBE_CORE_PATH . '/XCube_RenderSystem.class.php';
require_once XCUBE_CORE_PATH . '/XCube_Delegate.class.php';
 
require_once XCUBE_CORE_PATH . '/XCube_Object.class.php';
require_once XCUBE_CORE_PATH . '/XCube_Service.class.php';
 
require_once XCUBE_CORE_PATH . '/XCube_Identity.class.php';
require_once XCUBE_CORE_PATH . '/XCube_RoleManager.class.php';
require_once XCUBE_CORE_PATH . '/XCube_Permission.class.php';
 
require_once XCUBE_CORE_PATH . '/XCube_LanguageManager.class.php';
 
require_once XCUBE_CORE_PATH . '/XCube_ActionForm.class.php';
require_once XCUBE_CORE_PATH . '/XCube_TextFilter.class.php';
require_once XCUBE_CORE_PATH . '/XCube_Session.class.php';
 
 
class XCube_Controller {
    public $mRoot;

    public $_mBlockChain = [];
 

    public $_mFilterChain = [];

    public $_mLoadedFilterNames = [];

    public $mDB;

    public $mLocale;

    public $mLanguage;

    public $mSetupUser = null;

    public $mExecute = null;

    public $mSetupTextFilter = null;
 
    public function __construct() {
    // ----- removed by PHP74 refactoring
        $this->_mBlockChain        = [];
        $this->_mFilterChain       = [];
        $this->_mLoadedFilterNames = [];
    // ----- reverse for further testing in XCL 2.5.0
 
        $this->mSetupUser       = new XCube_Delegate();
        $this->mExecute         = new XCube_Delegate();
        $this->mSetupTextFilter = new XCube_Delegate();
        $this->mSetupTextFilter->add( 'XCube_TextFilter::getInstance', XCUBE_DELEGATE_PRIORITY_FINAL );
    }

    public function prepare( &$root ) {
        $this->mRoot =& $root;
 
        $this->mRoot->setDelegateManager( $this->_createDelegateManager() );
        $this->mRoot->setServiceManager( $this->_createServiceManager() );
        $this->mRoot->setPermissionManager( $this->_createPermissionManager() );
        $this->mRoot->setRoleManager( $this->_createRoleManager() );
        $this->mRoot->setContext( $this->_createContext() );
    }

    public function executeCommon() {
        //
        // Setup Filter chain and execute the process of these filters.
        //
        $this->_setupFilterChain();
 
        $this->_processFilter();
 
        $this->_setupEnvironment();
 
        $this->_setupDB();
 
        $this->_setupLanguage();
 
        $this->_setupTextFilter();
 
        $this->_setupConfig();
 
        //
        // Block section
        //
        $this->_processPreBlockFilter();    // action filters which have been loaded to the list of the controller.
 
        $this->_setupSession();
 
        $this->_setupUser();
    }

    public function executeHeader() {
        $this->_setupBlock();
        $this->_processBlock();
    }

    public function execute() {
        $this->mExecute->call( new XCube_Ref( $this ) );
    }

    public function executeView() {
    }

    public function executeForward(string $url, int $time = 0, string $message = null ) {
        // check header output
        header( 'location: ' . $url );
        exit();
    }

    public function executeRedirect(string $url, int $time = 1, string $message = null ) {
        $this->executeForward( $url, $time, $message );
    }

    public function addActionFilter( &$filter ) {
        $this->_mFilterChain[] =& $filter;
    }

    public function _setupFilterChain() {
    }

    public function _setupEnvironment() {
    }

    public function _setupDB() {
    }

    public function &getDB() {
        return $this->mDB;
    }

    public function _setupLanguage() {
        $this->mRoot->mLanguageManager = new XCube_LanguageManager();
    }
 

    public function _setupTextFilter() {
        $textFilter = null;
        $this->mSetupTextFilter->call( new XCube_Ref( $textFilter ) );
        $this->mRoot->setTextFilter( $textFilter );
    }
 

    public function _setupConfig() {
    }

    public function _setupSession() {
        $session = new XCube_Session();
        $this->mRoot->setSession( $session );
 
    }

    public function _setupUser() {
        $this->mSetupUser->call( new XCube_Ref( $this->mRoot->mContext->mUser ), new XCube_Ref( $this ), new XCube_Ref( $this->mRoot->mContext ) );
    }

    public function _processFilter() {
        foreach ( array_keys( $this->_mFilterChain ) as $key ) {
            $this->_mFilterChain[ $key ]->preFilter();
        }
    }

    public function _setupBlock() {
    }

    public function _processBlock() {
        /*  foreach(array_keys($this->mBlockChain) as $key) {
            if ($this->mBlockChain[$key]->hasPermission($this, $this->getUser())) {
                $renderTarget =new XCube_RenderTarget();
                $renderTarget->setType(XCUBE_RENDER_TARGET_TYPE_MAIN);
 
                $this->mBlockChain[$key]->execute($this, $this->getUser(), $renderTarget);
 
                $this->mBlockChain[$key]->mRenderTarget =& $renderTarget;
 
                unset($renderTarget);
            }
        }*/
    }

    public function _processPreBlockFilter() {
        foreach ( array_keys( $this->_mFilterChain ) as $key ) {
            $this->_mFilterChain[ $key ]->preBlockFilter();
        }
    }

    public function _processPostFilter() {
        foreach ( array_reverse( array_keys( $this->_mFilterChain ) ) as $key ) {
            $this->_mFilterChain[ $key ]->postFilter();
        }
    }

    public function _processPreload( $path ) {
        $path = $path . '/';
 
        if ( is_dir( $path ) && ( $files = glob( $path . '/*.class.php' ) ) ) {
            foreach ( $files as $file ) {
                require_once $file;
                $className = basename( $file, '.class.php' );
                if ( XC_CLASS_EXISTS( $className ) && ! isset( $this->_mLoadedFilterNames[ $className ] ) ) {
                    $this->_mLoadedFilterNames[ $className ] = true;
                    $instance                                = new $className( $this );
                    $this->addActionFilter( $instance );
                    unset( $instance );
                }
            }
        }
    }

    public function &_createDelegateManager() {
        $delegateManager = new XCube_DelegateManager();
 
        return $delegateManager;
    }

    public function &_createServiceManager() {
        require_once XCUBE_CORE_PATH . '/XCube_ServiceManager.class.php';
        $serviceManager = new XCube_ServiceManager();
 
        return $serviceManager;
    }

    public function &_createPermissionManager() {
        $chunkName = $this->mRoot->getSiteConfig( 'Cube', 'PermissionManager' );
 
        //
        // FIXME: Access private method.
        //
        $manager =& $this->mRoot->_createInstance( $this->mRoot->getSiteConfig( $chunkName, 'class' ), $this->mRoot->getSiteConfig( $chunkName, 'path' ) );
 
        return $manager;
    }

    public function &_createRoleManager() {
        $chunkName = $this->mRoot->getSiteConfig( 'Cube', 'RoleManager' );
 
        //
        // !FIXME: Access private method.
        //
        $manager =& $this->mRoot->_createInstance( $this->mRoot->getSiteConfig( $chunkName, 'class' ), $this->mRoot->getSiteConfig( $chunkName, 'path' ) );
 
        return $manager;
    }

    public function &_createContext() {
        $context = new XCube_HttpContext();
        $request = new XCube_HttpRequest();
        $context->setRequest( $request );
 
        return $context;
    }
}