ILIAS  trunk Revision v11.0_alpha-1811-gd2d5443e411
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ilObjFileInfo Class Reference
+ Collaboration diagram for ilObjFileInfo:

Public Member Functions

 __construct (protected string $title, protected ?ResourceIdentification $rid, protected string $file_name, protected string $suffix, protected bool $deliver_inline, protected bool $download_directly, protected int $version, protected DateTimeImmutable $creation_date, protected bool $is_zip, protected string $mime_type, protected DataSize $file_size, protected ?int $page_count)
 
 getFileName ()
 
 getListTitle ()
 
 getHeaderTitle ()
 
 getSuffix ()
 
 getRID ()
 
 shouldDeliverInline ()
 
 shouldDownloadDirectly ()
 
 getVersion ()
 
 getCreationDate ()
 
 isZip ()
 
 getMimeType ()
 
 getFileSize ()
 
 getPageCount ()
 

Detailed Description

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

Definition at line 25 of file class.ilObjFileInfo.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileInfo::__construct ( protected string  $title,
protected ?ResourceIdentification  $rid,
protected string  $file_name,
protected string  $suffix,
protected bool  $deliver_inline,
protected bool  $download_directly,
protected int  $version,
protected DateTimeImmutable  $creation_date,
protected bool  $is_zip,
protected string  $mime_type,
protected DataSize  $file_size,
protected ?int  $page_count 
)

Definition at line 29 of file class.ilObjFileInfo.php.

30  {
31  }

Member Function Documentation

◆ getCreationDate()

ilObjFileInfo::getCreationDate ( )

Definition at line 73 of file class.ilObjFileInfo.php.

74  {
75  return $this->creation_date;
76  }

◆ getFileName()

ilObjFileInfo::getFileName ( )

Definition at line 33 of file class.ilObjFileInfo.php.

33  : string
34  {
35  return $this->file_name;
36  }

◆ getFileSize()

ilObjFileInfo::getFileSize ( )

Definition at line 88 of file class.ilObjFileInfo.php.

88  : DataSize
89  {
90  return $this->file_size;
91  }
This class provides the data size with additional information to remove the work to calculate the siz...
Definition: DataSize.php:30

◆ getHeaderTitle()

ilObjFileInfo::getHeaderTitle ( )

Definition at line 43 of file class.ilObjFileInfo.php.

References getSuffix(), and stripSuffix().

43  : string
44  {
45  return $this->stripSuffix($this->title, $this->getSuffix());
46  }
stripSuffix(string $title, ?string $suffix=null)
+ Here is the call graph for this function:

◆ getListTitle()

ilObjFileInfo::getListTitle ( )

Definition at line 38 of file class.ilObjFileInfo.php.

References getSuffix(), and stripSuffix().

38  : string
39  {
40  return $this->stripSuffix($this->title, $this->getSuffix());
41  }
stripSuffix(string $title, ?string $suffix=null)
+ Here is the call graph for this function:

◆ getMimeType()

ilObjFileInfo::getMimeType ( )

Definition at line 83 of file class.ilObjFileInfo.php.

83  : string
84  {
85  return $this->mime_type;
86  }

◆ getPageCount()

ilObjFileInfo::getPageCount ( )

Definition at line 93 of file class.ilObjFileInfo.php.

93  : ?int
94  {
95  return $this->page_count;
96  }

◆ getRID()

ilObjFileInfo::getRID ( )

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

54  {
55  return $this->rid;
56  }

◆ getSuffix()

ilObjFileInfo::getSuffix ( )

Definition at line 48 of file class.ilObjFileInfo.php.

Referenced by getHeaderTitle(), getListTitle(), ILIAS\File\Capabilities\Check\EditContent\maybeUnlock(), and ILIAS\File\Capabilities\Check\ViewContent\maybeUnlock().

48  : string
49  {
50  return $this->suffix;
51  }
+ Here is the caller graph for this function:

◆ getVersion()

ilObjFileInfo::getVersion ( )

Definition at line 68 of file class.ilObjFileInfo.php.

References $version.

68  : int
69  {
70  return $this->version;
71  }
$version
Definition: plugin.php:24

◆ isZip()

ilObjFileInfo::isZip ( )

Definition at line 78 of file class.ilObjFileInfo.php.

Referenced by ILIAS\File\Capabilities\Check\Unzip\maybeUnlock().

78  : bool
79  {
80  return $this->is_zip;
81  }
+ Here is the caller graph for this function:

◆ shouldDeliverInline()

ilObjFileInfo::shouldDeliverInline ( )

Definition at line 58 of file class.ilObjFileInfo.php.

58  : bool
59  {
60  return $this->deliver_inline;
61  }

◆ shouldDownloadDirectly()

ilObjFileInfo::shouldDownloadDirectly ( )

Definition at line 63 of file class.ilObjFileInfo.php.

Referenced by ILIAS\File\Capabilities\Check\ForcedInfo\maybeUnlock().

63  : bool
64  {
65  return $this->download_directly;
66  }
+ Here is the caller graph for this function:

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