class.ilObjFileListGUI.php

Go to the documentation of this file.

<?php

use ILIAS\FileUpload\MimeType;

class ilObjFileListGUI extends ilObjectListGUI
{
    use ilObjFileSecureString;

    private ilObjFileInfoRepository $file_info;
    protected string $title;

    public function __construct(int $context = self::CONTEXT_REPOSITORY)
    {
        parent::__construct($context);
        $this->file_info = new ilObjFileInfoRepository();
    }

    public function init(): void
    {
        $this->delete_enabled = true;
        $this->cut_enabled = true;
        $this->copy_enabled = true;
        $this->subscribe_enabled = true;
        $this->link_enabled = true;
        $this->info_screen_enabled = true;
        $this->type = ilObjFile::OBJECT_TYPE;
        $this->gui_class_name = ilObjFileGUI::class;
        $this->commands = ilObjFileAccess::_getCommands();
    }

    public function getCommandFrame(string $cmd): string
    {
        $info = $this->file_info->getByObjectId($this->obj_id);

        $frame = "";
        switch ($cmd) {
            case 'sendfile':
                if ($info->shouldDeliverInline()) {
                    $frame = '_blank';
                }
                break;
            case "":
                $frame = ilFrameTargetInfo::_getFrame("RepositoryContent");
                break;

            default:
        }

        return $frame;
    }



    public function getIconImageType(): string
    {
        return $this->file_info->getByObjectId($this->obj_id)->shouldDeliverInline()
            ? $this->type . '_inline'
            : $this->type;
    }


    public function getTitle(): string
    {
        // Remove filename extension from title
        return $this->file_info->getByObjectId($this->obj_id)->getListTitle();

        return $this->secure(preg_replace('/\\.[a-z0-9]+\\z/i', '', $this->title));

    }

    public function getProperties(): array
    {
        global $DIC;

        $props = parent::getProperties();

        $info = $this->file_info->getByObjectId($this->obj_id);

        $revision = $info->getVersion();

        $props[] = array(
            "alert" => false,
            "property" => $DIC->language()->txt("type"),
            "value" => $info->getSuffix(),
            'propertyNameVisible' => false,
        );

        $props[] = array(
            "alert" => false,
            "property" => $DIC->language()->txt("size"),
            "value" => (string) $info->getFileSize(),
            'propertyNameVisible' => false,
        );

        $version = $info->getVersion();
        if ($version > 1) {
            // add versions link
            if (parent::checkCommandAccess("write", "versions", $this->ref_id, $this->type)) {
                $link = $this->getCommandLink("versions");
                $value = "<a href=\"$link\">" . $DIC->language()->txt("version") . ": $version</a>";
            } else {
                $value = $DIC->language()->txt("version") . ": $version";
            }
            $props[] = array(
                "alert" => false,
                "property" => $DIC->language()->txt("version"),
                "value" => $value,
                "propertyNameVisible" => false,
            );
        }

        $props[] = array(
            "alert" => false,
            "property" => $DIC->language()->txt("last_update"),
            "value" => ilDatePresentation::formatDate(
                new ilDateTime($info->getCreationDate()->format('U'), IL_CAL_UNIX)
            ),
            'propertyNameVisible' => false,
        );

        if ($info->getPageCount() !== null && $info->getPageCount() > 0) {
            $props[] = array(
                "alert" => false,
                "property" => $DIC->language()->txt("page_count"),
                "value" => $info->getPageCount(),
                'propertyNameVisible' => true,
            );
        }

        return $props;
    }

    public function getCommandImage($a_cmd): string
    {
        return "";
    }

    public function checkCommandAccess(
        string $permission,
        string $cmd,
        int $ref_id,
        string $type,
        ?int $obj_id = null
    ): bool {
        if (ilFileVersionsGUI::CMD_UNZIP_CURRENT_REVISION === $cmd) {
            $info = $this->file_info->getByObjectId($this->obj_id);

            return $info->isZip() && parent::checkCommandAccess(
                $permission,
                $cmd,
                $ref_id,
                $type,
                $obj_id
            );
        }

        return parent::checkCommandAccess(
            $permission,
            $cmd,
            $ref_id,
            $type,
            $obj_id
        );
    }

    public function getCommandLink(string $cmd): string
    {
        // only create permalink for repository
        if ($cmd === "sendfile" && $this->context === self::CONTEXT_REPOSITORY) {
            // return the perma link for downloads
            return ilObjFileAccess::_getPermanentDownloadLink($this->ref_id);
        }

        if (ilFileVersionsGUI::CMD_UNZIP_CURRENT_REVISION === $cmd) {
            $info = $this->file_info->getByObjectId($this->obj_id);

            if ($info->isZip()) {
                $this->ctrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', $this->ref_id);
                $cmd_link = $this->ctrl->getLinkTargetByClass(
                    ilRepositoryGUI::class,
                    ilFileVersionsGUI::CMD_UNZIP_CURRENT_REVISION
                );
                $this->ctrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', $this->requested_ref_id);
            } else {
                $access_granted = false;
            }
        }


        return parent::getCommandLink($cmd);
    }
}