| [ Index ] |
|
Code source de Symfony 1.0.0 |
[Code source] [Imprimer] [Statistiques]
Base static class for performing query operations on the tree contained by the '<?php echo $table->getPhpName() ?>' table. This class was autogenerated by Propel on:
| Poids: | 522 lignes (20 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
| isCodeBase($con = null) X-Ref |
| Temp function for CodeBase hacks that will go away. |
| createNewRootNode($obj, $con = null) X-Ref |
| Create a new Node at the top of tree. This method will destroy any existing root node (along with its children). Use at your own risk! param: <?php echo $table->getPhpName() ?> Object wrapped by new node. param: Connection Connection to use. return: <?php echo $table->getPhpName() ?>Node |
| insertNewRootNode($obj, $con = null) X-Ref |
| Inserts a new Node at the top of tree. Any existing root node (along with its children) will be made a child of the new root node. This is a safer alternative to createNewRootNode(). param: <?php echo $table->getPhpName() ?> Object wrapped by new node. param: Connection Connection to use. return: <?php echo $table->getPhpName() ?>Node |
| retrieveNodes($criteria, $ancestors = false, $descendants = false, $con = null) X-Ref |
| Retrieves an array of tree nodes based on specified criteria. Optionally includes all parent and/or child nodes of the matching nodes. param: Criteria Criteria to use. param: boolean True if ancestors should also be retrieved. param: boolean True if descendants should also be retrieved. param: Connection Connection to use. return: array Array of root nodes. |
| retrieveNodeByPK($pk, $ancestors = false, $descendants = false, $con = null) X-Ref |
| Retrieves a tree node based on a primary key. Optionally includes all parent and/or child nodes of the matching node. param: mixed <?php echo $table->getPhpName() ?> primary key (array for composite keys) param: boolean True if ancestors should also be retrieved. param: boolean True if descendants should also be retrieved. param: Connection Connection to use. return: <?php echo $table->getPhpName() ?>Node |
| retrieveNodeByNP($np, $ancestors = false, $descendants = false, $con = null) X-Ref |
| Retrieves a tree node based on a node path. Optionally includes all parent and/or child nodes of the matching node. param: string Node path to retrieve. param: boolean True if ancestors should also be retrieved. param: boolean True if descendants should also be retrieved. param: Connection Connection to use. return: <?php echo $table->getPhpName() ?>Node |
| retrieveRootNode($descendants = false, $con = null) X-Ref |
| Retrieves the root node. param: string Node path to retrieve. param: boolean True if descendants should also be retrieved. param: Connection Connection to use. return: <?php echo $table->getPhpName() ?>Node |
| moveNodeSubTree($srcPath, $dstPath, $con = null) X-Ref |
| Moves the node subtree at srcpath to the dstpath. This method is intended for internal use by the BaseNode object. Note that it does not check for preexisting nodes at the dstpath. It also does not update the node path of any Node objects that might currently be in memory. Use at your own risk! param: string Source node path to move (root of the src subtree). param: string Destination node path to move to (root of the dst subtree). param: Connection Connection to use. return: void |
| deleteNodeSubTree($nodePath, $con = null) X-Ref |
| Deletes the node subtree at the specified node path from the database. param: string Node path to delete param: Connection Connection to use. return: void |
| buildFamilyCriteria($criteria, $ancestors = false, $descendants = false) X-Ref |
| Builds the criteria needed to retrieve node ancestors and/or descendants. param: Criteria Criteria to start with param: boolean True if ancestors should be retrieved. param: boolean True if descendants should be retrieved. return: Criteria |
| buildTree($nodes) X-Ref |
| This method reconstructs as much of the tree structure as possible from the given array of objects. Depending on how you execute your query, it is possible for the ResultSet to contain multiple tree fragments (i.e. subtrees). The array returned by this method will contain one entry for each subtree root node it finds. The remaining subtree nodes are accessible from the <?php echo $table->getPhpName() ?>Node methods of the subtree root nodes. param: array Array of <?php echo $table->getPhpName() ?>Node objects return: array Array of <?php echo $table->getPhpName() ?>Node objects |
| populateNodes($rs, $criteria) X-Ref |
| Populates the <?php echo $table->getPhpName() ?> objects from the specified ResultSet, wraps them in <?php echo $table->getPhpName() ?>Node objects and build the appropriate node relationships. The array returned by this method will only include the initial targets of the query, even if ancestors/descendants were also requested. The ancestors/descendants will be cached in memory and are accessible via the getNode() methods. param: ResultSet param: Criteria return: array Array of <?php $table->getPhpName() ?>Node objects. |
| Généré le : Fri Mar 16 22:42:14 2007 | par Balluche grâce à PHPXref 0.7 |