class.ilObjItemGroup.php

Go to the documentation of this file.

<?php

class ilObjItemGroup extends ilObject2
{
    protected ilObjectDefinition $obj_def;
    protected int $access_type;
    protected int $access_begin;
    protected int $access_end;
    protected bool $access_visibility;
    protected ?ilItemGroupAR $item_data_ar = null;

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

        $this->log = $DIC["ilLog"];
        $tree = $DIC->repositoryTree();
        $objDefinition = $DIC["objDefinition"];
        $ilDB = $DIC->database();

        $this->tree = $tree;
        $this->obj_def = $objDefinition;
        $this->db = $ilDB;

        $this->item_data_ar = new ilItemGroupAR();

        parent::__construct($a_id, $a_reference);
    }

    public function setId($a_id): void
    {
        parent::setId($a_id);
        $this->item_data_ar->setId($a_id);
    }

    public function initType(): void
    {
        $this->type = "itgr";
    }

    public function setHideTitle(bool $a_val): void
    {
        $this->item_data_ar->setHideTitle($a_val);
    }

    public function getHideTitle(): bool
    {
        return $this->item_data_ar->getHideTitle();
    }

    public function setBehaviour(int $a_val): void
    {
        $this->item_data_ar->setBehaviour($a_val);
    }

    public function getListPresentation(): string
    {
        return $this->item_data_ar->getListPresentation();
    }

    public function setListPresentation(string $a_val): void
    {
        $this->item_data_ar->setListPresentation($a_val);
    }

    public function getTileSize(): int
    {
        return $this->item_data_ar->getTileSize();
    }

    public function setTileSize(int $a_val): void
    {
        $this->item_data_ar->setTileSize($a_val);
    }

    public function getBehaviour(): int
    {
        return $this->item_data_ar->getBehaviour();
    }

    protected function doRead(): void
    {
        $this->item_data_ar = new ilItemGroupAR($this->getId());
    }

    protected function doCreate(bool $clone_mode = false): void
    {
        global $DIC;

        if ($this->getId()) {
            $this->item_data_ar->setId($this->getId());
            $this->item_data_ar->create();
        }

        $lng = $DIC->language();

        // add default translation
        $obj_trans = ilObjectTranslation::getInstance($this->getId());
        $obj_trans->addLanguage(
            $lng->getDefaultLanguage(),
            $this->getTitle(),
            $this->getDescription(),
            true,
            true
        );
        $obj_trans->save();
    }

    protected function doUpdate(): void
    {
        if ($this->getId()) {
            $this->item_data_ar->update();

            $trans = ilObjectTranslation::getInstance($this->getId());;
            $trans->setDefaultTitle($this->getTitle());
            $trans->setDefaultDescription($this->getLongDescription());
            $trans->save();
        }
    }

    protected function doDelete(): void
    {
        if ($this->getId()) {
            $this->item_data_ar->delete();
        }
    }

    protected function doCloneObject(ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id = null): void
    {
        assert($new_obj instanceof ilObjItemGroup);
        $new_obj->setHideTitle($this->getHideTitle());
        $new_obj->setBehaviour($this->getBehaviour());
        $new_obj->setListPresentation($this->getListPresentation());
        $new_obj->setTileSize($this->getTileSize());


        // translations
        $ot = ilObjectTranslation::getInstance($this->getId());
        $ot->copy($new_obj->getId());
        $ot2 = ilObjectTranslation::getInstance($new_obj->getId());
        $ot2->read();
        if ($ot2->getDefaultTitle() !== "") {
            $new_obj->setTitle($ot2->getDefaultTitle());
        }
        if ($ot2->getDefaultDescription() !== "") {
            $new_obj->setDescription($ot2->getDefaultDescription());
        }

        $new_obj->update();
    }

    public function cloneDependencies(int $a_target_id, int $a_copy_id): bool
    {
        parent::cloneDependencies($a_target_id, $a_copy_id);

        $ig_items = new ilItemGroupItems($a_target_id);
        $ig_items->cloneItems($this->getRefId(), $a_copy_id);

        return true;
    }

    public static function fixContainerItemGroupRefsAfterCloning(
        ilContainer $a_source_container,
        int $a_copy_id
    ): void {
        global $DIC;

        $ilLog = $DIC["ilLog"];

        $ilLog->write(__METHOD__ . ': Fix item group references in ' . $a_source_container->getType());

        $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
        $mappings = $cwo->getMappings();

        $new_container_ref_id = $mappings[$a_source_container->getRefId()];
        $ilLog->write(__METHOD__ . ': 2-' . $new_container_ref_id . '-');
        $new_container_obj_id = ilObject::_lookupObjId($new_container_ref_id);

        $ilLog->write(__METHOD__ . ': 3' . $new_container_obj_id . '-');
        if (ilPageObject::_exists("cont", $new_container_obj_id)) {
            $ilLog->write(__METHOD__ . ': 4');
            $new_page = new ilContainerPage($new_container_obj_id);
            $new_page->buildDom();
            ilPCResources::modifyItemGroupRefIdsByMapping($new_page, $mappings);
            $new_page->update();
        }
        $ilLog->write(__METHOD__ . ': 5');
    }

    public static function lookupHideTitle(int $a_id): bool
    {
        return (bool) self::lookup($a_id, "hide_title");
    }

    public static function lookupBehaviour(int $a_id): int
    {
        return (int) self::lookup($a_id, "behaviour");
    }

    protected static function lookup(int $a_id, string $a_key): string
    {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query(
            "SELECT " . $a_key . " FROM itgr_data " .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
        $rec = $ilDB->fetchAssoc($set);
        return $rec[$a_key];
    }
}