ILIAS\Filesystem\Definitions\SuffixDefinitions Class Reference

Collaboration diagram for ILIAS\Filesystem\Definitions\SuffixDefinitions:

Public Member Functions
	__construct (array $white_list, protected array $black_list)
	getWhiteList ()
	getBlackList ()
	getValidFileName (string $filename)
	hasValidFileName (string $filename)

Data Fields
const	SEC = ".sec"

Protected Attributes
array	$white_list = []

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 26 of file SuffixDefinitions.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Definitions\SuffixDefinitions::__construct	(	array	$white_list,
		protected array	$black_list
	)

Parameters

mixed[]

$black_list

Definition at line 37 of file SuffixDefinitions.php.

    {
        $this->white_list[] = '';
        $this->white_list = array_unique($white_list);
    }

Member Function Documentation

getBlackList()

ILIAS\Filesystem\Definitions\SuffixDefinitions::getBlackList

(

)

Returns

mixed[]

Definition at line 54 of file SuffixDefinitions.php.

                                  : array
    {
        return $this->black_list;
    }

getValidFileName()

ILIAS\Filesystem\Definitions\SuffixDefinitions::getValidFileName

(

string

$filename

)

Deprecated:

Use ILIAS ResourceStorage to store files, there is no need to check valid filenames

Definition at line 62 of file SuffixDefinitions.php.

References $filename, and ILIAS\Filesystem\Definitions\SuffixDefinitions\hasValidFileName().

                                                      : string
    {
        if ($this->hasValidFileName($filename)) {
            return $filename;
        }
        $pi = pathinfo($filename);
        // if extension is not in white list, remove all "." and add ".sec" extension
        $basename = str_replace(".", "", $pi["basename"]);
        if (trim($basename) === "") {
            throw new \RuntimeException("Invalid upload filename.");
        }
        $basename .= self::SEC;
        if ($pi["dirname"] != "" && ($pi["dirname"] !== "." || str_starts_with($filename, "./"))) {
            return $pi["dirname"] . "/" . $basename;
        }
        return $basename;
    }

Here is the call graph for this function:

getWhiteList()

ILIAS\Filesystem\Definitions\SuffixDefinitions::getWhiteList

(

)

Returns

mixed[]

Definition at line 46 of file SuffixDefinitions.php.

References ILIAS\Filesystem\Definitions\SuffixDefinitions\$white_list.

                                  : array
    {
        return $this->white_list;
    }

hasValidFileName()

ILIAS\Filesystem\Definitions\SuffixDefinitions::hasValidFileName

(

string

$filename

)

Deprecated:

Use ILIAS ResourceStorage to store files, there is no need to check valid filenames

Definition at line 83 of file SuffixDefinitions.php.

Referenced by ILIAS\Filesystem\Definitions\SuffixDefinitions\getValidFileName().

                                                      : bool
    {
        $pi = pathinfo($filename);

        return in_array(strtolower($pi["extension"]), $this->white_list)
            && !in_array(strtolower($pi["extension"]), $this->black_list);
    }

Here is the caller graph for this function:

Field Documentation

$white_list

array ILIAS\Filesystem\Definitions\SuffixDefinitions::$white_list = []

protected

Definition at line 32 of file SuffixDefinitions.php.

Referenced by ILIAS\Filesystem\Definitions\SuffixDefinitions\getWhiteList().

SEC

const ILIAS\Filesystem\Definitions\SuffixDefinitions::SEC = ".sec"

Definition at line 31 of file SuffixDefinitions.php.

---

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

• components/ILIAS/Filesystem/src/Definitions/SuffixDefinitions.php