Collaboration diagram for ILIAS\Filesystem\DTO\Metadata:

Public Member Functions
	__construct ($path, $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
	$path

	$type

Detailed Description

Class Metadata.

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

Since: 5.3

Version: 1.0

Definition at line 17 of file Metadata.php.

Constructor & Destructor Documentation

◆ __construct()

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

Metadata constructor.

Creates a new instance of the Metadata.

Definition at line 45 of file Metadata.php.

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

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

Member Function Documentation

◆ getPath()

ILIAS\Filesystem\DTO\Metadata::getPath ( )

The path to the file or directory.

Returns: string

Since: 5.3

Definition at line 69 of file Metadata.php.

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

     {
         return $this->path;
     }

◆ 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

Returns: string

Since: 5.3

Definition at line 87 of file Metadata.php.

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

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

     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ isDir()

ILIAS\Filesystem\DTO\Metadata::isDir ( )

The path is a directory.

Returns: bool

Since: 5.3

Definition at line 99 of file Metadata.php.

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

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

Here is the call graph for this function:

◆ isFile()

ILIAS\Filesystem\DTO\Metadata::isFile ( )

The path is a file.

Returns: bool

Since: 5.3

Definition at line 111 of file Metadata.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $path

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

private

Definition at line 23 of file Metadata.php.

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

◆ $type

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