class.ilObjFileListGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "Services/Object/classes/class.ilObjectListGUI.php";

class ilObjFileListGUI extends ilObjectListGUI
{
    use ilObjFileSecureString;
    
    protected $title = '';
    
    public function init()
    {
        $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 = "file";
        $this->gui_class_name = "ilobjfilegui";

        // general commands array
        $this->commands = ilObjFileAccess::_getCommands();
    }


    public function getCommandFrame($a_cmd)
    {
        $frame = "";
        switch ($a_cmd) {
            case 'sendfile':
                if (ilObjFileAccess::_isFileInline($this->title)) {
                    $frame = '_blank';
                }
                break;
            case "":
                $frame = ilFrameTargetInfo::_getFrame("RepositoryContent");
                break;

            default:
        }

        return $frame;
    }


    public function getIconImageType()
    {
        return ilObjFileAccess::_isFileInline($this->title) ? $this->type . '_inline' : $this->type;
    }


    public function getTitle()
    {
        // Remove filename extension from title
        $string = preg_replace('/\\.[a-z0-9]+\\z/i', '', $this->title);
        return $this->secure(is_string($string) ? $string : '');
    }


    public function getProperties()
    {
        global $DIC;

        $props = parent::getProperties();

        // to do: implement extra smaller file info object

        // Display a warning if a file is not a hidden Unix file, and
        // the filename extension is missing
        if (!preg_match('/^\\.|\\.[a-zA-Z0-9]+$/', $this->title)) {
            $props[] = array(
                "alert" => false,
                "property" => $DIC->language()->txt("filename_interoperability"),
                "value" => $DIC->language()->txt("filename_extension_missing"),
                'propertyNameVisible' => false,
            );
        }

        $props[] = array(
            "alert" => false,
            "property" => $DIC->language()->txt("type"),
            "value" => ilObjFileAccess::_getFileExtension($this->title),
            'propertyNameVisible' => false,
        );

        $file_data = ilObjFileAccess::getListGUIData($this->obj_id);
        if (is_array($file_data)) {

            if(empty($file_data['rid']) && parent::checkCommandAccess("write", "versions", $this->ref_id, $this->type)) {
                $props[] = array(
                    "alert" => true,
                    "property" => $DIC->language()->txt("migrated"),
                    "value" => $DIC->language()->txt("not_yet_migrated"),
                    "propertyNameVisible" => false,
                    "newline"=>true
                );
            }


            $props[] = array(
                "alert" => false,
                "property" => $DIC->language()->txt("size"),
                "value" => ilUtil::formatSize($file_data['size'], 'short'),
                'propertyNameVisible' => false,
            );
            $version = $file_data['version'];
            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,
                );
            }


            // #6040
            if ($file_data["date"]) {
                $props[] = array(
                    "alert" => false,
                    "property" => $DIC->language()->txt("last_update"),
                    "value" => ilDatePresentation::formatDate(new ilDateTime($file_data["date"], IL_CAL_DATETIME)),
                    'propertyNameVisible' => false,
                );
            }

            if ($file_data["page_count"]) {
                $props[] = array(
                    "alert" => false,
                    "property" => $DIC->language()->txt("page_count"),
                    "value" => $file_data["page_count"],
                    'propertyNameVisible' => true,
                );
            }
        }

        return $props;
    }


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


    public function getCommandLink($a_cmd)
    {
        // overwritten to always return the permanent download link

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

        return parent::getCommandLink($a_cmd);
    }
} // END class.ilObjFileListGUI