samsoncms / cms

src/Application.php

<?php
namespace samsoncms\cms;

use samson\core\CompressableExternalModule;
use samson\core\SamsonLocale;
use samsonframework\container\definition\analyzer\annotation\annotation\Service;
use samsonphp\compressor\Compressor;
use samsonphp\event\Event;
use samsonphp\resource\Router;
use samsonphp\router\Module;

/**
 * SamsonCMS external compressible application for integrating
 * @author Vitaly Iegorov <egorov@samsonos.com>
 * @Service("cms")
 */
class Application extends CompressableExternalModule
{
    const EVENT_IS_CMS = 'samsonsms.is.cms';

    /** @var string Module identifier */
    public $id = 'cms';

    public $baseUrl = 'cms';

    /** @var array Collection of SamsonCMS related modules */
    protected $cmsModuleList = [];

    protected $projectModuleList = [];

    /** @var bool Flag that currently we are woring in SamsonCMS */
    protected $isCMS = false;

    protected $template = '';

    //[PHPCOMPRESSOR(remove,start)]

    protected function prepareModuleList()
    {
        $this->cmsModuleList = $this->system->getContainer()->getServices('module');

        // Gather all project specific modules that do not dependent to SamsonCMS
        $parentDependencies = [];
        foreach ($this->cmsModuleList as $id => $module) {
            // Module dependency at project level composer.json and is not this module
            if (array_key_exists('projectRequireDev', $module->composerParameters) && $module->composerParameters['projectRequireDev'] === true && $id !== $this->id()) {
                $parentDependencies = array_merge($module->composerParameters['required'], [$module->composerParameters['composerName']], $parentDependencies);
            }
        }
        // Remove duplicates
        $parentDependencies = array_unique($parentDependencies);

        // Gather project-only related modules
        $this->projectModuleList = [];
        foreach ($this->cmsModuleList as $id => $module) {
            if (!array_key_exists('composerName', $module->composerParameters)) {
                $this->projectModuleList[$id] = $module;
            } elseif (array_key_exists('composerName', $module->composerParameters) && in_array($module->composerParameters['composerName'], $parentDependencies)) {
                $this->projectModuleList[$id] = $module;
            }
            if (!$this->isModuleDependent($module) && $id !== 'core' && !$this->ifModuleRelated($module)) {
                unset($this->cmsModuleList[$id]);
            }
        }
    }

    /**
     * Remove unnecessary modules list for SamsonCMS from loaded modules
     * and return left modules.
     *
     * @param array $otherModuleList List of SamsonCMS unneeded modules
     */
    public function filterModuleList(&$otherModuleList = [])

filterModuleList uses the super-global variable $_SERVER which is generally not recommended.

    {
        $this->prepareModuleList();

        $otherModuleList = $this->projectModuleList;

        /**
         * Change modules list between main web-application and SamsonCMS
         */
        // TODO: As this is processed before routing than we just check URL
        if ($this->isCMS() || strpos($_SERVER['REQUEST_URI'], '/'.$this->id.'/') !== false) {
            // Switch module list to SamsonCMS module list
            $otherModuleList = $this->cmsModuleList;
        }
    }


    /** SamsonCMS preparation stage handler */
    public function prepare()
    {
        /**
         * Subscribe for router resource initialization to remove SamsonCMS modules as we will generate
         * SamsonCMS resources manually
         */
        Event::subscribe(Router::EVENT_START_GENERATE_RESOURCES, [$this, 'filterModuleList']);
    }

    /**
     * If module is dependent from current module through composer.json.
     *
     * @param $module Module for checking
     * @return bool True if module dependent
     */
    protected function isModuleDependent($module)
    {
        return isset($module->composerParameters['composerName']) && in_array($module->composerParameters['composerName'], $this->composerParameters['required']);
    }

    public function getModuleList(& $moduleListArray)
    {
        $this->prepareModuleList();
        $moduleListArray[Router::I_MAIN_PROJECT_TEMPLATE] = $this->projectModuleList;
        $moduleListArray[$this->template] = $this->cmsModuleList;
    }

    //[PHPCOMPRESSOR(remove,end)]


    /**
     * Check if passed module is related to SamsonCMS.
     * Also method stores data to flag variable.
     *
     * @param $module
     *
     * @return bool True if module related to SamsonCMS
     */
    public function ifModuleRelated($module)
    {
        // Analyze if module class or one of its parents has samsoncms\ namespace pattern
        return count(preg_grep('/samsoncms\\\\/i', array_merge(array(get_class($module)), class_parents($module))));
    }

    /**
     * SamsonCMS initialization stage handler
     *
     * @param array $params Initialization parameters
     *
     * @return bool Initialization stage result
     */
    public function init(array $params = array())
    {
        // Old applications main page rendering
        Event::subscribe('template.main.rendered', array($this, 'oldMainRenderer'));

        // Old applications menu rendering
        Event::subscribe('template.menu.rendered', array($this, 'oldMenuRenderer'));

        Event::subscribe('samson.url.build', array($this, 'buildUrl'));

        Event::subscribe('samson.url.args.created', array($this, 'parseUrl'));

        Event::subscribe(Module::EVENT_ROUTE_FOUND, array($this, 'activeModuleHandler'));

        Event::subscribe('samsonphp.router.create.module.routes', array($this, 'updateCMSPrefix'));

        Event::subscribe(Compressor::E_CREATE_MODULE_LIST, array($this, 'getModuleList'));

        //url()->parse();
        $this->template = $this->path() . 'app/view/index.php';

        // Generate resources for new module
        //[PHPCOMPRESSOR(remove,start)]
        //$this->system->module('resourcer')->generateResources($this->cmsModuleList, $this->path() . 'app/view/index.php');
        //[PHPCOMPRESSOR(remove,end)]
    }

    public function isCMS()
    {
        return $this->isCMS;
    }

    public function activeModuleHandler($module)
    {
        // Define if routed module is related to SamsonCMS
        if($this->isCMS = $this->ifModuleRelated($module)){
            // TODO: This should be removed - Reparse url

            url()->parse();

            // Switch template to SamsonCMS
            $this->system->template($this->template, true);

            Event::fire(self::EVENT_IS_CMS, array(&$this));
        }
    }

    /**
     * Callback for adding SamsonCMS related modules prefix to routes.
     *
     * @param $module
     * @param $prefix
     */
    public function updateCMSPrefix($module, &$prefix)
    {
        if (($module->id != $this->id) && $this->ifModuleRelated($module)) {
            $prefix = '/' . $this->baseUrl . $prefix;
        }
    }

    public function buildUrl(&$urlObj, &$httpHost, &$urlParams)
    {
        if ($this->isCMS) {
            if (in_array($urlParams[0], SamsonLocale::get(), true)) {
                array_splice($urlParams, 1, 0, array($this->baseUrl));
                $urlParams = array_values($urlParams);
            } else {
                array_unshift($urlParams, $this->baseUrl);
            }
        }
    }

    public function parseUrl(&$urlObj, &$urlArgs)
    {
        if ($this->isCMS) {
            if (in_array($urlArgs[0], SamsonLocale::get(), true)) {
                unset($urlArgs[1]);
                $urlArgs = array_values($urlArgs);
            } else {
                array_shift($urlArgs);
            }
        }
    }

    public function __base()
    {
        $templateModule = $this->system->module('template');

        // Switch system to SamsonCMS template module
        $this->system->active($templateModule);

        // Call template handler
        $templateModule->__handler();
    }

    public function oldMainRenderer(&$html)
    {
        // Render application main page block
        foreach (\samsoncms\Application::loaded() as $app) {
            // Show only visible apps
            if ($app->hide == false /*&& $app->findView('sub_menu')*/) {
                $html .= $app->main();
            }
        }
    }

    /**
     * @deprecated All application should draw menu block via events
     */
    public function oldMenuRenderer(&$html, &$subMenu)

oldMenuRenderer uses the super-global variable $_SERVER which is generally not recommended.

    {
        // Iterate loaded samson\cms\application
        foreach (\samsoncms\Application::loaded() as $app) {
            // Show only visible apps
            if ($app->hide == false) {
                // Render application menu item
                $html .= m('template')
                    ->view('menu/item')
                    ->active(url()->module == $app->id() ? 'active' : '')
                    ->app($app)
                    ->icon($app->icon)
                    ->name(isset($app->name{0}) ? $app->name : '')
                    ->output();
            }
        }
        $subMenu = '';
        // Find current SamsonCMS application
        if (\samsoncms\Application::find(url()->module, $app/*@var $app App*/)) {
            // If module has sub_menu view - render it
            if ($app->findView('sub_menu')) {
                // Explode url by symbols '/'
                $url = explode('/', $_SERVER['REQUEST_URI']);
                // If isset url with params search and param page equal 0
                if (isset($url[4]) && $url[3] != 'form') {
                    // Default value for search field
                    $paramSearch = urldecode($url[4]);
                    // Set params search
                    $app->set($paramSearch, 'search');
                }
				
                $subMenu .= $app->view('sub_menu')->set(t($app->name, true), 'appName')->output();
            }
        }
    }

    /**
     * @deprecated
     * @return string Page title
     */
    public function oldGetTitle()
    {
        $local   = m('local');
        $current = m();

        return isset($current['title']) ? $current['title'] :
            (isset($local['title']) ? $local['title'] : '');
    }
}