| <?php |
| /** |
| * File containing the ezcTreeDbParentChild class. |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 |
| * @version //autogentag// |
| * @filesource |
| * @package TreeDatabaseTiein |
| */ |
| |
| /** |
| * ezcTreeDbParentChild implements a tree backend which stores parent/child |
| * information in a simple table containing the node's ID and its parent's ID. |
| * |
| * The table that stores the index (configured using the $indexTableName argument |
| * of the {@link __construct} method) should contain at least two fields. The |
| * first one 'id' will contain the node's ID, the second one 'parent_id' the ID |
| * of the node's parent. Both fields should be of the same database field type. |
| * Supported field types are either integer or a string type. |
| * In order to use auto-generated IDs, the 'id' field needs to be an |
| * auto-incrementing integer field, by using either an auto-increment field, or |
| * a sequence. |
| * |
| * @property-read ezcTreeDbDataStore $store |
| * The data store that is used for retrieving/storing data. |
| * @property string $nodeClassName |
| * Which class is used as tree node - this class *must* inherit |
| * the ezcTreeNode class. |
| * |
| * @package TreeDatabaseTiein |
| * @version //autogentag// |
| * @mainclass |
| */ |
| class ezcTreeDbParentChild extends ezcTreeDb |
| { |
| /** |
| * Creates a new ezcTreeDbParentChild object. |
| * |
| * The different arguments to the method configure which database |
| * connection ($dbh) is used to access the database and the $indexTableName |
| * argument which table is used to retrieve the relation data from. The |
| * $store argument configure which data store is used with this tree. |
| * |
| * It is up to the user to create the database table and make sure it is |
| * empty. |
| * |
| * @param ezcDbHandler $dbh |
| * @param string $indexTableName |
| * @param ezcTreeDbDataStore $store |
| */ |
| public static function create( ezcDbHandler $dbh, $indexTableName, ezcTreeDbDataStore $store ) |
| { |
| return new ezcTreeDbParentChild( $dbh, $indexTableName, $store ); |
| } |
| |
| /** |
| * Runs SQL to get all the children of the node with ID $nodeId as a PDO |
| * result set. |
| * |
| * @param string $nodeId |
| * @return PDOStatement |
| */ |
| protected function fetchChildRecords( $nodeId ) |
| { |
| $db = $this->dbh; |
| $q = $db->createSelectQuery(); |
| |
| // SELECT id, parent_id |
| // FROM indexTable |
| // WHERE parent_id = $nodeId |
| $q->select( 'id, parent_id' ) |
| ->from( $db->quoteIdentifier( $this->indexTableName ) ) |
| ->where( $q->expr->eq( 'parent_id', $q->bindValue( $nodeId ) ) ); |
| |
| $s = $q->prepare(); |
| $s->execute(); |
| return $s; |
| } |
| |
| /** |
| * Adds the children nodes of the node with ID $nodeId to the |
| * ezcTreeNodeList $list. |
| * |
| * @param ezcTreeNodeList $list |
| * @param string $nodeId |
| */ |
| private function addChildNodesDepthFirst( ezcTreeNodeList $list, $nodeId ) |
| { |
| $className = $this->properties['nodeClassName']; |
| foreach ( $this->fetchChildRecords( $nodeId ) as $record ) |
| { |
| $list->addNode( new $className( $this, $record['id'] ) ); |
| $this->addChildNodesDepthFirst( $list, $record['id'] ); |
| } |
| } |
| |
| /** |
| * Returns all the children of the node with ID $nodeId. |
| * |
| * @param string $nodeId |
| * @return ezcTreeNodeList |
| */ |
| public function fetchChildren( $nodeId ) |
| { |
| $className = $this->properties['nodeClassName']; |
| $list = new ezcTreeNodeList; |
| foreach ( $this->fetchChildRecords( $nodeId ) as $record ) |
| { |
| $list->addNode( new $className( $this, $record['id'] ) ); |
| } |
| return $list; |
| } |
| |
| /** |
| * Returns all the nodes in the path from the root node to the node with ID |
| * $nodeId, including those two nodes. |
| * |
| * @param string $nodeId |
| * @return ezcTreeNodeList |
| */ |
| public function fetchPath( $nodeId ) |
| { |
| $className = $this->properties['nodeClassName']; |
| |
| $nodes = array(); |
| $nodes[] = new $className( $this, $nodeId ); |
| |
| $nodeId = $this->getParentId( $nodeId ); |
| |
| while ( $nodeId != null ) |
| { |
| $nodes[] = new $className( $this, $nodeId ); |
| $nodeId = $this->getParentId( $nodeId ); |
| } |
| |
| $list = new ezcTreeNodeList; |
| foreach ( array_reverse( $nodes ) as $node ) |
| { |
| $list->addNode( $node ); |
| } |
| return $list; |
| } |
| |
| /** |
| * Returns the node with ID $nodeId and all its children, sorted according to |
| * the {@link http://en.wikipedia.org/wiki/Depth-first_search Depth-first sorting} |
| * algorithm. |
| * |
| * @param string $nodeId |
| * @return ezcTreeNodeList |
| */ |
| public function fetchSubtreeDepthFirst( $nodeId ) |
| { |
| $className = $this->properties['nodeClassName']; |
| $list = new ezcTreeNodeList; |
| $list->addNode( new $className( $this, $nodeId ) ); |
| $this->addChildNodesDepthFirst( $list, $nodeId ); |
| return $list; |
| } |
| |
| /** |
| * Alias for fetchSubtreeDepthFirst(). |
| * |
| * @param string $nodeId |
| * @return ezcTreeNodeList |
| */ |
| public function fetchSubtree( $nodeId ) |
| { |
| return $this->fetchSubtreeDepthFirst( $nodeId ); |
| } |
| |
| /** |
| * Adds the children nodes of the node with ID $nodeId to the |
| * ezcTreeNodeList $list. |
| * |
| * @param ezcTreeNodeList $list |
| * @param string $nodeId |
| */ |
| protected function addChildNodesBreadthFirst( ezcTreeNodeList $list, $nodeId ) |
| { |
| $className = $this->properties['nodeClassName']; |
| $childRecords = $this->fetchChildRecords( $nodeId )->fetchAll(); |
| foreach ( $childRecords as $record ) |
| { |
| $list->addNode( new $className( $this, $record['id'] ) ); |
| } |
| foreach ( $childRecords as $record ) |
| { |
| $this->addChildNodesBreadthFirst( $list, $record['id'] ); |
| } |
| } |
| |
| /** |
| * Returns the node with ID $nodeId and all its children, sorted according to |
| * the {@link http://en.wikipedia.org/wiki/Breadth-first_search Breadth-first sorting} |
| * algorithm. |
| * |
| * @param string $nodeId |
| * @return ezcTreeNodeList |
| */ |
| public function fetchSubtreeBreadthFirst( $nodeId ) |
| { |
| $className = $this->properties['nodeClassName']; |
| $list = new ezcTreeNodeList; |
| $list->addNode( new $className( $this, $nodeId ) ); |
| $this->addChildNodesBreadthFirst( $list, $nodeId ); |
| return $list; |
| } |
| |
| /** |
| * Returns the number of direct children of the node with ID $nodeId. |
| * |
| * @param string $nodeId |
| * @return int |
| */ |
| public function getChildCount( $nodeId ) |
| { |
| $db = $this->dbh; |
| $q = $db->createSelectQuery(); |
| |
| // SELECT count(id) |
| // FROM indexTable |
| // WHERE parent_id = $nodeId |
| $q->select( 'count(id)' ) |
| ->from( $db->quoteIdentifier( $this->indexTableName ) ) |
| ->where( $q->expr->eq( 'parent_id', $q->bindValue( $nodeId ) ) ); |
| |
| $s = $q->prepare(); |
| $s->execute(); |
| return (int) $s->fetchColumn( 0 ); |
| } |
| |
| /** |
| * Adds the number of children with for the node with ID $nodeId nodes to |
| * $count, recursively. |
| * |
| * @param int $count |
| * @param string $nodeId |
| */ |
| protected function countChildNodes( &$count, $nodeId ) |
| { |
| foreach ( $this->fetchChildRecords( $nodeId ) as $record ) |
| { |
| $count++; |
| $this->countChildNodes( $count, $record['id'] ); |
| } |
| } |
| |
| /** |
| * Returns the number of children of the node with ID $nodeId, recursively. |
| * |
| * @param string $nodeId |
| * @return int |
| */ |
| public function getChildCountRecursive( $nodeId ) |
| { |
| $count = 0; |
| $this->countChildNodes( $count, $nodeId ); |
| return $count; |
| } |
| |
| /** |
| * Returns the distance from the root node to the node with ID $nodeId. |
| * |
| * @param string $nodeId |
| * @return int |
| */ |
| public function getPathLength( $nodeId ) |
| { |
| $nodeId = $this->getParentId( $nodeId ); |
| $length = 0; |
| |
| while ( $nodeId !== null ) |
| { |
| $nodeId = $this->getParentId( $nodeId ); |
| $length++; |
| } |
| return $length; |
| } |
| |
| /** |
| * Returns whether the node with ID $nodeId has children. |
| * |
| * @param string $nodeId |
| * @return bool |
| */ |
| public function hasChildNodes( $nodeId ) |
| { |
| return $this->getChildCount( $nodeId ) > 0; |
| } |
| |
| /** |
| * Returns whether the node with ID $childId is a direct child of the node |
| * with ID $parentId. |
| * |
| * @param string $childId |
| * @param string $parentId |
| * @return bool |
| */ |
| public function isChildOf( $childId, $parentId ) |
| { |
| $nodeId = $this->getParentId( $childId ); |
| $parentId = (string) $parentId; |
| return $parentId === $nodeId; |
| } |
| |
| /** |
| * Returns whether the node with ID $childId is a direct or indirect child |
| * of the node with ID $parentId. |
| * |
| * @param string $childId |
| * @param string $parentId |
| * @return bool |
| */ |
| public function isDescendantOf( $childId, $parentId ) |
| { |
| $parentId = (string) $parentId; |
| $nodeId = $childId; |
| do |
| { |
| $nodeId = $this->getParentId( $nodeId ); |
| if ( $parentId === $nodeId ) |
| { |
| return true; |
| } |
| } while ( $nodeId !== null ); |
| return false; |
| } |
| |
| /** |
| * Returns whether the nodes with IDs $child1Id and $child2Id are siblings |
| * (ie, they share the same parent). |
| * |
| * @param string $child1Id |
| * @param string $child2Id |
| * @return bool |
| */ |
| public function isSiblingOf( $child1Id, $child2Id ) |
| { |
| $nodeId1 = $this->getParentId( $child1Id ); |
| $nodeId2 = $this->getParentId( $child2Id ); |
| return $nodeId1 === $nodeId2 && (string) $child1Id !== (string) $child2Id; |
| } |
| |
| /** |
| * Sets a new node as root node, this also wipes out the whole tree. |
| * |
| * @param ezcTreeNode $node |
| */ |
| public function setRootNode( ezcTreeNode $node ) |
| { |
| $db = $this->dbh; |
| |
| $q = $db->createDeleteQuery(); |
| $q->deleteFrom( $db->quoteIdentifier( $this->indexTableName ) ); |
| $s = $q->prepare(); |
| $s->execute(); |
| $this->store->deleteDataForAllNodes(); |
| |
| $q = $db->createInsertQuery(); |
| $q->insertInto( $db->quoteIdentifier( $this->indexTableName ) ) |
| ->set( 'parent_id', "null" ) |
| ->set( 'id', $q->bindValue( $node->id ) ); |
| $s = $q->prepare(); |
| $s->execute(); |
| |
| $this->store->storeDataForNode( $node, $node->data ); |
| } |
| |
| /** |
| * Creates the query to insert an empty node into the database, so that the last-inserted ID can be obtained. |
| * |
| * @return ezcQueryInsert |
| */ |
| protected function createAddEmptyNodeQuery() |
| { |
| $db = $this->dbh; |
| |
| $q = $db->createInsertQuery(); |
| $q->insertInto( $db->quoteIdentifier( $this->indexTableName ) ) |
| ->set( 'parent_id', $q->bindValue( null ) ); |
| |
| return $q; |
| } |
| |
| /** |
| * Adds the node $childNode as child of the node with ID $parentId. |
| * |
| * @param string $parentId |
| * @param ezcTreeNode $childNode |
| */ |
| public function addChild( $parentId, ezcTreeNode $childNode ) |
| { |
| if ( $this->inTransaction ) |
| { |
| $this->addTransactionItem( new ezcTreeTransactionItem( ezcTreeTransactionItem::ADD, $childNode, null, $parentId ) ); |
| return; |
| } |
| |
| $q = $this->createAddNodeQuery( $childNode->id ); |
| $q->set( 'parent_id', $q->bindValue( $parentId ) ) |
| ->set( 'id', $q->bindValue( $childNode->id ) ); |
| $s = $q->prepare(); |
| $s->execute(); |
| |
| $this->store->storeDataForNode( $childNode, $childNode->data ); |
| } |
| |
| /** |
| * Deletes all nodes in the node list $list. |
| * |
| * @param ezcTreeNodeList $list |
| */ |
| private function deleteNodes( ezcTreeNodeList $list ) |
| { |
| $db = $this->dbh; |
| $q = $db->createDeleteQuery(); |
| |
| $nodeIdList = array(); |
| foreach ( array_keys( $list->nodes ) as $nodeId ) |
| { |
| $nodeIdList[] = (string) $nodeId; |
| } |
| |
| // DELETE FROM indexTable |
| // WHERE id in ( $list ); |
| $q->deleteFrom( $db->quoteIdentifier( $this->indexTableName ) ); |
| $q->where( $q->expr->in( 'id', $nodeIdList ) ); |
| $s = $q->prepare(); |
| $s->execute(); |
| } |
| |
| /** |
| * Deletes the node with ID $nodeId from the tree, including all its children. |
| * |
| * @param string $nodeId |
| */ |
| public function delete( $nodeId ) |
| { |
| if ( $this->inTransaction ) |
| { |
| $this->addTransactionItem( new ezcTreeTransactionItem( ezcTreeTransactionItem::DELETE, null, $nodeId ) ); |
| return; |
| } |
| |
| $nodeList = $this->fetchSubtree( $nodeId ); |
| $this->deleteNodes( $nodeList ); |
| $this->store->deleteDataForNodes( $nodeList ); |
| } |
| |
| /** |
| * Moves the node with ID $nodeId as child to the node with ID $targetParentId. |
| * |
| * @param string $nodeId |
| * @param string $targetParentId |
| */ |
| public function move( $nodeId, $targetParentId ) |
| { |
| if ( $this->inTransaction ) |
| { |
| $this->addTransactionItem( new ezcTreeTransactionItem( ezcTreeTransactionItem::MOVE, null, $nodeId, $targetParentId ) ); |
| return; |
| } |
| |
| $db = $this->dbh; |
| $q = $db->createUpdateQuery(); |
| |
| $q->update( $db->quoteIdentifier( $this->indexTableName ) ) |
| ->set( 'parent_id', $q->bindValue( $targetParentId ) ) |
| ->where( $q->expr->eq( 'id', $q->bindValue( $nodeId ) ) ); |
| |
| $s = $q->prepare(); |
| $s->execute(); |
| } |
| |
| /** |
| * Fixates the transaction. |
| */ |
| public function fixateTransaction() |
| { |
| } |
| } |
| ?> |