NestedSet.php 9.66 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<?php
/*
 *  $Id$
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
19
 * <http://www.phpdoctrine.org>.
20
 */
21

22 23 24 25
/**
 * Doctrine_Tree_NestedSet
 *
 * @package     Doctrine
26
 * @subpackage  Tree
27 28 29 30 31 32 33 34
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link        www.phpdoctrine.com
 * @since       1.0
 * @version     $Revision$
 * @author      Joe Simms <joe.simms@websites4.com>
 */
class Doctrine_Tree_NestedSet extends Doctrine_Tree implements Doctrine_Tree_Interface
{
35
    private $_baseQuery;
36
    private $_baseAlias = "base";
37

38 39 40 41 42 43
    /**
     * constructor, creates tree with reference to table and sets default root options
     *
     * @param object $table                     instance of Doctrine_Table
     * @param array $options                    options
     */
44
    public function __construct($table, $options)
45 46
    {
        // set default many root attributes
47
        $options['hasManyRoots'] = isset($options['hasManyRoots']) ? $options['hasManyRoots'] : false;
48
        if ($options['hasManyRoots']) {
49
            $options['rootColumnName'] = isset($options['rootColumnName']) ? $options['rootColumnName'] : 'root_id';
50 51
        }
        
52 53
        parent::__construct($table, $options);
    }
54

55 56 57 58 59 60 61
    /**
     * used to define table attributes required for the NestetSet implementation
     * adds lft and rgt columns for corresponding left and right values
     *
     */
    public function setTableDefinition()
    {
zYne's avatar
zYne committed
62
        if ($root = $this->getAttribute('rootColumnName')) {
63
            $this->table->setColumn($root, 'integer', 4);
64 65
        }

66 67 68
        $this->table->setColumn('lft', 'integer', 4);
        $this->table->setColumn('rgt', 'integer', 4);
        $this->table->setColumn('level', 'integer', 2);
69 70 71 72 73 74 75 76 77 78 79 80 81
    }

    /**
     * creates root node from given record or from a new record
     *
     * @param object $record        instance of Doctrine_Record
     */
    public function createRoot(Doctrine_Record $record = null)
    {
        if ( ! $record) {
            $record = $this->table->create();
        }

82 83
        // if tree is many roots, and no root id has been set, then get next root id
        if ($root = $this->getAttribute('hasManyRoots') && $record->getNode()->getRootValue() <= 0) {
84 85 86 87 88
            $record->getNode()->setRootValue($this->getNextRootId());
        }

        $record->set('lft', '1');
        $record->set('rgt', '2');
89
        $record->set('level', 0);
90 91 92 93 94 95 96 97 98 99

        $record->save();

        return $record;
    }

    /**
     * returns root node
     *
     * @return object $record        instance of Doctrine_Record
100
     * @deprecated Use fetchRoot()
101 102 103
     */
    public function findRoot($rootId = 1)
    {
104 105
        return $this->fetchRoot($rootId);
    }
106

107 108 109 110 111 112 113 114
    /**
     * Fetches a/the root node.
     *
     * @param integer $rootId
     */
    public function fetchRoot($rootId = 1)
    {
        $q = $this->getBaseQuery();
115
        $q = $q->addWhere($this->_baseAlias . '.lft = ?', 1);
116 117 118
        
        // if tree has many roots, then specify root id
        $q = $this->returnQueryWithRootId($q, $rootId);
119
        $data = $q->execute();
120

121 122
        if (count($data) <= 0) {
            return false;
123 124
        }

125 126 127 128 129 130 131 132 133
        if ($data instanceof Doctrine_Collection) {
            $root = $data->getFirst();
            $root['level'] = 0;
        } else if (is_array($data)) {
            $root = array_shift($data);
            $root['level'] = 0;
        } else {
            throw new Doctrine_Tree_Exception("Unexpected data structure returned.");
        }
134 135 136 137 138

        return $root;
    }

    /**
139
     * Fetches a tree.
140
     *
141 142
     * @param array $options  Options
     * @return mixed          The tree or FALSE if the tree could not be found.
143 144 145 146
     */
    public function fetchTree($options = array())
    {
        // fetch tree
147
        $q = $this->getBaseQuery();
148

149
        $q = $q->addWhere($this->_baseAlias . ".lft >= ?", 1);
150 151 152

        // if tree has many roots, then specify root id
        $rootId = isset($options['root_id']) ? $options['root_id'] : '1';
153
        if (is_array($rootId)) {
154 155
            $q->addOrderBy($this->_baseAlias . "." . $this->getAttribute('rootColumnName') .
                    ", " . $this->_baseAlias . ".lft ASC");
156
        } else {
157
            $q->addOrderBy($this->_baseAlias . ".lft ASC");
158
        }
159
        
160
        $q = $this->returnQueryWithRootId($q, $rootId);
161
        $tree = $q->execute();
162 163 164
        
        if (count($tree) <= 0) {
            return false;
165
        }
166 167
        
        return $tree;
168 169 170
    }

    /**
171
     * Fetches a branch of a tree.
172
     *
173 174 175 176
     * @param mixed $pk              primary key as used by table::find() to locate node to traverse tree from
     * @param array $options         Options.
     * @return mixed                 The branch or FALSE if the branch could not be found.
     * @todo Only fetch the lft and rgt values of the initial record. more is not needed.
177 178 179 180
     */
    public function fetchBranch($pk, $options = array())
    {
        $record = $this->table->find($pk);
181
        if ( ! ($record instanceof Doctrine_Record) || !$record->exists()) {
romanb's avatar
romanb committed
182 183 184
            // TODO: if record doesn't exist, throw exception or similar?
            return false;
        }
185
        //$depth = isset($options['depth']) ? $options['depth'] : null;
romanb's avatar
romanb committed
186
        
187 188
        $q = $this->getBaseQuery();
        $params = array($record->get('lft'), $record->get('rgt'));
189 190
        $q->addWhere($this->_baseAlias . ".lft >= ? AND " . $this->_baseAlias . ".rgt <= ?", $params)
                ->addOrderBy($this->_baseAlias . ".lft asc");
191 192
        $q = $this->returnQueryWithRootId($q, $record->getNode()->getRootValue());
        return $q->execute();
193 194 195
    }

    /**
196 197
     * Fetches all root nodes. If the tree has only one root this is the same as
     * fetchRoot().
198
     *
199
     * @return mixed  The root nodes.
200 201 202
     */
    public function fetchRoots()
    {
203
        $q = $this->getBaseQuery();
204 205
        $q = $q->addWhere($this->_baseAlias . '.lft = ?', 1);
        return $q->execute();
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
    }

    /**
     * calculates the next available root id
     *
     * @return integer
     */
    public function getNextRootId()
    {
        return $this->getMaxRootId() + 1;
    }

    /**
     * calculates the current max root id
     *
     * @return integer
     */    
    public function getMaxRootId()
    {      
        $component = $this->table->getComponentName();
zYne's avatar
zYne committed
226
        $column    = $this->getAttribute('rootColumnName');
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247

        // cannot get this dql to work, cannot retrieve result using $coll[0]->max
        //$dql = "SELECT MAX(c.$column) FROM $component c";
        
        $dql = 'SELECT c.' . $column . ' FROM ' . $component . ' c ORDER BY c.' . $column . ' DESC LIMIT 1';
  
        $coll = $this->table->getConnection()->query($dql);
  
        $max = $coll[0]->get($column);
  
        $max = !is_null($max) ? $max : 0;
  
        return $max;      
    }

    /**
     * returns parsed query with root id where clause added if applicable
     *
     * @param object    $query    Doctrine_Query
     * @param integer   $root_id  id of destination root
     * @return object   Doctrine_Query
zYne's avatar
zYne committed
248
     */
249 250
    public function returnQueryWithRootId($query, $rootId = 1)
    {
zYne's avatar
zYne committed
251
        if ($root = $this->getAttribute('rootColumnName')) {
252 253 254 255 256 257
            if (is_array($rootId)) {
               $query->addWhere($root . ' IN (' . implode(',', array_fill(0, count($rootId), '?')) . ')',
                       $rootId);
            } else {
               $query->addWhere($root . ' = ?', $rootId); 
            }
258 259 260 261
        }

        return $query;
    }
262

263 264 265 266 267 268 269 270
    /**
     * Enter description here...
     *
     * @param array $options
     * @return unknown
     */
    public function getBaseQuery()
    {
271
        if ( ! isset($this->_baseQuery)) {
272 273
            $this->_baseQuery = $this->_createBaseQuery();
        }
274
        return $this->_baseQuery->copy();
275
    }
276

277 278 279 280 281 282 283 284
    /**
     * Enter description here...
     *
     */
    public function getBaseAlias()
    {
        return $this->_baseAlias;
    }
285

286 287 288 289 290 291
    /**
     * Enter description here...
     *
     */
    private function _createBaseQuery()
    {
292
        $this->_baseAlias = "base";
293
        $q = new Doctrine_Query();
294
        $q->select($this->_baseAlias . ".*")->from($this->getBaseComponent() . " " . $this->_baseAlias);
295 296
        return $q;
    }
297

298 299 300 301 302 303 304
    /**
     * Enter description here...
     *
     * @param Doctrine_Query $query
     */
    public function setBaseQuery(Doctrine_Query $query)
    {
305 306
        $this->_baseAlias = $query->getRootAlias();
        $query->addSelect($this->_baseAlias . ".lft, " . $this->_baseAlias . ".rgt, ". $this->_baseAlias . ".level");
307
        if ($this->getAttribute('rootColumnName')) {
308
            $query->addSelect($this->_baseAlias . "." . $this->getAttribute('rootColumnName'));
309 310 311
        }
        $this->_baseQuery = $query;
    }
312

313 314 315 316 317 318
    /**
     * Enter description here...
     *
     */
    public function resetBaseQuery()
    {
319
        $this->_baseQuery = $this->_createBaseQuery();
320
    }
321

322
}