Changeset 15897 for trunk/templates

Timestamp:

01/18/12 23:41:12 (4 months ago)

Author:

Alexander Trofimov

Message:

Page - refactoring, docs, cache implementation.

Location:

trunk/templates/base

Files:

• _header.html (modified) (1 diff)
• scripts/BxBasePage.php (modified) (7 diffs)

trunk/templates/base/_header.html

@@ -7 +7 @@
     __page_description__
     __page_keywords__
+    __page_robots__
 
     <meta http-equiv="Content-Style-Type" content="text/css" />

trunk/templates/base/scripts/BxBasePage.php

@@ -17 +17 @@
 
     protected $_oTemplate;
+    protected $_oPageCacheObject = null;
 
     public function __construct ($aObject, $oTemplate) {
@@ -27 +28 @@
     }
 
-
-    public function getCode () {                
+    /**
+     * Get page code with automatic caching, adding necessary css/js files and system template vars. 
+     * @return string.
+     */
+    public function getCode () {
 
         if (!$this->_isVisiblePage($this->_aObject))
-            return MsgBox(_t('_Access denied'));
-
+            return $this->_getPageAccessDeniedMsg ();
+
+        $this->_addJsCss();
+ 
+        $this->_addSysTemplateVars();
+
+        // TODO: insert profiler call here 
+
+        if (!getParam('sys_page_cache_enable') || !$this->_aObject['cache_server'])
+            return $this->_getPageCode();
+        
+        $oCache = $this->_getPageCacheObject();
+        $sKey = $this->_getPageCacheKey();
+
+        $mixedRet = $oCache->getData($sKey, $this->_aObject['cache_server']);
+
+        if ($mixedRet !== null) {
+            return $mixedRet;
+        } else {
+            $sPageCode = $this->_getPageCode();
+            $oCache->setData($sKey, $sPageCode, $this->_aObject['cache_server']);
+        }        
+
+        return $sPageCode;
+    }
+    
+    /**
+     * Get page code only.
+     * @return string
+     */
+    protected function _getPageCode () {
         $aVars = array ();
         $aBlocks = $this->_oQuery->getPageBlocks();
@@ -38 +71 @@
             $sCell = '';
             foreach ($aCell as $aBlock) {
-
-                if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->beginPageBlock(_t($aBlock['title']), $aBlock['id']);
-
-                if (!$this->_isVisibleBlock($aBlock))
-                    continue;
-
-                $sFunc = '_getBlock' . ucfirst($aBlock['type']);
-                $mixedContent = $this->$sFunc($aBlock);
-
-                if (is_array($mixedContent)) {
-                    // TODO: get top, bottom, content code from array
-                } elseif (is_string($mixedContent)) {
-                    $sContentWithBox = DesignBoxContent(_t($aBlock['title']), $mixedContent, $aBlock['designbox_id']);
-                } else {
-                    $sContentWithBox = false;
-                }
+                $sContentWithBox = $this->_getBlockCode($aBlock);
                 if ($sContentWithBox)
                     $sCell .= '<div class="bx-page-block-container" id="bx-page-block-' . $aBlock['id'] . '">' . $sContentWithBox . '</div>';
-
-                if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->endPageBlock($aBlock['id'], $sContentWithBox ? false : true, false );
             }
             $aVars[$sKey] = $sCell;
         }
-        $this->_addJsCss();
-    
+
         return $this->_oTemplate->parseHtmlByName($this->_aObject['template'], $aVars);
     }
-    
+
+    /**
+     * Get block code.
+     * @return string
+     */
+    protected function _getBlockCode($aBlock) {
+        $sContentWithBox = '';
+
+        if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->beginPageBlock(_t($aBlock['title']), $aBlock['id']);
+
+        if ($this->_isVisibleBlock($aBlock)) {
+            $sFunc = '_getBlock' . ucfirst($aBlock['type']);
+            $mixedContent = $this->$sFunc($aBlock);
+
+            if (is_array($mixedContent)) {
+                // TODO: get menu from array
+                if (isset($mixedContent['content']))
+                    $sContentWithBox = DesignBoxContent(_t($aBlock['title']), $mixedContent['content'], $aBlock['designbox_id']);
+            } elseif (is_string($mixedContent)) {
+                $sContentWithBox = DesignBoxContent(_t($aBlock['title']), $mixedContent, $aBlock['designbox_id']);
+            } else {
+                $sContentWithBox = false;
+            }
+        }
+
+        if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->endPageBlock($aBlock['id'], $sContentWithBox ? false : true, false );
+
+        return $sContentWithBox;
+    }
+
+    /**
+     * Add necessary js and css files.
+     */
     protected function _addJsCss() {
         $this->_oTemplate->addCss('page_layouts.css');
     }
 
+    /**
+     * Set system template variables, like page title, meta description, meta keywords and meta robots.
+     */
+    protected function _addSysTemplateVars () {
+        $sPageTitle = $this->_getPageTitle();
+        if ($sPageTitle)
+            $this->_oTemplate->setPageHeader ($sPageTitle);
+   
+        $sMetaDesc = $this->_getPageMetaDesc();
+        if ($sMetaDesc)
+            $this->_oTemplate->setPageDescription ($sMetaDesc);
+
+        $sMetaKeywords = $this->_getPageMetaKeywords();
+        if ($sMetaKeywords)
+            $this->_oTemplate->addPageKeywords ($sMetaKeywords);
+
+        $sMetaRobots = $this->_getPageMetaRobots();
+        if ($sMetaRobots)
+            $this->_oTemplate->setPageMetaRobots ($sMetaRobots);
+    }
+
+    /**
+     * Get content for 'raw' block type.
+     * @return string
+     */
     protected function _getBlockRaw ($aBlock) {
         return $aBlock['content'];
     }
 
+    /**
+     * Get content for 'html' block type.
+     * @return string
+     */
     protected function _getBlockHtml ($aBlock) {
         return $this->_getBlockRaw ($aBlock);
     }
 
+    /**
+     * Get content for 'lang' block type.
+     * @return string
+     */
     protected function _getBlockLang ($aBlock) {
         return _t(trim($aBlock['content']));
     }
 
+    /**
+     * Get content for 'image' block type.
+     * @return string
+     */
     protected function _getBlockImage ($aBlock) {
         // TODO:
@@ -87 +171 @@
     }
 
+    /**
+     * Get content for 'rss' block type.
+     * @return string
+     */
     protected function _getBlockRss ($aBlock) {
         list( $sUrl, $iNum ) = explode( '#', $sContent );
@@ -95 +183 @@
     }
 
+    /**
+     * Get content for 'menu' block type.
+     * @return string
+     */
     protected function _getBlockMenu ($aBlock) {
         bx_import('BxTemplMenu');
@@ -101 +193 @@
     }
 
+    /**
+     * Get content for 'service' block type.
+     * @return string
+     */
     protected function _getBlockService ($aBlock) {
         $a = @unserialize($aBlock['content']);
@@ -107 +203 @@
         return BxDolService::call($a['module'], $a['method'], $a['params']);
     }
+
+    /**
+     * Get page title.
+     * @return string
+     */
+    protected function _getPageTitle() {
+        return _t($this->_aObject['title']);
+    }
+
+    /**
+     * Get page meta description.
+     * @return string
+     */
+    protected function _getPageMetaDesc() {
+        return _t($this->_aObject['meta_description']);
+    }
+
+    /**
+     * Get page meta keywords.
+     * @return string
+     */
+    protected function _getPageMetaKeywords() {
+        return _t($this->_aObject['meta_keywords']);
+    }
+
+    /**
+     * Get page meta robots.
+     * @return string
+     */
+    protected function _getPageMetaRobots() {
+        return _t($this->_aObject['meta_robots']);
+    }
+
+    /**
+     * Get access denied message HTML.
+     * @return string
+     */
+    protected function _getPageAccessDeniedMsg () {
+        return MsgBox(_t('_Access denied'));
+    }
+
+
+    /**
+     * Get page cache object.
+     * @return cache object instance
+     */
+    protected function _getPageCacheObject () {
+        if ($this->_oPageCacheObject != null) {
+            return $this->_oPageCacheObject;
+        } else {
+            $sEngine = getParam('sys_page_cache_engine');
+            $this->_oPageCacheObject = bx_instance ('BxDolCache' . $sEngine);
+            if (!$this->_oPageCacheObject->isAvailable())
+                $this->_oPageCacheObject = bx_instance ('BxDolCacheFile');
+            return $this->_oPageCacheObject;
+        }
+    }
+
+    /**
+     * Get page cache key.
+     * @param $isPrefixOnly return key prefix only.
+     * @return string
+     */
+    protected function _getPageCacheKey ($isPrefixOnly = false) {
+        $s = 'page_' . $this->_aObject['object'] . '_';
+        if ($isPrefixOnly)
+            return $s;
+        $s .= $this->_getPageCacheParams ();
+        $s .= md5(BX_DOL_VERSION . BX_DOL_BUILD . BX_DOL_URL_ROOT) . '.php';
+        return $s;
+    }
+
+    /**
+     * Additional cache key. In the case of dynamic page. 
+     * For example - profile page, where each profile has own page.
+     * @return string
+     */
+    protected function _getPageCacheParams () {
+        return '';
+    }
+
+    /**
+     * Clean page cache.
+     * @param $isDelAllWithPagePrefix delete cache by prefix, it can be used for dynamic pages, like profile view, where for each profile separate cache is generated.
+     * @return string
+     */
+    protected function cleanCache ($isDelAllWithPagePrefix = false) {
+        $oCache = $this->_getPageCacheObject ();
+        $sKey = $this->_getPageCacheKey($isDelAllWithPagePrefix);
+
+        if ($isDelAllWithPagePrefix)
+            return $oCache->removeAllByPrefix($sKey);
+        else
+            return $oCache->delData($sKey);
+    }
 }