ilFileUploadUtil Class Reference

Collaboration diagram for ilFileUploadUtil:

Static Public Member Functions
static	isUploadAllowed ($a_ref_id, $a_type="")
	Determines whether files can be uploaded to the object with the specified reference id. More...
static	isUploadSupported ()
	Determines whether file upload is supported at the current location. More...
static	getMaxFileSize ()
	Gets the maximum upload file size allowed in bytes. More...
static	getMaxFileSizeString ()
	Gets the maximum upload file size allowed as string (like '14.2 MB'). More...

Detailed Description

Definition at line 14 of file class.ilFileUploadUtil.php.

Member Function Documentation

getMaxFileSize()

static ilFileUploadUtil::getMaxFileSize ( )

static

Gets the maximum upload file size allowed in bytes.

Returns

int The maximum upload file size allowed in bytes.

Definition at line 74 of file class.ilFileUploadUtil.php.

Referenced by ilFileUploadGUI\getSharedHtml().

    {
        // get the value for the maximal uploadable filesize from the php.ini (if available)
        $umf = ini_get("upload_max_filesize");
        // get the value for the maximal post data from the php.ini (if available)
        $pms = ini_get("post_max_size");
        
        //convert from short-string representation to "real" bytes
        $multiplier_a = array("K" => 1024, "M" => 1024 * 1024, "G" => 1024 * 1024 * 1024);
        
        $umf_parts = preg_split("/(\d+)([K|G|M])/", $umf, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
        $pms_parts = preg_split("/(\d+)([K|G|M])/", $pms, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
        
        if (count($umf_parts) == 2) {
            $umf = $umf_parts[0] * $multiplier_a[$umf_parts[1]];
        }
        if (count($pms_parts) == 2) {
            $pms = $pms_parts[0] * $multiplier_a[$pms_parts[1]];
        }
        
        // use the smaller one as limit
        $max_filesize = min($umf, $pms);
        
        if (!$max_filesize) {
            $max_filesize = max($umf, $pms);
        }
        
        return $max_filesize;
    }

Here is the caller graph for this function:

getMaxFileSizeString()

static ilFileUploadUtil::getMaxFileSizeString ( )

static

Gets the maximum upload file size allowed as string (like '14.2 MB').

Returns

string The maximum upload file size allowed as string.

Definition at line 109 of file class.ilFileUploadUtil.php.

    {
        $max_filesize = self::getMaxFileSize();
        
        // format for display in mega-bytes
        return sprintf("%.1f MB", $max_filesize / 1024 / 1024);
    }

isUploadAllowed()

static ilFileUploadUtil::isUploadAllowed (   $a_ref_id,   $a_type = ""  )

static

Determines whether files can be uploaded to the object with the specified reference id.

Parameters

int	$a_ref_id	The reference id to check.
string	$a_type	The type of the object to check.

Returns

bool true, if file upload is allowed; otherwise, false.

Definition at line 23 of file class.ilFileUploadUtil.php.

References $a_type, $DIC, ilObject\_lookupType(), ilFileUploadSettings\isDragAndDropUploadEnabled(), and ilFileUploadSettings\isRepositoryDragAndDropUploadEnabled().

Referenced by ilObjectListGUI\isFileUploadAllowed(), and ilObjectGUI\prepareOutput().

    {
        global $DIC;
        $objDefinition = $DIC['objDefinition'];
        $ilAccess = $DIC['ilAccess'];
        
        if (self::isUploadSupported()) {
            include_once("./Services/FileUpload/classes/class.ilFileUploadSettings.php");
            
            // repository upload enabled?
            if (ilFileUploadSettings::isDragAndDropUploadEnabled() &&
                ilFileUploadSettings::isRepositoryDragAndDropUploadEnabled()) {
                if ($a_type == "") {
                    $a_type = ilObject::_lookupType($a_ref_id, true);
                }
                
                if ($objDefinition->isContainer($a_type)) {
                    return $ilAccess->checkAccess("create_file", "", $a_ref_id, "file");
                }
            }
        }
        
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isUploadSupported()

static ilFileUploadUtil::isUploadSupported ( )

static

Determines whether file upload is supported at the current location.

Returns

bool true, if file upload is supported; otherwise, false.

Definition at line 53 of file class.ilFileUploadUtil.php.

References $_GET, $DIC, and $ilCtrl.

Referenced by ilFileUploadGUI\getUploadUrl().

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        
        // right now, only the repository is supported
        if (strtolower($_GET["baseClass"]) == "ilrepositorygui") {
            $cmd = $ilCtrl->getCmd();
            if ($cmd == "" || $cmd == "view" || $cmd == "render") {
                return true;
            }
        }
            
        return false;
    }

Here is the caller graph for this function:

---

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

• Services/FileUpload/classes/class.ilFileUploadUtil.php