Home » Database » DB_NestedSet

API to build and query nested sets

This package is unmaintained.

Download latest release 1.4.1 (archived versions might be outdated)

License: PHP License

Description

DB_NestedSet let's you create trees with infinite depth
inside a relational database.
The package provides a way to
o create/update/delete nodes
o query nodes, trees and subtrees
o copy (clone) nodes, trees and subtrees
o move nodes, trees and subtrees
o Works with PEAR::DB, PEAR::MDB, PEAR::MDB2
o output the tree with
- PEAR::HTML_TreeMenu
- TigraMenu (http://www.softcomplex.com/products/tigra_menu/)
- CoolMenus (http://www.dhtmlcentral.com/projects/coolmenus/)
- PEAR::Image_GraphViz (http://pear.php.net/package/Image_GraphViz)
- PEAR::HTML_Menu

Documentation

Manual

Maintainers

• Daniel Khan (khan) — lead, active
• Lukas Linemayr (linemayr) — developer, active

Dependencies

Required

• PHP (>= 4.0.0)
• PEAR Installer (>= 1.4.0b1)

Releases

• 1.4.1 (stable, 2010-04-25)
  Release notes

  License: PHP License

  This is the final stable version of this package. No bugs occured during this long time in RC state and it is considered to be quite solid.
  We are currently working on DB_NestedSet2 which will provide a cleaner, pure OOP interface. So watch out for this.

  Again:
  ATTENTION: The 1.2 api may not be fully backward compatible to the current 1.3 api. To avoid surprises when we go stable please make sure that you test this release
  candidate with your 1.2 apps.
  Please look at http://pear.php.net/package/DB_NestedSet/download/1.3 for information on the major changes between
  the 1.2 and the 1.3+ releases.

  Changes in this release:
  - Changed tests to work with current versions of PHPUnit.

• 1.4.0RC1 (beta, 2007-10-21)
  Release notes

  License: PHP License

  ATTENTION: The 1.2 api may not be fully backward compatible to the current 1.3 api. To avoid surprises when we go stable please make sure that you test this release
  candidate with your 1.2 apps.
  Please look at http://pear.php.net/package/DB_NestedSet/download/1.3 for informations on the major changes between
  the 1.2 and the 1.3+ releases.

  The 1.3.6 release is used in many projects and is considered to be quite solid.
  This release fixes some minor bugs. Finally there is also an end user documentation available!
  Thanks to Lukas Linemayr (ll@shopping.at) for writing and maintaining them.
  I'd also like to thank tacker (http://pear.php.net/user/tacker) for providing lots of bug reports and patches.
  If everything goes well this will be the last beta release. Please test it and report every problem you have with it!

  Bugs fixed in this release:

  - Bug #2969: Undefined variables
  - Bug #3536: getSiblings doesn't work on root level
  - Bug #4349: Problem with driver 'Menu'
  - Bug #4599: MDB2 Driver broken
  - Bug #4702: Fatal error in NestedSet.php:1856
  - Bug #4869: Variable references should be returned
  - Request #4945: Move DB_NestedSet_Node into own file
  - Bug #5766: DB.php doesn't check connection errors
  - Bug #6390: options not used
  - Bug #6405: Only variable references should be returned by reference
  - Bug #9890: dirname(__FILE__) should not be used for include/require

• 1.3.6 (beta, 2004-08-10)
  Release notes

  License: PHP License

  Bugfix release
  - Fixed #2034: getAllNodes(), getSubBranch() with NESE_SORT_PREORDER and sorting by name
  - _secSortCollect() a static array which wasn't reset if called again
  - Now really fixed #1441: _getOne() was missing in DB driver

• 1.3.5 (beta, 2004-07-25)
  Release notes

  License: PHP License

  o This release adds MDB2 support (Thanks to Lorenzo Alberton)!
  Bugs fixed:
  - Wrong picknode lock sequence
  A possible timing problem which could lead to tree damage
  http://pear.php.net/bugs/bug.php?id=1226
  - Wrong generated structure for menu
  The HTML_Menu output driver contained a bug.
  http://pear.php.net/bugs/bug.php?id=1423

• 1.3.4 (beta, 2004-04-04)
  Release notes

  License: PHP License

  This is a quick fix to quoting problems in pgsql.
  As MDB doesn't support all needed quoting methods for now it's not possible to use
  any reserved words (key, order, group,...) for column names with MDB.
  As soon as MDB also supports this it should work,
  Please test it as much as possible while I am now finally will finish the docs.
  Please file bugs using the great bug reporting system on pear.php.net.
  If no further bugs are found this branch will be turned to stable.

  - Fixed Bug #1114: bug fix 561 flawed; single-quoting fields errors in pgsql reported by Andy Crain
  + The TreeMenu output driver now supports all params supported by PEAR::HTML_TreeMenu

• 1.3.2 (beta, 2003-12-28)
  Release notes

  License: PHP License

  - Added Image_GraphViz output driver (Arnaud Limbourg)
  - Fixed wrong rootnode order field incremention on rootnode deletion (Daniel Khan)
  - Applied a little patch to the CoolMenu output driver (Andy Crain)

• 1.3.1 (beta, 2003-11-26)
  Release notes

  License: PHP License

  - Extended Unit Tests
  - Added the CoolMenu output driver by Andy Crain
  - Added Andy Crain's patch which fixes
  + the can't move a rootnode below another rootnode bug
  + the 'Parent id not updated on move' bug
  + a bug which led to wrong l/r values on tree operations
  - Replaces non ANSI (mysql specific) queries.
  PLEASE test with other RDBMS than mySQL - this should work now
  * Coding style fixes
  * Took out a few of the abstract methods and _getmicrotime() to try and cut down on the size of the class.
  * Optimized the query for createRootNode() slightly
  * Fixed createRootNode() to work when only required parameters are passed, so that now
  $db->createRootNode($node) will successfully create a root node at the end of the tree instead of erroring out.
  - Fixed [Bug #138]: moveTree doesn't return anything
  (Thanks to [thomas at bytefreak dot de] for the report)
  - Applied Lukas Smith's MDB patch - MDB support is back again!
  - Adopted unit tests for MDB
  - Changed the name of the property _flparams back to flparams as some applications may rely on this.

• 1.3 (beta, 2003-10-07)
  Release notes

  License: PHP License

  This release includes many internal changes and some (long demanded) feature additions.
  The API and database structure should be fully backward compatible.
  Please test this release as much as possible, so that any remaining issues can be
  uncovered and resolved prior to the final release.
  o Notes:
  If you want to use new features like preorder sorting you will
  have to convert the tree to meet the new db model.
  See docs/migrateDB.txt on how to migrate your existing tree.
  o Fixes:
  * MDB support is back again.
  * Fixed a problem with some move operations where the moving tree gets changed during
  the move operation.
  * Many small internal fixes.
  o New features:
  * Added a method setSortMode($mode) where $mode is NESE_SORT_LEVEL or NESE_SORT_PREORDER.
  This will change the way the query methods return the tree.
  NESE_SORT_LEVEL is the default.
  NESE_SORT_PREORDER returns the tree preorder sorted. This sorting method
  was often demanded as it's the way one would usually expect the tree to be returned.
  Preorder sorting will also work with the property $secondarySort.
  So it's possible to get the siblings of one level sorted alphabetically by name.
  Note that you will have to switch back to NESE_SORT_LEVEL if you want to display
  a tree with the output drivers.
  * Added method getParent() to get the immediate parent of a node
  * Added method getSiblings() to get all siblings of a node + the node itself
  * Added method createLeftNode() to create a node before a node given by it's node id.
  * Added method apiVersion() which obviously returns the current API version
  * Added convertTreeModel() to convert a tree into the new tree model
  * Added magic parent db field. If a column with the field mapping 'parent' is present
  the parent id of a node is stored inside this column.
  This doesn't exactly meet the nested sets theory and will only be used by some
  methods like getParent(). It's recommended to use this column for new installations
  or converted trees.
  * Now values passed to creation methods are verfified so that a script can't set
  params like the parent id by itself
  * Added listbox_toHTML() and tree_toHTML() methods to the TreeMenu output driver.
  Thanks to Emanuel Zueger for this additions.
  * Added regression tests for all public methods and common options
  The regression test setup isn't very userfriendly for now.
  The db schema can be found under docs and you will have to customize tests/UnitTest.php
  to set your database connection params.
  * The main class now uses the array representation of the tree for internal operations.
  This should gain some performance.
  o Notes on next major version (2.0):
  * The API will change.
  * The class won't return objects anymore. It will act as if $keepAsArray is set to true
  when calling the query methods.
  It's a good idea to switch to set this param to be mostly compatible.
  * Callback handlers will be removed - I don't even know if someone uses them.
  Please mail me at dk@webcluster.at if you really see a use.
  -- To be continued --

• 1.2.4 (stable, 2003-08-13)
  Release notes

  License: PHP License

  o Fixed a problem in re-sorting after node deletion
  o Added an example for building a JavaScript tree with TreeMenu

• 1.2.3 (stable, 2003-07-16)
  Release notes

  License: PHP License

  o Fixes a typo in _addSQL()
  Thanks to Rense Klinkenberg for sending patch

• 1.2.2 (stable, 2003-07-15)
  Release notes

  License: PHP License

  This release fixes some bugs which occured since 1.2.1
  We will now move towards 2.0 which will include big improvements
  but also some BC breaks.
  FIXES
  o Fixed a bug which leads to wrong results when copying nodes
  o Fixed a node ordering bug in createRightNode (Thanks to Stefan Wimmer)
  o Fixed bug that had crept in so that $aliasFields was not working
  o Doc and style fixes

• 1.2.1 (stable, 2003-05-25)
  Release notes

  License: PHP License

  - NEW FEATURES
  o Now $NeSe->setAttr() allows a PEAR function cache object to be passed using
  $NeSe->setAttr(array('cache'=>$cache_object));
  if this object is set, the class will use it to cache database queries.
  It will also flush this cache if the structure changes.
  o All tree query methods now support an additional array named $addSQL.
  This can be used to pass additional params to a query.
  Means: You may now use joins to other tables.
  - FIXES
  o createRightNode() returned the node object instead of the new node id, which
  caused problems whith some internal method calls.
  o TreeMenu and TigraMenu output drivers contained a bug which made them not
  create the whole tree under certain circumstances
  Thanks to Alain Petignat for reporting this
  o Some minor E_ALL fixes (The package shouldn't produce notices/warnings with
  E_ALL set)
  o Added TigraMenu.php to the package which was missing in the last release

• 1.2 (stable, 2003-05-07)
  Release notes

  License: PHP License

  The core package is now stable.
  You should be able to manipulate a nested set without problems.
  The output driver development will always be in progress and there
  may always be drivers in beta state.
  This package introduces an output driver for TigraMenu
  (http://www.softcomplex.com/products/tigra_menu/)
  and examples on using the output drivers.
  * Fixed bug in triggerEvent() which produced an error on node move (Daniel Khan)
  * Added isParent() which provides a simple way to query if a given node is parent of another given node. (Daniel Khan)
  * Added a variable to pickNode() which can be used to get a node by another value than id (Daniel Khan)
  * TreeMenu: Fixed bug where two sub nodes that both have children were not being processed correctly (Jason Rust)
  * TreeMenu: Took off example usage since there is now an example page in docs/ (Jason Rust)
  * TigraMenu: Initial import of TigraMenu output driver

Bugs