Changeset 15749 for trunk/inc

Timestamp:

12/12/11 01:37:22 (6 months ago)

Author:

Alexander Trofimov

Message:

Menu

Location:

trunk/inc/classes

Files:

• BxDolMenu.php (modified) (1 diff)
• BxDolMenuQuery.php (added)
• BxDolTemplate.php (modified) (2 diffs)

trunk/inc/classes/BxDolMenu.php

@@ -1 @@
-<?php
+<?php defined('BX_DOL') or die('hack attempt');
 /**
- * @package     Dolphin Core
- * @copyright   Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
- * @license     CC-BY - http://creativecommons.org/licenses/by/3.0/
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
  */
-defined('BX_DOL') or die('hack attempt');
 
-bx_import('BxDol');
+bx_import('BxDolMenuQuery');
+bx_import('BxDolPermalinks');
+
+/** 
+ * @page objects 
+ * @section menu Menu
+ * @ref BxDolMenu
+ */
+
+/**
+ * Menus. 
+ *
+ * It allows to display menu using different templates.
+ */
 
 class BxDolMenu extends BxDol {
 
-    var $isInitialized = false;
+    protected static $SEL_MODULE = '';
+    protected static $SEL_NAME = '';
 
-    var $sCacheFile;
+    protected $_sObject;
+    protected $_aObject;
+    protected $_oQuery;
+    protected $_oPermalinks;
+    protected $_aMarkers = array ();
 
-    var $aTopMenu = array();
-    var $aMenuInfo = array('currentCustom' => -1, 'currentTop' => -1);
+    /**
+     * Constructor
+     * @param $aObject array of menu options
+     */
+    public function __construct($aObject) {
+        parent::__construct();
 
-    var $oPermalinks;
-    var $aCustomBreadcrumbs = array ();
-
-    function BxDolMenu() {
-
-        if (isset($GLOBALS['bxDolClasses'][get_class($this)]))
-            trigger_error ('Multiple instances are not allowed for the class: ' . get_class($this), E_USER_ERROR);
-
-        parent::BxDol();
-
-        bx_import('BxDolPermalinks');
-        $this->oPermalinks = new BxDolPermalinks();
-
-        $this->sCacheFile = BX_DIRECTORY_PATH_CACHE . 'sys_menu_top.inc';
+        $this->_sObject = $aObject['object'];
+        $this->_aObject = $aObject;
+        $this->_oQuery = new BxDolMenuQuery($this->_aObject);
+        $this->_oPermalinks = new BxDolPermalinks();
     }
 
     /**
-     * Prevent cloning the instance
+     * Get menu object instance by object name
+     * @param $sObject object name
+     * @return object instance or false on error
      */
-    public function __clone() {
-        if (isset($GLOBALS['bxDolClasses'][get_class($this)]))
-            trigger_error('Clone is not allowed for the class: ' . get_class($this), E_USER_ERROR);
+    static public function getObjectInstance($sObject) {
+
+        if (isset($GLOBALS['bxDolClasses']['BxDolMenu!'.$sObject]))
+            return $GLOBALS['bxDolClasses']['BxDolMenu!'.$sObject];
+        
+        $aObject = BxDolMenuQuery::getMenuObject($sObject);
+        if (!$aObject || !is_array($aObject))
+            return false;
+
+        bx_import('BxTemplMenu');
+        $sClass = 'BxTemplMenu';        
+        if (!empty($aObject['override_class_name'])) {
+            $sClass = $aObject['override_class_name'];
+            if (!empty($aObject['override_class_file']))
+                require_once(BX_DIRECTORY_PATH_ROOT . $aObject['override_class_file']);
+            else    
+                bx_import($sClass);
+        }
+        
+        $o = new $sClass($aObject);
+
+        return ($GLOBALS['bxDolClasses']['BxDolMenu!'.$sObject] = $o);
     }
 
     /**
-     * Get singleton instance of the class
+     * Set selected menu item.
+     * @param $sModule menu item module to set as selected
+     * @param $sName menu item name to set as selected
      */
-    function getInstance() {
-        if(!isset($GLOBALS['bxDolClasses'][__CLASS__])) {
-            bx_import('BxTemplMenu');
-            $GLOBALS['bxDolClasses'][__CLASS__] = new BxTemplMenu();
-        }
-
-        return $GLOBALS['bxDolClasses'][__CLASS__];
+    static public function setSelected ($sModule, $sName) {
+        self::$SEL_MODULE = $sModule;
+        self::$SEL_NAME = $sName;
     }
 
     /**
-     * set custom breadcrumbs
-     * @param $a breadcrumbs array, array keys are titles and array values are links, for example:
-     *  array(
-     *      _t('Item1') => 'http://item1.com/link',
-     *      _t('Item2') => 'http://item2.com/link',
-     *  )
-     *  NOTE: first element in breadcrumb is always 'Home', it is added automatically, so you don't need to add in this array
+     * Add replace markers.
+     * @param $a array of markers as key => value
+     * @return true on success or false on error
      */
-    function setCustomBreadcrumbs ($a) {
-        $this->aCustomBreadcrumbs = $a;
+    public function addMarkers ($a) {
+        if (empty($a) || !is_array($a))
+            return false;
+        $this->_aMarkers = array_merge ($this->_aMarkers, $a);
+        return true;
+    }
+    
+    protected function _isSelected ($a) {
+        return $a['module'] == self::$SEL_MODULE && $a['name'] == self::$SEL_NAME ? true : false;
     }
 
-    function setCurrentProfileID($iProfileID = 0) {
-
-        $iProfileID = (int)$iProfileID;
-        $sProfileNickName = getNickName($iProfileID);
-
-        if ($iProfileID > 0 and !empty($sProfileNickName)) {
-            $this->aMenuInfo['profileID']   = $iProfileID;
-            $this->aMenuInfo['profileNick'] = $sProfileNickName;
-            $this->aMenuInfo['profileLink'] = getProfileLink($iProfileID);
-        } else {
-            $this->aMenuInfo['profileID']   = 0;
-            $this->aMenuInfo['profileNick'] = '';
-            $this->aMenuInfo['profileLink'] = '';
-        }
+    protected function _isVisible ($a) {
+        // TODO:
+        return true;        
     }
 
-    function setCurrentProfileNickName($sNickName = '') {
-        $sNickName = trim($sNickName);
-        $iProfileID = getID($sNickName);
-        $this->setCurrentProfileID($iProfileID);
+    protected function _replaceMarkers ($a) {
+        if (empty($this->_aMarkers))
+            return $a;
+        $aReplacebleFields = array ('title', 'link', 'onclick');
+        foreach ($aReplacebleFields as $sField) {
+            foreach ($this->_aMarkers as $sKey => $sValue)
+                $a[$sField] = str_replace('{' . $sKey . '}', $sValue, $a[$sField]);
+        }
+        return $a;
     }
 
-    function setCustomVar($sVar, $sVal) {
-        $this->aMenuInfo[$sVar] = $sVal;
-    }
-
-    function unsetCustomVar($sVar, $sVal) {
-        $this->aMenuInfo[$sVar] = $sVal;
-    }
-
-    function setCurrentMenu ($sName) {
-
-        $this->_init();
-
-        // TODO: store indexes for 'Name' in cache to get menu item directly by Name
-
-        $this->aMenuInfo['currentCustom'] = -1;
-        $this->aMenuInfo['currentTop'] = -1;
-
-        foreach ($this->aTopMenu as $iItemID => $aItem ) {
-
-            if ($aItem['Name'] != $sName)
-                continue;
-
-            if ($aItem['Type'] == 'top') {
-                $this->aMenuInfo['currentTop'] = $iItemID;
-            } else {
-                $this->aMenuInfo['currentCustom'] = $iItemID;
-                $this->aMenuInfo['currentTop'] = $aItem['Parent'];
-            }
-
-            break;
-        }
-    }
-
-    function _init () {
-
-        if ($this->isInitialized)
-            return;
-
-        if (!$this->_load())
-            $this->aTopMenu = array ();
-
-        $this->_initMenuInfo();
-
-        $this->isInitialized = true;
-    }
-
-    function _initMenuInfo() {
-
-        if (isMember()) {
-
-            $this->aMenuInfo['memberID'] = (int)$_COOKIE['memberID'];
-            $this->aMenuInfo['memberNick'] = getNickName ($this->aMenuInfo['memberID']);
-            $this->aMenuInfo['memberLink'] = getProfileLink ($this->aMenuInfo['memberID']);
-            $this->aMenuInfo['memberPass'] = getPassword ($this->aMenuInfo['memberID']);
-            $this->aMenuInfo['visible'] = 'memb';
-
-        } else {
-
-            $this->aMenuInfo['memberID'] = 0;
-            $this->aMenuInfo['memberNick'] = '';
-            $this->aMenuInfo['memberLink'] = '';
-            $this->aMenuInfo['visible']  = 'non';
-
-        }
-    }
-
-    function _checkToShow ($aItem) {
-
-        if (!$this->_checkVisible ($aItem['Visible']))
-            return false;
-
-        if (!$this->_checkCond($aItem['Check']))
-            return false;
-
-        return true;
-    }
-
-    function _checkVisible ($sVisible) {
-        return ( strpos( $sVisible, $this->aMenuInfo['visible'] ) !== false );
-    }
-
-    function _checkCond ($sCheck) {
-
-        if( !$sCheck )
-            return true;
-
-        $sCheck = str_replace ('\$', '$', $sCheck);
-        $fFunc = create_function('', $sCheck);
-
-        return $fFunc();
-    }
-
-    function _replaceMetas($sLink) {
-
-        foreach ($this->aMenuInfo as $k => $v)
-            $sLink = str_replace('{'.$k.'}', $v, $sLink);
-
-        return $sLink;
-    }
-
-    function _load() {
-
-        if( !file_exists( $this->sCacheFile ) && !$this->_compile() ) {
-            echo '<b>Warning!</b> Cannot find Menu Cache file (' . $this->sCacheFile . ').';
-            return false;
-        }
-
-        $sCache = @file_get_contents( $this->sCacheFile );
-        if( !$sCache ) {
-            if (!$this->_compile() || !$sCache = @file_get_contents( $this->sCacheFile )) { // compile and try again
-                echo '<b>Warning!</b> Cannot read Menu Cache file (' . $this->sCacheFile . ').';
-                return false;
-            }
-        }
-
-        $this->aTopMenu = @eval( $sCache );
-        if( !$this->aTopMenu or !is_array( $this->aTopMenu ) ) {
-            echo '<b>Warning!</b> Cannot evaluate Menu Cache file (' . $this->sCacheFile . ').';
-            return false;
-        }
-
-        if (BxDolRequest::serviceExists('pageac', 'menu_items_filter')) {
-            BxDolService::call('pageac', 'menu_items_filter', array('top', &$this->aTopMenu));
-        } 
-
-        return true;
-    }
-
-    function _compile() {
-
-        $oDb = BxDolDb::getInstance();
-
-        $fMenu = @fopen( $this->sCacheFile , 'w' );
-        if( !$fMenu )
-            return false;
-
-        fwrite( $fMenu, "return array(\n" );
-        $aFields = array( 'Type','Caption','Link','Visible','Target','Onclick','Check','Parent','Picture','Icon','BQuickLink', 'Statistics', 'Name' );
-
-        $sQuery = "
-            SELECT
-                `ID`,
-                `" . implode('`,`', $aFields ) . "`
-            FROM `sys_menu_top`
-            WHERE
-                `Active` = 1 AND
-                ( `Type` = 'system' OR `Type` = 'top' )
-            ORDER BY `Type`,`Order`
-        ";
-
-        $aMenu = $oDb->getAll($sQuery);
-        foreach ($aMenu as $aMenuItem) {
-            fwrite( $fMenu, "  " . str_pad( $aMenuItem['ID'], 2 ) . " => array(\n" );
-
-            foreach( $aFields as $sKey => $sField ) {
-                $sCont = $aMenuItem[$sField];
-
-                if( $sField == 'Link' )
-                    $sCont = $this->getCurrLink($sCont);
-
-                $sCont = str_replace( '\\', '\\\\', $sCont );
-                $sCont = str_replace( '"', '\\"',   $sCont );
-                $sCont = str_replace( '$', '\\$',   $sCont );
-
-                $sCont = str_replace( "\n", '',     $sCont );
-                $sCont = str_replace( "\r", '',     $sCont );
-                $sCont = str_replace( "\t", '',     $sCont );
-
-                fwrite( $fMenu, "    " . str_pad( "'$sField'", 11 ) . " => \"$sCont\",\n" );
-            }
-
-            fwrite( $fMenu, "  ),\n" );
-
-            // write it's children
-            $sQuery = $oDb->prepare("
-                SELECT
-                    `ID`,
-                    `" . implode('`,`', $aFields ) . "`
-                FROM `sys_menu_top`
-                WHERE
-                    `Active` = 1 AND
-                    `Type` = 'custom' AND
-                    `Parent` = ?
-                ORDER BY `Order`
-            ", $aMenuItem['ID']);
-
-            $aCMenu = $oDb->getAll($sQuery);
-            foreach ($aCMenu as $aMenuItem) {
-                fwrite( $fMenu, "  " . str_pad( $aMenuItem['ID'], 2 ) . " => array(\n" );
-
-                foreach( $aFields as $sKey => $sField ) {
-                    $sCont = $aMenuItem[$sField];
-
-                    if( $sField == 'Link' )
-                        $sCont = $this->getCurrLink($sCont);
-
-                    $sCont = str_replace( '\\', '\\\\', $sCont );
-                    $sCont = str_replace( '"', '\\"',   $sCont );
-                    $sCont = str_replace( '$', '\\$',   $sCont );
-
-                    $sCont = str_replace( "\n", '',     $sCont );
-                    $sCont = str_replace( "\r", '',     $sCont );
-                    $sCont = str_replace( "\t", '',     $sCont );
-
-                    fwrite( $fMenu, "    " . str_pad( "'$sField'", 11 ) . " => \"$sCont\",\n" );
-                }
-
-                fwrite( $fMenu, "  ),\n" );
-            }
-        }
-
-        fwrite( $fMenu, ");\n" );
-        fclose( $fMenu );
-        @chmod ($this->sCacheFile, 0666);
-        return true;
-    }
-
-    /**
-    * Returns link in accordance with permalink settings
-    */
-    function getCurrLink($sCont) {
-        $aCurrLink = explode('|', $sCont);
-        $aCurrLink[0] = $this->oPermalinks->permalink($aCurrLink[0]);
-        $sCont = implode( '|', $aCurrLink );
-
-        return htmlspecialchars_adv($sCont);
-    }
 }
 
+/** @} */

trunk/inc/classes/BxDolTemplate.php

@@ -830 +830 @@
             case 'top_menu':
                 bx_import('BxTemplMenu');
-                $sRet = BxTemplMenu::getInstance() -> getTopMenu();
+                $sRet = BxTemplMenu::getObjectInstance('sys_main')->getCode ();
                 break;
             case 'top_submenu':
                 bx_import('BxTemplMenu');
-                $sRet = BxTemplMenu::getInstance() -> getSubMenu();
+                $sRet = '';//BxTemplMenu::getInstance() -> getSubMenu();
                 break;
             case 'top_menu_breadcrumb':
                 bx_import('BxTemplMenu');
-                $sRet = BxTemplMenu::getInstance() -> getBreadcrumb();
+                $sRet = '';//BxTemplMenu::getInstance() -> getBreadcrumb();
                 break;
             case 'extra_top_menu':
@@ -850 +850 @@
                 break;
             case 'bottom_links':
-                bx_import('BxTemplFunctions');
-                $sRet = BxTemplFunctions::getInstance()->genSiteBottomMenu();
+                bx_import('BxTemplMenu');
+                $oMenuFooter = BxTemplMenu::getObjectInstance('sys_footer');
+                $sRet = $oMenuFooter ? $oMenuFooter->getCode () : 'TODO: footer menu';
                 break;
             case 'switch_skin_block':