ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
Public Member Functions | Protected Attributes
ilObjFileImplementationStorage Class Reference

Class ilObjFileImplementationStorage. More...

+ Inheritance diagram for ilObjFileImplementationStorage:
+ Collaboration diagram for ilObjFileImplementationStorage:

Public Member Functions

 __construct (protected StorableResource $resource)
 ilObjFileImplementationStorage constructor. More...
 
 handleChangedObjectTitle (string $new_title)
 
 getFile (?int $a_hist_entry_id=null)
 
 getFileName ()
 
 getFileSize ()
 
 getFileType ()
 
 getDirectory (int $a_version=0)
 
 sendFile (?int $a_hist_entry_id=null, bool $inline=true)
 
 deleteVersions (?array $a_hist_entry_ids=null)
 Deletes the specified history entries or all entries if no ids are specified. More...
 
 getFileExtension ()
 Returns the extension of the file name converted to lower-case. More...
 
 getVersions (?array $version_ids=null)
 
 getStorageID ()
 
 getVersion (bool $inclduing_drafts=false)
 
 getMaxVersion ()
 

Protected Attributes

Services $storage
 

Detailed Description

Class ilObjFileImplementationStorage.

Author
Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 28 of file class.ilObjFileImplementationStorage.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileImplementationStorage::__construct ( protected StorableResource  $resource)

ilObjFileImplementationStorage constructor.

Definition at line 35 of file class.ilObjFileImplementationStorage.php.

References $DIC, and ILIAS\LTI\ToolProvider\$settings.

36  {
37  global $DIC;
38  $settings = new General();
39  $this->storage = $DIC->resourceStorage();
40  }
ILIAS\LTI\ToolProvider\$settings
array $settings
Setting values (LTI parameters, custom parameters and local parameters).
Definition: System.php:200
$DIC
global $DIC
Definition: feed.php:28

Member Function Documentation

◆ deleteVersions()

ilObjFileImplementationStorage::deleteVersions ( ?array  $a_hist_entry_ids = null)

Deletes the specified history entries or all entries if no ids are specified.

Parameters
array | null$a_hist_entry_idsThe ids of the entries to delete or null to delete all entries
Deprecated:

Implements ilObjFileImplementationInterface.

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

References $id.

109  : void
110  {
111  if (is_array($a_hist_entry_ids)) {
112  foreach ($a_hist_entry_ids as $id) {
113  $this->storage->manage()->removeRevision($this->resource->getIdentification(), $id);
114  }
115  }
116  }
$id
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23

◆ getDirectory()

ilObjFileImplementationStorage::getDirectory ( int  $a_version = 0)
Deprecated:

Implements ilObjFileImplementationInterface.

Definition at line 79 of file class.ilObjFileImplementationStorage.php.

79  : string
80  {
81  $consumer = $this->storage->consume()->stream($this->resource->getIdentification());
82  if ($a_version !== 0) {
83  $consumer->setRevisionNumber($a_version);
84  }
85  $stream = $consumer->getStream();
86 
87  return dirname($stream->getMetadata('uri'));
88  }

◆ getFile()

ilObjFileImplementationStorage::getFile ( ?int  $a_hist_entry_id = null)

Implements ilObjFileImplementationInterface.

Definition at line 52 of file class.ilObjFileImplementationStorage.php.

52  : string
53  {
54  $stream = $this->storage->consume()->stream($this->resource->getIdentification());
55  if ($a_hist_entry_id) {
56  $stream = $stream->setRevisionNumber($a_hist_entry_id);
57  }
58  return $stream->getStream()->getMetadata('uri');
59  }

◆ getFileExtension()

ilObjFileImplementationStorage::getFileExtension ( )

Returns the extension of the file name converted to lower-case.

e.g. returns 'pdf' for 'document.pdf'.

Implements ilObjFileImplementationInterface.

Definition at line 118 of file class.ilObjFileImplementationStorage.php.

118  : string
119  {
120  return $this->resource->getCurrentRevision()->getInformation()->getSuffix();
121  }

◆ getFileName()

ilObjFileImplementationStorage::getFileName ( )

Implements ilObjFileImplementationInterface.

Definition at line 61 of file class.ilObjFileImplementationStorage.php.

61  : string
62  {
63  return $this->resource->getCurrentRevision()->getInformation()->getTitle();
64  }

◆ getFileSize()

ilObjFileImplementationStorage::getFileSize ( )

Implements ilObjFileImplementationInterface.

Definition at line 66 of file class.ilObjFileImplementationStorage.php.

66  : int
67  {
68  return $this->resource->getCurrentRevision()->getInformation()->getSize() ?: 0;
69  }

◆ getFileType()

ilObjFileImplementationStorage::getFileType ( )

Implements ilObjFileImplementationInterface.

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

74  : string
75  {
76  return $this->resource->getCurrentRevision()->getInformation()->getMimeType();
77  }

◆ getMaxVersion()

ilObjFileImplementationStorage::getMaxVersion ( )

Implements ilObjFileImplementationInterface.

Definition at line 183 of file class.ilObjFileImplementationStorage.php.

183  : int
184  {
185  return $this->resource->getMaxRevision(false);
186  }

◆ getStorageID()

ilObjFileImplementationStorage::getStorageID ( )

Implements ilObjFileImplementationInterface.

Definition at line 166 of file class.ilObjFileImplementationStorage.php.

166  : ?string
167  {
168  return $this->resource->getStorageID();
169  }

◆ getVersion()

ilObjFileImplementationStorage::getVersion ( bool  $inclduing_drafts = false)

Implements ilObjFileImplementationInterface.

Definition at line 171 of file class.ilObjFileImplementationStorage.php.

171  : int
172  {
173  try {
174  if ($inclduing_drafts) {
175  return $this->resource->getCurrentRevisionIncludingDraft()->getVersionNumber();
176  }
177  return $this->resource->getCurrentRevision()->getVersionNumber();
178  } catch (Throwable) {
179  return 0;
180  }
181  }

◆ getVersions()

ilObjFileImplementationStorage::getVersions ( ?array  $version_ids = null)
Returns
[]

Implements ilObjFileImplementationInterface.

Definition at line 126 of file class.ilObjFileImplementationStorage.php.

References ILIAS\ResourceStorage\Revision\DRAFT.

126  : array
127  {
128  $versions = [];
129  $current_revision = $this->resource->getCurrentRevisionIncludingDraft();
130  foreach ($this->resource->getAllRevisionsIncludingDraft() as $revision) {
131  if (is_array($version_ids) && !in_array($revision->getVersionNumber(), $version_ids)) {
132  continue;
133  }
134  $information = $revision->getInformation();
135  $v = new ilObjFileVersion();
136  $v->setVersion($revision->getVersionNumber());
137  $v->setHistEntryId($revision->getVersionNumber());
138  $v->setFilename($information->getTitle());
139  if ($revision->getStatus() === RevisionStatus::DRAFT) {
140  $v->setAction('draft');
141  } else {
142  $version_number = $revision->getVersionNumber();
143  switch ($version_number) {
144  case 1:
145  $v->setAction('create');
146  break;
147  case $current_revision->getVersionNumber():
148  $v->setAction('published_version');
149  break;
150  default:
151  $v->setAction('intermediate_version');
152  break;
153  }
154  }
155  $v->setTitle($revision->getTitle());
156  $v->setDate($information->getCreationDate()->format(DATE_ATOM));
157  $v->setUserId($revision->getOwnerId() !== 0 ? $revision->getOwnerId() : 6);
158  $v->setSize($information->getSize());
159 
160  $versions[] = $v;
161  }
162 
163  return $versions;
164  }
ilObjFileVersion
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilObjFileVersion.php:23

◆ handleChangedObjectTitle()

ilObjFileImplementationStorage::handleChangedObjectTitle ( string  $new_title)

Implements ilObjFileImplementationInterface.

Definition at line 42 of file class.ilObjFileImplementationStorage.php.

42  : void
43  {
44  $current_revision = $this->resource->getCurrentRevision();
45  $current_revision->setTitle($new_title);
46  $this->storage->manage()->updateRevision($current_revision);
47  }

◆ sendFile()

ilObjFileImplementationStorage::sendFile ( ?int  $a_hist_entry_id = null,
bool  $inline = true 
)
Parameters
bool$inline
Deprecated:

Implements ilObjFileImplementationInterface.

Definition at line 90 of file class.ilObjFileImplementationStorage.php.

90  : void
91  {
92  if ($inline) {
93  $consumer = $this->storage->consume()->inline($this->resource->getIdentification());
94  } else {
95  $consumer = $this->storage->consume()->download($this->resource->getIdentification());
96  }
97 
98  if ($a_hist_entry_id) {
99  $revision = $this->resource->getSpecificRevision($a_hist_entry_id);
100  $consumer->setRevisionNumber($a_hist_entry_id);
101  } else {
102  $revision = $this->resource->getCurrentRevision();
103  }
104  $consumer->overrideFileName($revision->getTitle());
105 
106  $consumer->run();
107  }

Field Documentation

◆ $storage

Services ilObjFileImplementationStorage::$storage
protected

Definition at line 30 of file class.ilObjFileImplementationStorage.php.

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