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

Collaboration diagram for ilItemGroupItems:

Public Member Functions
	__construct (int $a_item_group_ref_id=0)

	setItemGroupId (int $a_val)

	getItemGroupId ()

	setItemGroupRefId (int $a_val)

	getItemGroupRefId ()

	setItems (array $a_val)

	getItems ()

	addItem (int $a_item_ref_id)

	delete ()

	update ()

	read ()

	getAssignableItems ()

	getValidItems ()

	cloneItems (int $a_source_id, int $a_copy_id)

Static Public Member Functions
static	_getItemsOfContainer (int $a_ref_id)

Data Fields
ilTree	$tree

ilLanguage	$lng

int	$item_group_id = 0

int	$item_group_ref_id = 0

array	$items = array()

Protected Attributes
ilDBInterface	$db

ilObjectDefinition	$obj_def

ilObjectDataCache	$obj_data_cache

ilLogger	$log

ilAccessHandler	$access

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 Item group items. This class is used to store the materials (items) that are assigned to an item group. Main table used is item_group_item

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.ilItemGroupItems.php.

Constructor & Destructor Documentation

◆ __construct()

ilItemGroupItems::__construct ( int $a_item_group_ref_id = 0 )

Definition at line 38 of file class.ilItemGroupItems.php.

      {
        global $DIC;
 
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $this->log = $DIC["ilLog"];
        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->tree = $DIC->repositoryTree();
        $this->obj_def = $DIC["objDefinition"];
        $this->access = $DIC->access();
 
        $this->setItemGroupRefId($a_item_group_ref_id);
        if ($this->getItemGroupRefId() > 0) {
            $this->setItemGroupId(ilObject::_lookupObjId($a_item_group_ref_id));
        }
 
        if ($this->getItemGroupId() > 0) {
            $this->read();
        }
    }

References $DIC, ilObject\_lookupObjId(), ILIAS\Repository\access(), getItemGroupId(), getItemGroupRefId(), ILIAS\Repository\lng(), read(), setItemGroupId(), and setItemGroupRefId().

Here is the call graph for this function:

Member Function Documentation

◆ _getItemsOfContainer()

static ilItemGroupItems::_getItemsOfContainer ( int $a_ref_id )

static

Definition at line 218 of file class.ilItemGroupItems.php.

                                                              : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $tree = $DIC->repositoryTree();
 
        $itgr_ids = [];
        $itgr_nodes = $tree->getChildsByType($a_ref_id, 'itgr');
        foreach ($itgr_nodes as $node) {
            $itgr_ids[] = $node['obj_id'];
        }
        $query = "SELECT item_ref_id FROM item_group_item " .
            "WHERE " . $ilDB->in('item_group_id', $itgr_ids, false, 'integer');
 
 
        $res = $ilDB->query($query);
        $items = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $items[] = $row->item_ref_id;
        }
        return $items;
    }

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ilTree\getChildsByType().

Referenced by ilRepositoryExplorer\isVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addItem()

ilItemGroupItems::addItem ( int $a_item_ref_id )

Definition at line 94 of file class.ilItemGroupItems.php.

                                               : void
    {
        if (!in_array($a_item_ref_id, $this->items)) {
            $this->items[] = $a_item_ref_id;
        }
    }

◆ cloneItems()

ilItemGroupItems::cloneItems	(	int	$a_source_id,
		int	$a_copy_id
	)

Definition at line 191 of file class.ilItemGroupItems.php.

     : void {
        $ilLog = $this->log;
 
        $ilLog->write(__METHOD__ . ': Begin cloning item group materials ... -' . $a_source_id . '-');
 
        $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
        $mappings = $cwo->getMappings();
 
        $new_items = array();
        // check: is this a ref id!?
        $source_ig = new ilItemGroupItems($a_source_id);
        foreach ($source_ig->getItems() as $item_ref_id) {
            if (isset($mappings[$item_ref_id]) and $mappings[$item_ref_id]) {
                $ilLog->write(__METHOD__ . ': Clone item group item nr. ' . $item_ref_id);
                $new_items[] = $mappings[$item_ref_id];
            } else {
                $ilLog->write(__METHOD__ . ': No mapping found for item group item nr. ' . $item_ref_id);
            }
        }
        $this->setItems($new_items);
        $this->update();
        $ilLog->write(__METHOD__ . ': Finished cloning item group items ...');
    }

◆ delete()

ilItemGroupItems::delete ( )

Definition at line 101 of file class.ilItemGroupItems.php.

                            : void
    {
        $query = "DELETE FROM item_group_item " .
            "WHERE item_group_id = " . $this->db->quote($this->getItemGroupId(), 'integer');
        $this->db->manipulate($query);
    }

References getItemGroupId().

Here is the call graph for this function:

◆ getAssignableItems()

ilItemGroupItems::getAssignableItems ( )

Definition at line 134 of file class.ilItemGroupItems.php.

                                        : array
    {
        if ($this->getItemGroupRefId() <= 0) {
            return array();
        }
 
        $parent_node = $this->tree->getNodeData(
            $this->tree->getParentId($this->getItemGroupRefId())
        );
 
        $materials = array();
        $nodes = $this->tree->getChilds($parent_node["child"]);
 
        foreach ($nodes as $node) {
            // filter side blocks and session, item groups and role folder
            if ($node['child'] == $parent_node["child"] ||
                $this->obj_def->isSideBlock($node['type']) ||
                in_array($node['type'], array('sess', 'itgr', 'rolf', 'adm'))) {
                continue;
            }
 
            // filter hidden files
            // see http://www.ilias.de/mantis/view.php?id=10269
            if ($node['type'] == "file" &&
                ilObjFileAccess::_isFileHidden((string) $node['title'])) {
                continue;
            }
 
            if ($this->obj_def->isInactivePlugin((string) $node['type'])) {
                continue;
            }
 
            if (!$this->access->checkAccess('visible', '', $node['ref_id'])) {
                continue;
            }
 
            $materials[] = $node;
        }
 
        $materials = ilArrayUtil::sortArray($materials, "title", "asc");
 
        return $materials;
    }

References ilObjFileAccess\_isFileHidden(), ILIAS\Repository\access(), getItemGroupRefId(), and ilArrayUtil\sortArray().

Referenced by getValidItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemGroupId()

ilItemGroupItems::getItemGroupId ( )

Definition at line 66 of file class.ilItemGroupItems.php.

                                    : int
    {
        return $this->item_group_id;
    }

References $item_group_id.

Referenced by __construct(), delete(), and update().

Here is the caller graph for this function:

◆ getItemGroupRefId()

ilItemGroupItems::getItemGroupRefId ( )

Definition at line 76 of file class.ilItemGroupItems.php.

                                       : int
    {
        return $this->item_group_ref_id;
    }

References $item_group_ref_id.

Referenced by __construct(), and getAssignableItems().

Here is the caller graph for this function:

◆ getItems()

ilItemGroupItems::getItems ( )

Definition at line 89 of file class.ilItemGroupItems.php.

                              : array
    {
        return $this->items;
    }

References $items.

Referenced by getValidItems().

Here is the caller graph for this function:

◆ getValidItems()

ilItemGroupItems::getValidItems ( )

Definition at line 178 of file class.ilItemGroupItems.php.

                                   : array
    {
        $items = $this->getItems();
        $ass_items = $this->getAssignableItems();
        $valid_items = array();
        foreach ($ass_items as $aitem) {
            if (in_array($aitem["ref_id"], $items)) {
                $valid_items[] = $aitem["ref_id"];
            }
        }
        return $valid_items;
    }

References $items, getAssignableItems(), and getItems().

Here is the call graph for this function:

◆ read()

ilItemGroupItems::read ( )

Definition at line 122 of file class.ilItemGroupItems.php.

                          : void
    {
        $this->items = array();
        $set = $this->db->query(
            "SELECT * FROM item_group_item " .
            " WHERE item_group_id = " . $this->db->quote($this->getItemGroupId(), "integer")
        );
        while ($rec = $this->db->fetchAssoc($set)) {
            $this->items[] = $rec["item_ref_id"];
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setItemGroupId()

ilItemGroupItems::setItemGroupId ( int $a_val )

Definition at line 61 of file class.ilItemGroupItems.php.

                                              : void
    {
        $this->item_group_id = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setItemGroupRefId()

ilItemGroupItems::setItemGroupRefId ( int $a_val )

Definition at line 71 of file class.ilItemGroupItems.php.

                                                 : void
    {
        $this->item_group_ref_id = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setItems()

ilItemGroupItems::setItems ( array $a_val )

Parameters

int[] $a_val items (array of ref ids)

Definition at line 84 of file class.ilItemGroupItems.php.

                                          : void
    {
        $this->items = $a_val;
    }

◆ update()

ilItemGroupItems::update ( )

Definition at line 108 of file class.ilItemGroupItems.php.

                            : void
    {
        $this->delete();
 
        foreach ($this->items as $item) {
            $query = "INSERT INTO item_group_item (item_group_id,item_ref_id) " .
                "VALUES( " .
                $this->db->quote($this->getItemGroupId(), 'integer') . ", " .
                $this->db->quote($item, 'integer') . " " .
                ")";
            $this->db->manipulate($query);
        }
    }

References getItemGroupId().

Here is the call graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilItemGroupItems::$access

protected

Definition at line 31 of file class.ilItemGroupItems.php.

◆ $db

ilDBInterface ilItemGroupItems::$db

protected

Definition at line 27 of file class.ilItemGroupItems.php.

◆ $item_group_id

int ilItemGroupItems::$item_group_id = 0

Definition at line 34 of file class.ilItemGroupItems.php.

Referenced by getItemGroupId().

◆ $item_group_ref_id

int ilItemGroupItems::$item_group_ref_id = 0

Definition at line 35 of file class.ilItemGroupItems.php.

Referenced by getItemGroupRefId().

◆ $items

array ilItemGroupItems::$items = array()

Definition at line 36 of file class.ilItemGroupItems.php.

Referenced by getItems(), and getValidItems().

◆ $lng

ilLanguage ilItemGroupItems::$lng

Definition at line 33 of file class.ilItemGroupItems.php.

◆ $log

ilLogger ilItemGroupItems::$log

protected

Definition at line 30 of file class.ilItemGroupItems.php.

◆ $obj_data_cache

ilObjectDataCache ilItemGroupItems::$obj_data_cache

protected

Definition at line 29 of file class.ilItemGroupItems.php.

◆ $obj_def

ilObjectDefinition ilItemGroupItems::$obj_def

protected

Definition at line 28 of file class.ilItemGroupItems.php.

◆ $tree

ilTree ilItemGroupItems::$tree

Definition at line 32 of file class.ilItemGroupItems.php.

The documentation for this class was generated from the following file:

components/ILIAS/ItemGroup/classes/class.ilItemGroupItems.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getItemsOfContainer()

◆ addItem()

◆ cloneItems()

◆ delete()

◆ getAssignableItems()

◆ getItemGroupId()

◆ getItemGroupRefId()

◆ getItems()

◆ getValidItems()

◆ read()

◆ setItemGroupId()

◆ setItemGroupRefId()

◆ setItems()

◆ update()

Field Documentation

◆ $access

◆ $db

◆ $item_group_id

◆ $item_group_ref_id

◆ $items

◆ $lng

◆ $log

◆ $obj_data_cache

◆ $obj_def

◆ $tree