| // +----------------------------------------------------------------------+ // $Id$ // {{{ DB_NestedSet_Menu:: class /** * Simple helper class which takes a node array create by DB_NestedSet and transforms it * into an array useable by HTML_Menu * * @see docs/Menu_example.php * @author Daniel Khan * @package DB_NestedSet * @version $Revision: 1.5 $ * @access public */ // }}} /** * DB_NestedSet_Menu * * @package * @author daniel * @copyright Copyright (c) 2004 * @version $Id$ * @access public */ class DB_NestedSet_Menu extends DB_NestedSet_Output { // {{{ properties var $_structMenu = array(); /** * * @var array Default field mappings * @access private */ var $_paramDefaults = array('textField' => 'text', 'titleField' => 'name', 'urlField' => 'url' ); // }}} // {{{ DB_NestedSet_Menu /** * The constructor * * @param array $params The config parameters used for building the array. * @see _createFromStructure * @access public * @return void */ function & DB_NestedSet_Menu($params) { $this->_structMenu = & $this->_createFromStructure($params); } // }}} // {{{ _createFromStructure /** * DB_NestedSet_Menu::_createFromStructure() * Creates the HTML_Menu Structure * * 
         * @param array $params The configuration parameters.  Available
     *                          params are:
     * o 'structure'            => [REQU] The result from $nestedSet->getAllNodes(true)
     * o 'titleField'           => [REQU] The field in the table that has the text for node
     * o 'urlField'             => [REQU] The field in the table that has the link for the node
         *
* @param $params * @return array The menu array **/ function _createFromStructure($params) { static $menuStructure, $menuParts; // always start at level 1 if (!isset($params['currentLevel'])) { $params['currentLevel'] = 1; } if (!isset($params['currentParent'])) { $params['currentParent'] = false; } if (!isset($menuParts)) { $menuParts = array(); } if (!isset($menuStructure)) { $menuStructure = array(); } // Set the default field mappings if not set in userland if (!isset($params['defaultsSet'])) { $this->_setParamDefaults($params); } // have to use a while loop here because foreach works on a copy of the array and // the child nodes are passed by reference during the recursion so that the parent // will know when they have been hit. reset($params['structure']); while(list($nodeID,$node)=each($params['structure'])) { // see if we've already been here before if (isset($node['hit']) || $node['level'] < $params['currentLevel']) { continue; } // mark that we've hit this node $params['structure'][$nodeID]['hit'] = $node['hit'] = true; // We are at a rootnode - let's add it to the structure if ($nodeID == $node['rootid']) { $menuStructure[$node['id']] = array( 'title' => isset($node[$params['titleField']]) ? $node[$params['titleField']] : false, 'url' => isset($node[$params['urlField']]) ? $node[$params['urlField']] : false ); // Use a reference so we can happily modify $menuParts to change $menuStructure $menuParts[$node['id']] = & $menuStructure[$node['id']]; } // Perform action for non-root nodes $currentParent = & $params['currentParent']['id']; if ($currentParent && isset($menuParts[$currentParent])) { $currentPart = & $menuParts[$currentParent]['sub']; $currentPart[$node['id']] = array( 'title' => isset($node[$params['titleField']]) ? $node[$params['titleField']] : false, 'url' => isset($node[$params['urlField']]) ? $node[$params['urlField']] : false ); $menuParts[$node['id']] = & $currentPart[$node['id']]; } // see if it has children if (($node['r'] - 1) != $node['l']) { $children = array(); // harvest all the children $tempStructure = $params['structure']; foreach ($tempStructure as $childKey => $childNode) { if (!isset($childNode['hit']) && $node['rootid'] == $childNode['rootid'] && $node['l'] < $childNode['l'] && $node['r'] > $childNode['r'] && $childNode['level'] > $params['currentLevel']) { // important that we assign it by reference here, so that when the child // marks itself 'hit' the parent loops will know $children[$childKey] = & $params['structure'][$childKey]; } } $recurseParams = $params; $recurseParams['structure'] = $children; $recurseParams['currentLevel']++; $recurseParams['currentParent'] = & $node; $this->_createFromStructure($recurseParams); } } return $menuStructure; } // }}} // {{{ returnStructure /** * DB_NestedSet_Menu::returnStructure() * * Returns an array suitable for HTML_Menu * * @return array An array useable for HTML_Menu */ function returnStructure() { return $this->_structMenu; } // }}} // {{{ _setParamDefaults() /** * DB_NestedSet_Menu::_setParamDefaults() * * @param $params Param array passed from userland * @return bool True on completion * @access private */ function _setParamDefaults(& $params) { $defaults = $this->_paramDefaults; foreach($defaults AS $fieldName => $fieldAlias) { if (!isset($params[$fieldName])) { $params[$fieldName] = $fieldAlias; } } $params['defaultsSet'] = true; return true; } // }}} } ?>