summaryrefslogtreecommitdiff
path: root/core/libraries/ORM_MPTT.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/libraries/ORM_MPTT.php')
-rw-r--r--core/libraries/ORM_MPTT.php307
1 files changed, 0 insertions, 307 deletions
diff --git a/core/libraries/ORM_MPTT.php b/core/libraries/ORM_MPTT.php
deleted file mode 100644
index 46280d95..00000000
--- a/core/libraries/ORM_MPTT.php
+++ /dev/null
@@ -1,307 +0,0 @@
-<?php defined("SYSPATH") or die("No direct script access.");
-/**
- * Gallery - a web based photo album viewer and editor
- * Copyright (C) 2000-2009 Bharat Mediratta
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or (at
- * your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
- */
-/**
- * Implement Modified Preorder Tree Traversal on top of ORM.
- *
- * MPTT is an efficient way to store and retrieve hierarchical data in a single database table.
- * For a good description, read http://www.sitepoint.com/article/hierarchical-data-database/3/
- *
- * This code was heavily influenced by code from:
- * - http://code.google.com/p/kohana-mptt/
- * - http://code.google.com/p/kohana-mptt/wiki/Documentation
- * - http://code.google.com/p/s7ncms/source/browse/trunk/modules/s7ncms/libraries/ORM_MPTT.php
- *
- * Unfortunately that code was not ready for production and I did not want to absorb their code
- * and licensing issues so I've reimplemented just the features that we need.
- */
-class ORM_MPTT_Core extends ORM {
- private $model_name = null;
-
- function __construct($id=null) {
- parent::__construct($id);
- $this->model_name = inflector::singular($this->table_name);
- }
-
- /**
- * Add this node as a child of the parent provided.
- *
- * @chainable
- * @param integer $parent_id the id of the parent node
- * @return ORM
- */
- function add_to_parent($parent) {
- $this->lock();
-
- try {
- // Make a hole in the parent for this new item
- $this->db->query(
- "UPDATE {{$this->table_name}} SET `left` = `left` + 2 WHERE `left` >= {$parent->right}");
- $this->db->query(
- "UPDATE {{$this->table_name}} SET `right` = `right` + 2 WHERE `right` >= {$parent->right}");
- $parent->right += 2;
-
- // Insert this item into the hole
- $this->left = $parent->right - 2;
- $this->right = $parent->right - 1;
- $this->parent_id = $parent->id;
- $this->level = $parent->level + 1;
- $this->save();
- $parent->reload();
- } catch (Exception $e) {
- $this->unlock();
- throw $e;
- }
-
- $this->unlock();
- return $this;
- }
-
- /**
- * Delete this node and all of its children.
- */
- public function delete() {
- $children = $this->children();
- if ($children) {
- foreach ($this->children() as $item) {
- // Deleting children affects the MPTT tree, so we have to reload each child before we
- // delete it so that we have current left/right pointers. This is inefficient.
- // @todo load each child once, not twice.
- $item->reload()->delete();
- }
-
- // Deleting children has affected this item
- $this->reload();
- }
-
- $this->lock();
- try {
- $this->db->query(
- "UPDATE {{$this->table_name}} SET `left` = `left` - 2 WHERE `left` > {$this->right}");
- $this->db->query(
- "UPDATE {{$this->table_name}} SET `right` = `right` - 2 WHERE `right` > {$this->right}");
- } catch (Exception $e) {
- $this->unlock();
- throw $e;
- }
-
- $this->unlock();
- parent::delete();
- }
-
- /**
- * Return true if the target is descendant of this item.
- * @param ORM $target
- * @return boolean
- */
- function is_descendant($target) {
- return ($this->left <= $target->left && $this->right >= $target->right);
- }
-
- /**
- * Return the parent of this node
- *
- * @return ORM
- */
- function parent() {
- if (!$this->parent_id) {
- return null;
- }
- return model_cache::get($this->model_name, $this->parent_id);
- }
-
- /**
- * Return all the parents of this node, in order from root to this node's immediate parent.
- *
- * @return array ORM
- */
- function parents() {
- return $this
- ->where("`left` <= {$this->left}")
- ->where("`right` >= {$this->right}")
- ->where("id <> {$this->id}")
- ->orderby("left", "ASC")
- ->find_all();
- }
-
- /**
- * Return all of the children of this node, ordered by id.
- *
- * @chainable
- * @param integer SQL limit
- * @param integer SQL offset
- * @param array orderby
- * @return array ORM
- */
- function children($limit=null, $offset=0, $orderby=null) {
- $this->where("parent_id", $this->id);
- if (empty($orderby)) {
- $this->orderby("id", "ASC");
- } else {
- $this->orderby($orderby);
- }
- return $this->find_all($limit, $offset);
- }
-
- /**
- * Return all of the children of this node, ordered by id.
- *
- * @chainable
- * @param integer SQL limit
- * @param integer SQL offset
- * @return array ORM
- */
- function children_count() {
- return $this->where("parent_id", $this->id)->count_all();
- }
-
- /**
- * Return all of the children of the specified type, ordered by id.
- *
- * @param integer SQL limit
- * @param integer SQL offset
- * @param string type to return
- * @param array orderby
- * @return object ORM_Iterator
- */
- function descendants($limit=null, $offset=0, $type=null, $orderby=null) {
- $this->where("left >", $this->left)
- ->where("right <=", $this->right);
- if ($type) {
- $this->where("type", $type);
- }
-
- if (empty($orderby)) {
- $this->orderby("id", "ASC");
- } else {
- $this->orderby($orderby);
- }
-
- return $this->find_all($limit, $offset);
- }
-
- /**
- * Return the count of all the children of the specified type.
- *
- * @param string type to count
- * @return integer child count
- */
- function descendants_count($type=null) {
- $this->where("left >", $this->left)
- ->where("right <=", $this->right);
- if ($type) {
- $this->where("type", $type);
- }
- return $this->count_all();
- }
-
- /**
- * Move this item to the specified target.
- *
- * @chainable
- * @param Item_Model $target Target node
- * @return ORM_MTPP
- */
- function move_to($target) {
- if ($this->left <= $target->left &&
- $this->right >= $target->right) {
- throw new Exception("@todo INVALID_TARGET can't move item inside itself");
- }
-
- $number_to_move = (int)(($this->right - $this->left) / 2 + 1);
- $size_of_hole = $number_to_move * 2;
- $original_left = $this->left;
- $original_right = $this->right;
- $target_right = $target->right;
- $level_delta = ($target->level + 1) - $this->level;
-
- $this->lock();
- try {
- if ($level_delta) {
- // Update the levels for the to-be-moved items
- $this->db->query(
- "UPDATE {{$this->table_name}} SET `level` = `level` + $level_delta" .
- " WHERE `left` >= $original_left AND `right` <= $original_right");
- }
-
- // Make a hole in the target for the move
- $target->db->query(
- "UPDATE {{$this->table_name}} SET `left` = `left` + $size_of_hole" .
- " WHERE `left` >= $target_right");
- $target->db->query(
- "UPDATE {{$this->table_name}} SET `right` = `right` + $size_of_hole" .
- " WHERE `right` >= $target_right");
-
- // Change the parent.
- $this->db->query(
- "UPDATE {{$this->table_name}} SET `parent_id` = {$target->id}" .
- " WHERE `id` = {$this->id}");
-
- // If the source is to the right of the target then we just adjusted its left and right above.
- $left = $original_left;
- $right = $original_right;
- if ($original_left > $target_right) {
- $left += $size_of_hole;
- $right += $size_of_hole;
- }
-
- $new_offset = $target->right - $left;
- $this->db->query(
- "UPDATE {{$this->table_name}}" .
- " SET `left` = `left` + $new_offset," .
- " `right` = `right` + $new_offset" .
- " WHERE `left` >= $left" .
- " AND `right` <= $right");
-
- // Close the hole in the source's parent after the move
- $this->db->query(
- "UPDATE {{$this->table_name}} SET `left` = `left` - $size_of_hole" .
- " WHERE `left` > $right");
- $this->db->query(
- "UPDATE {{$this->table_name}} SET `right` = `right` - $size_of_hole" .
- " WHERE `right` > $right");
- } catch (Exception $e) {
- $this->unlock();
- throw $e;
- }
-
- $this->unlock();
-
- // Lets reload to get the changes.
- $this->reload();
- return $this;
- }
-
- /**
- * Lock the tree to prevent concurrent modification.
- */
- protected function lock() {
- $result = $this->db->query("SELECT GET_LOCK('{$this->table_name}', 1) AS l")->current();
- if (empty($result->l)) {
- throw new Exception("@todo UNABLE_TO_LOCK_EXCEPTION");
- }
- }
-
- /**
- * Unlock the tree.
- */
- protected function unlock() {
- $this->db->query("SELECT RELEASE_LOCK('{$this->table_name}')");
- }
-}
generated by cgit v1.2.3 (git 2.46.0) at 2025-10-17 03:45:43 +0000