This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilTreeTrashQueries:

Public Member Functions
	__construct ()
	ilTreeTrash constructor. More...

	isTrashedTrash (array $ref_ids)

	findRepositoryLocationForDeletedNode (int $deleted_node)

	getTrashedNodeTypesForContainer (int $ref_id)

	getNumberOfTrashedNodesForTrashedContainer (int $ref_id)

	getTrashNodeForContainer (int $ref_id, array $filter, int &$max_entries, string $order_field, string $order_direction, int $limit=self::QUERY_LIMIT, int $offset=0)
	Get trashed nodes. More...

	getTrashedNodesForContainerUsingRecursion (int $ref_id)
	Unfortunately not supported by mysql 5. More...

Protected Member Functions
	appendTrashNodeForContainerQueryFilter (array $filter)

Protected Attributes
const	QUERY_LIMIT = 10

Private Attributes
int	$ref_id = 0

ilTree	$tree

ilLogger	$logger

ilDBInterface	$db

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 24 of file class.ilTreeTrashQueries.php.

Constructor & Destructor Documentation

◆ __construct()

ilTreeTrashQueries::__construct ( )

ilTreeTrash constructor.

Definition at line 39 of file class.ilTreeTrashQueries.php.

References $DIC, and ILIAS\Repository\logger().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->logger = $DIC->logger()->tree();
         $this->tree = $DIC->repositoryTree();
     }

Here is the call graph for this function:

Member Function Documentation

◆ appendTrashNodeForContainerQueryFilter()

ilTreeTrashQueries::appendTrashNodeForContainerQueryFilter ( array $filter )

protected

Parameters

array{type? string, title?: string, deleted?: array{from?: , to?: }} $filter

Returns: string

Definition at line 211 of file class.ilTreeTrashQueries.php.

References ilObjUser\_lookupId(), IL_CAL_DATE, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by getTrashNodeForContainer().

                                                                             : string
     {
         $query = '';
         if (isset($filter['type'])) {
             $query .= 'and ' . $this->db->like(
                 'type',
                 \ilDBConstants::T_TEXT,
                 $filter['type']
             ) . ' ';
         }
         if (isset($filter['title'])) {
             $query .= 'and ' . $this->db->like(
                 'title',
                 \ilDBConstants::T_TEXT,
                 '%' . $filter['title'] . '%'
             ) . ' ';
         }
 
         // #33781 use an explizit date format to really include the 'to' date because it can be interpreted as 'xxxx-xx-xx 00:00:00'
         if (
             $filter['deleted']['from'] instanceof \ilDate &&
             $filter['deleted']['to'] instanceof \ilDate) {
             $query .= ('AND deleted BETWEEN ' .
                 $this->db->quote($filter['deleted']['from']->get(\IL_CAL_DATE), \ilDBConstants::T_TEXT) . ' AND ' .
                 $this->db->quote($filter['deleted']['to']->get(IL_CAL_DATE) . " 23:59:59", \ilDBConstants::T_TEXT) . ' ');
         } elseif ($filter['deleted']['from'] instanceof \ilDate) {
             $query .= 'AND deleted >= ' . $this->db->quote(
                 $filter['deleted']['from']->get(IL_CAL_DATE),
                 \ilDBConstants::T_TEXT
             ) . ' ';
         } elseif ($filter['deleted']['to'] instanceof \ilDate) {
             $query .= 'AND deleted <= ' . $this->db->quote(
                 $filter['deleted']['to']->get(IL_CAL_DATE) . " 23:59:59",
                 \ilDBConstants::T_TEXT
             ) . ' ';
         }
 
         if (isset($filter['deleted_by']) && !empty($filter['deleted_by'])) {
             $usr_id = \ilObjUser::_lookupId($filter['deleted_by']);
             if ($usr_id > 0) {
                 $query .= 'AND deleted_by = ' . $this->db->quote($usr_id, \ilDBConstants::T_INTEGER) . ' ';
             } else {
                 $query .= 'AND 1=2 ';
             }
         }
 
         return $query;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findRepositoryLocationForDeletedNode()

ilTreeTrashQueries::findRepositoryLocationForDeletedNode ( int $deleted_node )

Parameters

int $deleted_node

Returns: int $rep_ref_id

Exceptions

Definition at line 74 of file class.ilTreeTrashQueries.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\logger(), and ilDBConstants\T_INTEGER.

                                                                            : int
     {
         $query = 'select parent from tree ' .
             'where child = ' . $this->db->quote($deleted_node, \ilDBConstants::T_INTEGER) . ' ' .
             'and tree = ' . $this->db->quote($deleted_node * -1, \ilDBConstants::T_INTEGER);
         $this->logger->debug($query);
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
             return (int) $row->parent;
         }
         $this->logger->warning('Invalid node given for restoring to original location: deleted node id: ' . $deleted_node);
         throw new \ilRepositoryException('Invalid node given for restoring to original location');
     }

Here is the call graph for this function:

◆ getNumberOfTrashedNodesForTrashedContainer()

ilTreeTrashQueries::getNumberOfTrashedNodesForTrashedContainer ( int $ref_id )

Parameters

int $ref_id

Returns: int

Definition at line 113 of file class.ilTreeTrashQueries.php.

References $res.

                                                                            : int
     {
         $res = $this->db->query($this->tree->getTrashSubTreeQuery($ref_id, ['child']));
         return $res->numRows();
     }

◆ getTrashedNodesForContainerUsingRecursion()

ilTreeTrashQueries::getTrashedNodesForContainerUsingRecursion ( int $ref_id )

Unfortunately not supported by mysql 5.

Parameters

int $ref_id

Returns: void

Exceptions

ilDatabaseException

Deprecated:

Definition at line 185 of file class.ilTreeTrashQueries.php.

References Vendor\Package\$e, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), ILIAS\Repository\logger(), and ilDBConstants\T_INTEGER.

                                                                           : void
     {
         $query = 'WITH RECURSIVE trash (child,tree) AS ' .
             '( SELECT child, tree FROM tree WHERE child = ' . $this->db->quote(
                 $ref_id,
                 \ilDBConstants::T_INTEGER
             ) . ' ' .
             'UNION SELECT tc.child,tc.tree FROM tree tc JOIN tree tp ON tp.child = tc.parent ) ' .
             'SELECT * FROM trash WHERE tree < 1 ';
 
         $trash_ids = [];
         try {
             $res = $this->db->query($query);
             while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
                 $trash_ids[] = (int) $row->child;
             }
         } catch (\ilDatabaseException $e) {
             $this->logger->warning($query . ' is not supported');
             throw $e;
         }
     }

Here is the call graph for this function:

◆ getTrashedNodeTypesForContainer()

ilTreeTrashQueries::getTrashedNodeTypesForContainer ( int $ref_id )

Parameters

int $ref_id

Returns: string[]

Definition at line 92 of file class.ilTreeTrashQueries.php.

References $res, and ilDBConstants\FETCHMODE_OBJECT.

                                                                 : array
     {
         $subtreequery = $this->tree->getTrashSubTreeQuery($ref_id, ['child']);
         $query = 'select distinct(type) obj_type from object_data obd ' .
             'join object_reference obr on obd.obj_id = obr.obj_id ' .
             'where ref_id in (' .
             $subtreequery . ' ' .
             ') ';
 
         $obj_types = [];
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
             $obj_types[] = (string) $row->obj_type;
         }
         return $obj_types;
     }

◆ getTrashNodeForContainer()

ilTreeTrashQueries::getTrashNodeForContainer	(	int	$ref_id,
		array	$filter,
		int &	$max_entries,
		string	$order_field,
		string	$order_direction,
		int	$limit = `self::QUERY_LIMIT`,
		int	$offset = `0`
	)

Get trashed nodes.

Returns: ilTreeTrashItem[]

Exceptions

Count query

Definition at line 124 of file class.ilTreeTrashQueries.php.

References $res, appendTrashNodeForContainerQueryFilter(), ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

      : array {
         $subtreequery = $this->tree->getTrashSubTreeQuery($ref_id, ['child']);
 
         $select = 'SELECT ref_id, obd.obj_id, type, title, description, deleted, deleted_by ';
         $select_count = 'SELECT COUNT(ref_id) max_entries ';
 
         $from = 'FROM object_data obd ' .
             'JOIN object_reference obr ON obd.obj_id = obr.obj_id ' .
             'WHERE ref_id IN (' .
             $subtreequery . ' ' .
             ') ';
 
         $order = ' ';
         if ($order_field) {
             $order = 'ORDER BY ' . $order_field . ' ' . $order_direction;
         }
 
         $query = $select . $from . $this->appendTrashNodeForContainerQueryFilter($filter) . $order;
         $query_count = $select_count . $from . $this->appendTrashNodeForContainerQueryFilter($filter);
 
         $res_max_entries = $this->db->query($query_count);
         while ($max_entries_row = $res_max_entries->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
             $max_entries = (int) $max_entries_row->max_entries;
         }
 
         $this->db->setLimit($limit, $offset);
         $res = $this->db->query($query);
 
         $items = [];
         while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
             $item = new \ilTreeTrashItem();
             $item->setObjId((int) $row->obj_id);
             $item->setRefId((int) $row->ref_id);
             $item->setTitle((string) $row->title);
             $item->setDescription((string) $row->description);
             $item->setType((string) $row->type);
             $item->setDeleted((string) $row->deleted);
             $item->setDeletedBy((int) $row->deleted_by);
             $items[] = $item;
         }
         return $items;
     }

Here is the call graph for this function:

◆ isTrashedTrash()

ilTreeTrashQueries::isTrashedTrash ( array $ref_ids )

Parameters

int[] $ref_ids

Returns: bool

Definition at line 52 of file class.ilTreeTrashQueries.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

                                                   : bool
     {
         $query = 'select tree,child,parent from tree ' .
             'where ' . $this->db->in('child', $ref_ids, false, \ilDBConstants::T_INTEGER);
         $res = $this->db->query($query);
         $trashed_trash = false;
         while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
             if ((int) $row->child != ((int) $row->tree * -1)) {
                 $trashed_trash = true;
             }
             if ($this->tree->isDeleted((int) $row->parent)) {
                 $trashed_trash = true;
             }
         }
         return $trashed_trash;
     }