ILIAS\Filesystem\DTO\Metadata Class Reference

This class holds all default metadata send by the filesystem adapters. More...

Collaboration diagram for ILIAS\Filesystem\DTO\Metadata:

Public Member Functions
	__construct (private string $path, string $type)
	Metadata constructor. More...
	getPath ()
	The path to the file or directory. More...
	getType ()
	The type of the subject which can be FILE or DIRECTORY. More...
	isDir ()
	The path is a directory. More...
	isFile ()
	The path is a file. More...

Private Attributes
string	$type

Detailed Description

This class holds all default metadata send by the filesystem adapters.

Metadata instances are immutable.

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Definition at line 31 of file Metadata.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\DTO\Metadata::__construct	(	private string	$path,
		string	$type
	)

Metadata constructor.

Creates a new instance of the Metadata.

Parameters

string	$path	The path to the parent of the file or directory.
string	$type	The file type which can be -> file or directory. Please note that only constants defined in the MetadataType interface are considered as valid.

Exceptions

Definition at line 50 of file Metadata.php.

References ILIAS\Filesystem\DTO\Metadata\$type, ILIAS\Filesystem\MetadataType\DIRECTORY, and ILIAS\Filesystem\MetadataType\FILE.

    {
        if ($type !== MetadataType::FILE && $type !== MetadataType::DIRECTORY) {
            throw new \InvalidArgumentException("The metadata type must be FILE or DIRECTORY but \"$type\" was given.");
        }
        $this->type = $type;
    }

Member Function Documentation

getPath()

ILIAS\Filesystem\DTO\Metadata::getPath

(

)

The path to the file or directory.

Definition at line 62 of file Metadata.php.

References $path.

Referenced by ILIAS\Filesystem\Finder\Iterator\SortableIterator\__construct(), ILIAS\Filesystem\Finder\Iterator\RecursiveDirectoryIterator\rewind(), ilFileSystemCleanTempDirCron\run(), and FinderTest\testSortingWorksAsExpected().

                             : string
    {
        return $this->path;
    }

Here is the caller graph for this function:

getType()

ILIAS\Filesystem\DTO\Metadata::getType

(

)

The type of the subject which can be FILE or DIRECTORY.

Use isDir or isFile in consumer-code and do not compare yourself against MetadataType::DIRECTORY or MetadataType::FILE

Definition at line 76 of file Metadata.php.

References ILIAS\Filesystem\DTO\Metadata\$type.

Referenced by ILIAS\Filesystem\DTO\Metadata\isDir(), and ILIAS\Filesystem\DTO\Metadata\isFile().

                             : string
    {
        return $this->type;
    }

Here is the caller graph for this function:

isDir()

ILIAS\Filesystem\DTO\Metadata::isDir

(

)

The path is a directory.

Definition at line 85 of file Metadata.php.

References ILIAS\Filesystem\MetadataType\DIRECTORY, and ILIAS\Filesystem\DTO\Metadata\getType().

Referenced by ILIAS\Filesystem\Finder\Iterator\SortableIterator\__construct().

                           : bool
    {
        return (strcmp($this->getType(), MetadataType::DIRECTORY) === 0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFile()

ILIAS\Filesystem\DTO\Metadata::isFile

(

)

The path is a file.

Definition at line 94 of file Metadata.php.

References ILIAS\Filesystem\MetadataType\FILE, and ILIAS\Filesystem\DTO\Metadata\getType().

Referenced by ILIAS\Filesystem\Finder\Iterator\SortableIterator\__construct().

                            : bool
    {
        return (strcmp($this->getType(), MetadataType::FILE) === 0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$type

string ILIAS\Filesystem\DTO\Metadata::$type

private

Definition at line 33 of file Metadata.php.

Referenced by ILIAS\Filesystem\DTO\Metadata\__construct(), and ILIAS\Filesystem\DTO\Metadata\getType().

---

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

• components/ILIAS/Filesystem/src/DTO/Metadata.php