ilFileDataForumRCImplementation Class Reference

Inheritance diagram for ilFileDataForumRCImplementation:

Collaboration diagram for ilFileDataForumRCImplementation:

Public Member Functions
	__construct (private readonly int $obj_id=0, private int $pos_id=0)
	getObjId ()
	getPosId ()
	setPosId (int $posting_id)
	getForumPath ()
	getFilesOfPost ()
	moveFilesOfPost (int $new_frm_id=0)
	ilClone (int $new_obj_id, int $new_posting_id)
	delete (?array $posting_ids_to_delete=null)
	storeUploadedFiles ()
	unlinkFile (string $filename)
	getFileDataByMD5Filename (string $hashed_filename)
	unlinkFilesByMD5Filenames ($hashed_filename_or_filenames)
	deliverFile (string $file)
	deliverZipFile ()
	importFileToCollection (string $path_to_file, ilForumPost $post)

Data Fields
const	FORUM_PATH_RCID = 'RCID'

Private Member Functions
	getCurrentPosting (bool $use_cache=true)
	getPostingById (int $posting_id, bool $use_cache=true)
	getCurrentCollection ()
	getResourceIdByHash (string $hash)

Private Attributes
readonly ILIAS ResourceStorage Services	$irss
readonly ILIAS FileUpload FileUpload	$upload
array	$collection_cache = []
array	$posting_cache = []
readonly ilForumPostingFileStakeholder	$stakeholder

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilFileDataForumRCImplementation::__construct	(	private readonly int	$obj_id = 0,
		private int	$pos_id = 0
	)

Definition at line 37 of file class.ilFileDataForumRCImplementation.php.

References $DIC, and ILIAS\Repository\upload().

    {
        global $DIC;
        $this->irss = $DIC->resourceStorage();
        $this->upload = $DIC->upload();
        $this->stakeholder = new ilForumPostingFileStakeholder();
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilFileDataForumRCImplementation::delete

(

?array

$posting_ids_to_delete = null

)

Parameters

list<int>|null

$posting_ids_to_delete

Implements ilFileDataForumInterface.

Definition at line 139 of file class.ilFileDataForumRCImplementation.php.

References $stakeholder, getPostingById(), and null.

                                                                : bool
    {
        if ($posting_ids_to_delete === null) {
            return true;
        }

        foreach ($posting_ids_to_delete as $post_id) {
            $this->irss->collection()->remove(
                $this->irss->collection()->id(
                    $this->getPostingById($post_id)->getRCID()
                ),
                $this->stakeholder,
                true
            );
        }

        return true;
    }

Here is the call graph for this function:

deliverFile()

ilFileDataForumRCImplementation::deliverFile

(

string

$file

)

Implements ilFileDataForumInterface.

Definition at line 235 of file class.ilFileDataForumRCImplementation.php.

References getResourceIdByHash(), and null.

                                             : void
    {
        $rid = $this->getResourceIdByHash($file);
        if ($rid !== null) {
            $this->irss->consume()->download($rid)->run();
        }
    }

Here is the call graph for this function:

deliverZipFile()

ilFileDataForumRCImplementation::deliverZipFile

(

)

Implements ilFileDataForumInterface.

Definition at line 243 of file class.ilFileDataForumRCImplementation.php.

References getCurrentCollection(), getCurrentPosting(), and ILIAS\FileDelivery\Delivery\returnASCIIFileName().

                                    : bool
    {
        // https://mantis.ilias.de/view.php?id=39910
        $zip_filename = \ILIAS\FileDelivery\Delivery::returnASCIIFileName(
            $this->getCurrentPosting()->getSubject() . '.zip'
        );
        $rcid = $this->getCurrentCollection()->getIdentification();

        $this->irss
            ->consume()
            ->downloadCollection($rcid, $zip_filename)
            ->useRevisionTitlesForFileNames(false)
            ->run();

        return true;
    }

Here is the call graph for this function:

getCurrentCollection()

ilFileDataForumRCImplementation::getCurrentCollection ( )

private

Definition at line 59 of file class.ilFileDataForumRCImplementation.php.

References getCurrentPosting().

Referenced by deliverZipFile(), getFileDataByMD5Filename(), getFilesOfPost(), getResourceIdByHash(), ilClone(), storeUploadedFiles(), and unlinkFile().

                                           : ResourceCollection
    {
        return $this->collection_cache[$this->pos_id] ?? ($this->collection_cache[$this->pos_id] = $this->irss->collection(
        )->get(
            $this->irss->collection()->id(
                $this->getCurrentPosting()->getRCID()
            )
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentPosting()

ilFileDataForumRCImplementation::getCurrentPosting ( bool  $use_cache = true )

private

Definition at line 45 of file class.ilFileDataForumRCImplementation.php.

References getPostingById().

Referenced by deliverZipFile(), getCurrentCollection(), and storeUploadedFiles().

                                                              : ilForumPost
    {
        return $this->getPostingById($this->pos_id, $use_cache);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFileDataByMD5Filename()

ilFileDataForumRCImplementation::getFileDataByMD5Filename

(

string

$hashed_filename

)

Returns

array{path: string, filename: string, clean_filename: string}|null

Implements ilFileDataForumInterface.

Definition at line 199 of file class.ilFileDataForumRCImplementation.php.

References getCurrentCollection(), and null.

                                                                     : ?array
    {
        foreach ($this->getCurrentCollection()->getResourceIdentifications() as $identification) {
            $revision = $this->irss->manage()->getCurrentRevision($identification);
            if ($revision->getTitle() === $hashed_filename) {
                $info = $revision->getInformation();
                return [
                    'path' => '',
                    'filename' => $info->getTitle(),
                    'clean_filename' => $info->getTitle()
                ];
            }
        }

        return null;
    }

Here is the call graph for this function:

getFilesOfPost()

ilFileDataForumRCImplementation::getFilesOfPost

(

)

Returns

array<string, array{path: string, md5: string, name: string, size: int, ctime: string}>

Implements ilFileDataForumInterface.

Definition at line 104 of file class.ilFileDataForumRCImplementation.php.

References getCurrentCollection().

                                    : array
    {
        $files = [];
        foreach ($this->getCurrentCollection()->getResourceIdentifications() as $identification) {
            $revision = $this->irss->manage()->getCurrentRevision($identification);
            $info = $revision->getInformation();
            $files[$info->getTitle()] = [
                'path' => $this->irss->consume()->stream($identification)->getStream()->getMetadata('uri'),
                'md5' => $revision->getTitle(),
                'name' => $info->getTitle(),
                'size' => $info->getSize(),
                'ctime' => $info->getCreationDate()->format('Y-m-d H:i:s')
            ];
        }

        return $files;
    }

Here is the call graph for this function:

getForumPath()

ilFileDataForumRCImplementation::getForumPath

(

)

Implements ilFileDataForumInterface.

Definition at line 96 of file class.ilFileDataForumRCImplementation.php.

                                  : string
    {
        return self::FORUM_PATH_RCID;
    }

getObjId()

ilFileDataForumRCImplementation::getObjId

(

)

Implements ilFileDataForumInterface.

Definition at line 81 of file class.ilFileDataForumRCImplementation.php.

                              : int
    {
        return $this->obj_id;
    }

getPosId()

ilFileDataForumRCImplementation::getPosId

(

)

Implements ilFileDataForumInterface.

Definition at line 86 of file class.ilFileDataForumRCImplementation.php.

                              : int
    {
        return $this->pos_id;
    }

getPostingById()

ilFileDataForumRCImplementation::getPostingById ( int  $posting_id, bool  $use_cache = true  )

private

Definition at line 50 of file class.ilFileDataForumRCImplementation.php.

Referenced by delete(), getCurrentPosting(), and ilClone().

                                                                            : ilForumPost
    {
        if ($use_cache && isset($this->posting_cache[$posting_id])) {
            return $this->posting_cache[$posting_id];
        }

        return $this->posting_cache[$posting_id] = new ilForumPost($posting_id);
    }

Here is the caller graph for this function:

getResourceIdByHash()

ilFileDataForumRCImplementation::getResourceIdByHash ( string  $hash )

private

Definition at line 69 of file class.ilFileDataForumRCImplementation.php.

References getCurrentCollection(), and null.

Referenced by deliverFile(), and unlinkFilesByMD5Filenames().

                                                      : ?ResourceIdentification
    {
        foreach ($this->getCurrentCollection()->getResourceIdentifications() as $identification) {
            $revision = $this->irss->manage()->getCurrentRevision($identification);
            if ($revision->getTitle() === $hash) {
                return $identification;
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilClone()

ilFileDataForumRCImplementation::ilClone	(	int	$new_obj_id,
		int	$new_posting_id
	)

Implements ilFileDataForumInterface.

Definition at line 128 of file class.ilFileDataForumRCImplementation.php.

References getCurrentCollection(), and getPostingById().

                                                                 : bool
    {
        $current_collection_id = $this->getCurrentCollection()->getIdentification();
        $new_collection_id = $this->irss->collection()->clone($current_collection_id);
        $new_posting = $this->getPostingById($new_posting_id);
        $new_posting->setRCID($new_collection_id->serialize());
        $new_posting->update();

        return true;
    }

Here is the call graph for this function:

importFileToCollection()

ilFileDataForumRCImplementation::importFileToCollection	(	string	$path_to_file,
		ilForumPost	$post
	)

Definition at line 260 of file class.ilFileDataForumRCImplementation.php.

References ilForumPost\getRCID(), ilForumPost\NO_RCID, ilForumPost\setRCID(), and ilForumPost\update().

                                                                                   : void
    {
        if ($post->getRCID() === ilForumPost::NO_RCID || empty($post->getRCID())) {
            $rcid = $this->irss->collection()->id();
            $post->setRCID($rcid->serialize());
            $post->update();
        } else {
            $rcid = $this->irss->collection()->id($post->getRCID());
        }

        $collection = $this->irss->collection()->get($rcid);
        $rid = $this->irss->manage()->stream(
            Streams::ofResource(fopen($path_to_file, 'rb')),
            $this->stakeholder,
            md5(basename($path_to_file))
        );
        $collection->add($rid);
        $this->irss->collection()->store($collection);
    }

Here is the call graph for this function:

moveFilesOfPost()

ilFileDataForumRCImplementation::moveFilesOfPost

(

int

$new_frm_id = 0

)

Implements ilFileDataForumInterface.

Definition at line 122 of file class.ilFileDataForumRCImplementation.php.

                                                        : bool
    {
        // nothing to do here since collections are related to the post
        return true;
    }

setPosId()

ilFileDataForumRCImplementation::setPosId

(

int

$posting_id

)

Implements ilFileDataForumInterface.

Definition at line 91 of file class.ilFileDataForumRCImplementation.php.

                                             : void
    {
        $this->pos_id = $posting_id;
    }

storeUploadedFiles()

ilFileDataForumRCImplementation::storeUploadedFiles

(

)

Implements ilFileDataForumInterface.

Definition at line 158 of file class.ilFileDataForumRCImplementation.php.

References getCurrentCollection(), getCurrentPosting(), and ILIAS\Repository\upload().

                                        : bool
    {
        if (!$this->upload->hasBeenProcessed()) {
            $this->upload->process();
        }
        $collection = $this->getCurrentCollection();

        foreach ($this->upload->getResults() as $result) {
            if (!$result->isOK()) {
                continue;
            }
            $rid = $this->irss->manage()->upload(
                $result,
                $this->stakeholder,
                md5($result->getName())
            );
            $collection->add($rid);
        }
        $this->irss->collection()->store($collection);
        $posting = $this->getCurrentPosting(false);
        $posting->setRCID($collection->getIdentification()->serialize());
        $posting->update();

        return true;
    }

Here is the call graph for this function:

unlinkFile()

ilFileDataForumRCImplementation::unlinkFile

(

string

$filename

)

Implements ilFileDataForumInterface.

Definition at line 184 of file class.ilFileDataForumRCImplementation.php.

References getCurrentCollection().

                                                : bool
    {
        foreach ($this->getCurrentCollection()->getResourceIdentifications() as $identification) {
            $revision = $this->irss->manage()->getCurrentRevision($identification);
            if ($revision->getTitle() === md5($filename)) {
                $this->irss->manage()->remove($identification, $this->stakeholder);
            }
        }

        return true;
    }

Here is the call graph for this function:

unlinkFilesByMD5Filenames()

ilFileDataForumRCImplementation::unlinkFilesByMD5Filenames

(

$hashed_filename_or_filenames

)

Parameters

string|string[]

$hashed_filename_or_filenames

Implements ilFileDataForumInterface.

Definition at line 219 of file class.ilFileDataForumRCImplementation.php.

References getResourceIdByHash(), and null.

                                                                            : bool
    {
        $hashes = is_array($hashed_filename_or_filenames)
            ? $hashed_filename_or_filenames
            : [$hashed_filename_or_filenames];

        foreach ($hashes as $hash) {
            $identification = $this->getResourceIdByHash($hash);
            if ($identification !== null) {
                $this->irss->manage()->remove($identification, $this->stakeholder);
            }
        }

        return true;
    }

Here is the call graph for this function:

Field Documentation

$collection_cache

array ilFileDataForumRCImplementation::$collection_cache = []

private

Definition at line 32 of file class.ilFileDataForumRCImplementation.php.

$irss

readonly ILIAS ResourceStorage Services ilFileDataForumRCImplementation::$irss

private

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

$posting_cache

array ilFileDataForumRCImplementation::$posting_cache = []

private

Definition at line 34 of file class.ilFileDataForumRCImplementation.php.

$stakeholder

readonly ilForumPostingFileStakeholder ilFileDataForumRCImplementation::$stakeholder

private

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

Referenced by delete().

$upload

readonly ILIAS FileUpload FileUpload ilFileDataForumRCImplementation::$upload

private

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

FORUM_PATH_RCID

const ilFileDataForumRCImplementation::FORUM_PATH_RCID = 'RCID'

Definition at line 27 of file class.ilFileDataForumRCImplementation.php.

---

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

• components/ILIAS/Forum/classes/Files/class.ilFileDataForumRCImplementation.php