Collaboration diagram for ilObjFileInfoRepository:

Public Member Functions
	__construct (bool $with_cleared_cache=false)

	getByRefId (int $ref_id)

	preloadData (array $ids, bool $are_ref_ids=false)

	getByObjectId (int $object_id)

Private Member Functions
	initInlineSuffixes ()

Private Attributes
readonly Services	$irss

readonly ilDBInterface	$db

array	$inline_suffixes = []

Static Private Attributes
static array	$cache = []

Detailed Description

Author

Fabian Schmid fabian@sr.solutions

    Use this class to get common information about a file object. if you need infos for multiple files, use the
    preloadData method to load all data at once.

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

Constructor & Destructor Documentation

◆ __construct()

ilObjFileInfoRepository::__construct ( bool $with_cleared_cache = false )

Definition at line 36 of file class.ilObjFileInfoRepository.php.

References $DIC, and initInlineSuffixes().

     {
         global $DIC;
         if ($with_cleared_cache) {
             self::$cache = [];
         }
         $this->irss = $DIC->resourceStorage();
         $this->db = $DIC->database();
         $this->inline_suffixes = $this->initInlineSuffixes();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getByObjectId()

ilObjFileInfoRepository::getByObjectId ( int $object_id )

Definition at line 125 of file class.ilObjFileInfoRepository.php.

References preloadData().

Referenced by getByRefId().

                                                  : ilObjFileInfo
     {
         if (isset(self::$cache[$object_id])) {
             return self::$cache[$object_id];
         }
 
         $this->preloadData([$object_id]);
 
         return self::$cache[$object_id] ?? new ilObjFileInfo(
             'Unknown',
             null,
             'Unknown',
             '',
             false,
             false,
             0,
             new DateTimeImmutable(),
             false,
             '',
             new DataSize(0, DataSize::Byte),
             null
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getByRefId()

ilObjFileInfoRepository::getByRefId ( int $ref_id )

Definition at line 47 of file class.ilObjFileInfoRepository.php.

References ilObject\_lookupObjectId(), and getByObjectId().

                                            : ilObjFileInfo
     {
         $object_id = ilObject2::_lookupObjectId($ref_id);
 
         return $this->getByObjectId($object_id);
     }

Here is the call graph for this function:

◆ initInlineSuffixes()

ilObjFileInfoRepository::initInlineSuffixes ( )

private

Definition at line 54 of file class.ilObjFileInfoRepository.php.

Referenced by __construct().

                                          : array
     {
         $settings = new ilSetting('file_access');
         return array_map('strtolower', explode(' ', (string) $settings->get('inline_file_extensions', '')));
     }

Here is the caller graph for this function:

◆ preloadData()

ilObjFileInfoRepository::preloadData	(	array	$ids,
		bool	$are_ref_ids = `false`
	)

Definition at line 60 of file class.ilObjFileInfoRepository.php.

References $id, $res, ilObjFile\CLICK_MODE_DOWNLOAD, and ILIAS\Repository\int().

Referenced by getByObjectId().

                                                                       : void
     {
         if ($are_ref_ids) {
             $query = "SELECT title, rid, file_id, page_count, on_click_mode
                 FROM file_data 
                     JOIN object_data ON object_data.obj_id = file_data.file_id 
                     JOIN object_reference ON object_reference.obj_id = object_data.obj_id  
                 WHERE rid IS NOT NULL AND " . $this->db->in(
                 'ref_id',
                 $ids,
                 false,
                 'integer'
             );
         } else {
             $query = "SELECT title, rid, file_id, page_count, on_click_mode  FROM file_data JOIN object_data ON object_data.obj_id = file_data.file_id WHERE rid IS NOT NULL AND " . $this->db->in(
                 'file_id',
                 $ids,
                 false,
                 'integer'
             );
         }
 
         $res = $this->db->query(
             $query
         );
         $rids = [];
         $page_counts = [];
         $object_titles = [];
         $click_modes = [];
 
         while ($row = $this->db->fetchObject($res)) {
             $rids[(int) $row->file_id] = $row->rid;
             $page_counts[(int) $row->file_id] = $row->page_count;
             $object_titles[(int) $row->file_id] = $row->title;
             $click_modes[(int) $row->file_id] = (int) ($row->on_click_mode ?? ilObjFile::CLICK_MODE_DOWNLOAD);
         }
         $this->irss->preload($rids);
 
         foreach ($rids as $file_id => $rid) {
             if (($id = $this->irss->manage()->find($rid)) !== null) {
                 $max = $this->irss->manage()->getResource($id)->getCurrentRevision();
 
                 $info = new ilObjFileInfo(
                     $object_titles[$file_id] ?? $max->getTitle(),
                     $id,
                     $max->getInformation()->getTitle(),
                     $max->getInformation()->getSuffix(),
                     in_array(strtolower($max->getInformation()->getSuffix()), $this->inline_suffixes, true),
                     $click_modes[$file_id] === ilObjFile::CLICK_MODE_DOWNLOAD,
                     $max->getVersionNumber(),
                     $max->getInformation()->getCreationDate(),
                     in_array(strtolower($max->getInformation()->getMimeType()), [
                         MimeType::APPLICATION__ZIP,
                         MimeType::APPLICATION__X_ZIP_COMPRESSED
                     ], true),
                     $max->getInformation()->getMimeType(),
                     new DataSize($max->getInformation()->getSize() ?? 0, DataSize::Byte),
                     $page_counts[$file_id] === null ? null : (int) $page_counts[$file_id]
                 );
 
                 self::$cache[$file_id] = $info;
             }
         }
     }