class.ilObjFolder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjFolder extends ilContainer
{
    public ?ilTree $folder_tree = null;

    public function __construct(
        int $a_id = 0,
        bool $a_call_by_reference = true
    ) {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->access = $DIC->access();
        $this->type = "fold";
        parent::__construct($a_id, $a_call_by_reference);
        $this->lng->loadLanguageModule('fold');
    }

    public function setFolderTree(ilTree $a_tree): void
    {
        $this->folder_tree = $a_tree;
    }

    public function cloneObject(int $target_id, int $copy_id = 0, bool $omit_tree = false): ?ilObject
    {
        $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);

        // Copy learning progress settings
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);

        return $new_obj;
    }

    public function putInTree(int $parent_ref_id): void
    {
        $tree = $this->tree;

        if (!is_object($this->folder_tree)) {
            $this->folder_tree = &$tree;
        }

        if ($this->withReferences()) {
            // put reference id into tree
            $this->folder_tree->insertNode($this->getRefId(), $parent_ref_id);
        } else {
            // put object id into tree
            $this->folder_tree->insertNode($this->getId(), $parent_ref_id);
        }
    }

    public function cloneDependencies(int $target_id, int $copy_id): bool
    {
        parent::cloneDependencies($target_id, $copy_id);

        ilObjectActivation::cloneDependencies($this->getRefId(), $target_id, $copy_id);

        return true;
    }

    public function getViewMode(): int
    {
        $tree = $this->tree;
        $possible_view_modes = [
            ilContainer::VIEW_SESSIONS,
            ilContainer::VIEW_BY_TYPE,
            ilContainer::VIEW_SIMPLE
        ];

        // always try to inherit from grp container, then crs container
        $container_grp_ref_id = $tree->checkForParentType($this->ref_id, 'grp');
        if ($container_grp_ref_id) {
            $grp_view_mode = ilObjGroup::lookupViewMode(ilObject::_lookupObjId($container_grp_ref_id));
            if (in_array($grp_view_mode, $possible_view_modes)) {
                return $grp_view_mode;
            }
        }
        $container_crs_ref_id = $tree->checkForParentType($this->ref_id, 'crs');
        if ($container_crs_ref_id) {
            $crs_view_mode = ilObjCourseAccess::_lookupViewMode(ilObject::_lookupObjId($container_crs_ref_id));
            if (in_array($crs_view_mode, $possible_view_modes)) {
                return $crs_view_mode;
            }
        }

        // default: by type
        return ilContainer::VIEW_BY_TYPE;
    }

    public function addAdditionalSubItemInformation(array &$object): void
    {
        ilObjectActivation::addAdditionalSubItemInformation($object);
    }

    public function read(): void
    {
        parent::read();

        // Inherit order type from parent course (if exists)
        $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
    }
}