module/abstract.class.php

Go to the documentation of this file.

<?php
abstract class module_abstract extends object {

        protected $prmExec;

        protected $tpl;

        protected function afterInit() {
                if ($this->cfg->forceSecure)
                        request::forceSecure();

                if (!$this->cfg->enabled)
                        throw new module_exception('Module '.$this->getName().' disabled.');
        }

        final public function exec(array $prm=array()) {
                $this->prmExec = array_merge(array(
                        'module'=>$this->getName(),
                        'action'=>'index',
                        'param'=>'',
                        'paramA'=>null,
                        'prefix'=>null),
                        $prm);

                $this->prmExec['prefix'] = null;

                if (array_key_exists(NYROENV, $this->cfg->basicPrefixExec) &&
                                in_array($this->prmExec['action'], $this->cfg->getInArray('basicPrefixExec', NYROENV)))
                        $this->prmExec['prefix'] = ucfirst(NYROENV);
                else if ($this->cfg->prefixExec && !in_array($this->prmExec['action'], $this->cfg->noPrefixExec))
                        $this->prmExec['prefix'] = $this->cfg->prefixExec;

                $this->beforeExec($prm);

                if (!$this->cfg->render)
                        security::getInstance()->check($this->prmExec);

                $fctName = ($this->cfg->render? 'render' : 'exec').$this->prmExec['prefix'].ucfirst($this->prmExec['action']);
                if (!method_exists($this, $fctName))
                        response::getInstance()->error();

                $this->setViewAction($this->prmExec['action']);

                $param = is_array($this->prmExec['paramA'])? $this->prmExec['paramA'] : request::parseParam($this->prmExec['param']);

                $tags = $this->cfg->cacheTags;
                $search = array('/', '<', '>');
                $replace = array('', '', '');
                if (is_array($this->prmExec['paramA']))
                        foreach($this->prmExec['paramA'] as $k=>$v) {
                                if (is_object($v)) {
                                        if (is_callable(array($v, '__toString')))
                                                $tags[] = $k.'='.$v;
                                        else
                                                $tags[] = $k.'='.get_class($v);
                                } elseif (!is_numeric($k))
                                        $tags[] = $k.'='.str_replace($search, $replace, $v);
                                else
                                        $tags[] = str_replace($search, $replace, $v);
                        }

                $paramTpl = array();
                foreach($param as $k=>$v) {
                        if (is_object($v)) {
                                if (is_callable(array($v, '__toString')))
                                        $paramTpl[] = $k.'='.$v;
                                else
                                        $paramTpl[] = $k.'='.get_class($v);
                        } else
                                $paramTpl[] = $k.':'.$v;
                }

                $conf = array(
                        'layout'=>$this->cfg->layout,
                        'module'=>$this->getName(),
                        'action'=>$this->cfg->viewAction,
                        'param'=>implode(',', $paramTpl),
                        'cache'=>array_merge(array(
                                'enabled'=>$this->isCacheEnabled(),
                                'serialize'=>false,
                                'tags'=>$tags,
                                'request'=>array('uri'=>false, 'meth'=>array())
                        ), $this->cfg->cache)
                );
                $this->tpl = factory::get('tpl', array_merge_recursive($conf, $this->cfg->tplPrm));
                $this->tpl->getCfg()->layout = $this->cfg->layout;
                $this->tpl->getCfg()->module = $this->getName();
                $this->tpl->getCfg()->action = $this->cfg->viewAction;
                $this->tpl->getCfg()->default = $this->cfg->viewAction;
                
                $this->prmExec['callbackPrm'] = array(
                        'fctName'=>$fctName,
                        'fctNameParam'=>$param,
                        'prm'=>$prm
                );
                $this->middleExec($prm);
        }

        public function callbackTpl(array $prm) {
        $this->{$prm['fctName']}($prm['fctNameParam']);
                $this->afterExec($prm['prm']);
                return $this->getViewAction();
        }

        public function getResponse() {
                return $this->tpl->getResponseProxy();
        }

        protected function beforeExec($realExec) {}

        protected function middleExec($realExec) {}

        protected function afterExec($realExec) {}

        protected function getViewAction() {
                return $this->cfg->viewAction;
        }

        protected function setViewAction($action) {
                $this->cfg->viewAction = $action;
                if ($this->tpl) {
                        $this->tpl->getCfg()->action = $this->cfg->viewAction;
                        $this->tpl->getCfg()->default = $this->cfg->viewAction;
                }
        }

        protected function getViewVar($name) {
                return $this->tpl->get($name);
        }

        protected function setViewVar($name, $value) {
                $this->tpl->set($name, $value);
        }

        protected function setViewVars(array $values) {
                $this->tpl->setA($values);
        }

        public function publish(array $prm = array()) {
                if (!$this->cfg->viewAction)
                        return null;
                $this->preFetch();
                return $this->tpl->fetch(array_merge(array(
                        'callback'=>array($this, 'callbackTpl'),
                        'callbackPrm'=>$this->prmExec['callbackPrm'],
                ), $prm));
        }

        protected function preFetch() {}

        protected function isCacheEnabled() {
                $url = $this->prmExec;
                if (utils::isContained($url, $this->cfg->noCache))
                        return false;
                if (utils::isContained($url, $this->cfg->forceCache))
                        return true;
                return $this->cfg->defaultCache;
        }

        protected function addCacheTag($val) {
                $this->cfg->setInArrayA('cacheTags', array($val));
                if ($this->tpl) {
                        $this->tpl->getCfg()->setInarray('cache', 'tags', $this->cfg->cacheTags);
                }
        }

        public function getName() {
                return utils::getModuleName(get_class($this));
        }

}