ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
Functions | Variables
trait.ilObjFileMetadata.php File Reference

Go to the source code of this file.

Functions

 updateFileData ()
 
 createProperties (bool $a_upload=false)
 The basic properties of a file object are stored in table object_data. More...
 
 setNoMetaDataCreation (bool $a_status)
 
 beforeCreateMetaData ()
 
 beforeUpdateMetaData ()
 
 doCreateMetaData ()
 create file object meta data More...
 
 beforeMDUpdateListener (string $a_element)
 
 doMDUpdateListener (string $a_element)
 
 doUpdateMetaData ()
 update meta data More...
 
 updateCopyright ()
 update copyright meta data More...
 

Variables

trait ilObjFileMetadata
 This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...
 

Function Documentation

◆ beforeCreateMetaData()

beforeCreateMetaData ( )
protected

Definition at line 88 of file trait.ilObjFileMetadata.php.

88  : bool
89  {
90  return !(bool) $this->no_meta_data_creation;
91  }

◆ beforeMDUpdateListener()

beforeMDUpdateListener ( string  $a_element)
protected

Definition at line 114 of file trait.ilObjFileMetadata.php.

References ILIAS\Survey\Mode\getId().

114  : bool
115  {
116  // Check file extension
117  // Removing the file extension is not allowed
118  $md = new ilMD($this->getId(), 0, $this->getType());
119  if (!is_object($md_gen = $md->getGeneral())) {
120  return false;
121  }
122  $title = $this->appendSuffixToTitle($md_gen->getTitle(), $this->getFileName());
123  $md_gen->setTitle($title);
124  $md_gen->update();
125 
126  return true;
127  }
+ Here is the call graph for this function:

◆ beforeUpdateMetaData()

beforeUpdateMetaData ( )
protected

Definition at line 93 of file trait.ilObjFileMetadata.php.

93  : bool
94  {
95  return !(bool) $this->no_meta_data_creation;
96  }

◆ createProperties()

createProperties ( bool  $a_upload = false)

The basic properties of a file object are stored in table object_data.

This is not sufficient for a file object. Therefore we create additional properties in table file_data. This method has been put into a separate operation, to allow a WebDAV Null resource (class.ilObjNull.php) to become a file object.

Definition at line 54 of file trait.ilObjFileMetadata.php.

References $DIC, ilNewsItem\_getDefaultVisibilityForRefId(), ilBlockSetting\_write(), ILIAS\Survey\Mode\getId(), ILIAS\Repository\int(), and updateFileData().

Referenced by ilObjFile\doCreate().

54  : void
55  {
56  global $DIC;
57 
58  // New Item
59  if (isset($this->ref_id)) {
60  $default_visibility = ilNewsItem::_getDefaultVisibilityForRefId($this->ref_id);
61  if ($default_visibility === "public") {
62  ilBlockSetting::_write("news", "public_notifications", 1, 0, $this->getId());
63  }
64  }
65  $this->updateFileData();
66 
67  //add metadata to database
68  $metadata = [
69  'meta_lifecycle_id' => ['integer', $DIC->database()->nextId('il_meta_lifecycle')],
70  'rbac_id' => ['integer', $this->getId()],
71  'obj_id' => ['integer', $this->getId()],
72  'obj_type' => ['text', "file"],
73  'meta_version' => ['integer', (int) $this->getVersion()],
74  ];
75  $DIC->database()->insert('il_meta_lifecycle', $metadata);
76 
77  // no meta data handling for file list files
78  if ($this->getMode() !== self::MODE_FILELIST) {
79  $this->createMetaData();
80  }
81  }
ilNewsItem\_getDefaultVisibilityForRefId
static _getDefaultVisibilityForRefId(int $a_ref_id)
Get default visibility for reference id.
Definition: class.ilNewsItem.php:1382
$DIC
global $DIC
Definition: feed.php:28
ilBlockSetting\_write
static _write(string $a_type, string $a_setting, string $a_value, int $a_user=0, int $a_block_id=0)
Write setting to database.
Definition: class.ilBlockSetting.php:118
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ doCreateMetaData()

doCreateMetaData ( )
protected

create file object meta data

Definition at line 101 of file trait.ilObjFileMetadata.php.

References $technical, and ILIAS\Survey\Mode\getId().

101  : void
102  {
103  return; // add technical section with file size and format
104  $md_obj = new ilMD($this->getId(), 0, $this->getType());
105  $technical = $md_obj->addTechnical();
106  $technical->setSize($this->getFileSize());
107  $technical->save();
108  $format = $technical->addFormat();
109  $format->setFormat($this->getFileType());
110  $format->save();
111  $technical->update();
112  }
$technical
$technical
Definition: LOMStructure.php:234
+ Here is the call graph for this function:

◆ doMDUpdateListener()

doMDUpdateListener ( string  $a_element)
protected

Definition at line 129 of file trait.ilObjFileMetadata.php.

References $id, and ILIAS\Survey\Mode\getId().

129  : void
130  {
131  // handling for technical section
132  switch ($a_element) {
133  case 'Technical':
134 
135  // Update Format (size is not stored in db)
136  $md = new ilMD($this->getId(), 0, $this->getType());
137  if (!is_object($md_technical = $md->getTechnical())) {
138  return;
139  }
140 
141  foreach ($md_technical->getFormatIds() as $id) {
142  $md_format = $md_technical->getFormat($id);
143  $this->setFileType($md_format->getFormat());
144  break;
145  }
146 
147  break;
148  }
149  }
$id
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
+ Here is the call graph for this function:

◆ doUpdateMetaData()

doUpdateMetaData ( )
protected

update meta data

Definition at line 154 of file trait.ilObjFileMetadata.php.

References $DIC, $technical, ILIAS\Survey\Mode\getId(), and ILIAS\Repository\int().

154  : void
155  {
156  global $DIC;
157  $md_obj = new ilMD($this->getId(), 0, $this->getType());
158  if (!is_object($technical = $md_obj->getTechnical())) {
159  $technical = $md_obj->addTechnical();
160  $technical->save();
161  }
162  $technical->setSize($this->getFileSize());
163 
164  $format_ids = $technical->getFormatIds();
165  if (count($format_ids) > 0) {
166  $format = $technical->getFormat($format_ids[0]);
167  $format->setFormat($this->getFileType());
168  $format->update();
169  } else {
170  $format = $technical->addFormat();
171  $format->setFormat($this->getFileType());
172  $format->save();
173  }
174  $technical->update();
175 
176  $meta_version_column = ['meta_version' => ['integer', (int) $this->getVersion()]];
177  $DIC->database()->update('il_meta_lifecycle', $meta_version_column, [
178  'rbac_id' => [
179  'integer',
180  $this->getId(),
181  ],
182  ]);
183  }
$technical
$technical
Definition: LOMStructure.php:234
$DIC
global $DIC
Definition: feed.php:28
+ Here is the call graph for this function:

◆ setNoMetaDataCreation()

setNoMetaDataCreation ( bool  $a_status)

Definition at line 83 of file trait.ilObjFileMetadata.php.

84  {
85  $this->no_meta_data_creation = $a_status;
86  }

◆ updateCopyright()

updateCopyright ( )
protected

update copyright meta data

Definition at line 188 of file trait.ilObjFileMetadata.php.

References $rights, ilMDSettings\_getInstance(), ILIAS\Survey\Mode\getId(), and IL_INST_ID.

Referenced by ilObjFile\beforeUpdate(), and ilObjFile\doCreate().

188  : void
189  {
190  $copyright_id = $this->getCopyrightID();
191  if (!ilMDSettings::_getInstance()->isCopyrightSelectionActive() || $copyright_id === null) {
192  return;
193  }
194 
195  $md_obj = new ilMD($this->getId(), 0, $this->getType());
196  $rights = $md_obj->getRights();
197  if ($rights === null) {
198  $rights = $md_obj->addRights();
199  $rights->save();
200  }
201 
202  $rights->setCopyrightAndOtherRestrictions("Yes");
203  $rights->setDescription('il_copyright_entry__' . IL_INST_ID . '__' . $copyright_id);
204  $rights->update();
205  }
IL_INST_ID
const IL_INST_ID
Definition: constants.php:40
$rights
$rights
Definition: LOMStructure.php:380
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ updateFileData()

updateFileData ( )
protected

Definition at line 28 of file trait.ilObjFileMetadata.php.

References $DIC, and ILIAS\Survey\Mode\getId().

Referenced by createProperties().

28  : void
29  {
30  global $DIC;
31  $check_existing = $DIC->database()->queryF(
32  'SELECT file_id FROM file_data WHERE file_id = %s',
33  ['integer'],
34  [$this->getId()]
35  );
36  if ($check_existing->numRows() === 0) {
37  $DIC->database()->insert('file_data', $this->getArrayForDatabase());
38  } else {
39  $DIC->database()->update(
40  'file_data',
41  $this->getArrayForDatabase(),
42  ['file_id' => ['integer', $this->getId()]]
43  );
44  }
45  }
$DIC
global $DIC
Definition: feed.php:28
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ ilObjFileMetadata

trait ilObjFileMetadata
Initial value:
{
protected ?bool $no_meta_data_creation = null

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Trait ilObjFileMetadata

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

Definition at line 25 of file trait.ilObjFileMetadata.php.