ilFileDataForum Class Reference

Inheritance diagram for ilFileDataForum:

Collaboration diagram for ilFileDataForum:

Public Member Functions
	__construct (private readonly int $obj_id=0, private readonly 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 ()
	importPath (string $path_to_file, int $posting_id)
	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 ()

Private Member Functions
	getCurrentPosting ()

Private Attributes
array	$posting_cache = []
readonly ilFileDataForumRCImplementation	$rc_implementation

Detailed Description

Definition at line 21 of file class.ilFileDataForum.php.

Constructor & Destructor Documentation

__construct()

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

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

      {
        $this->rc_implementation = new ilFileDataForumRCImplementation(
            $this->obj_id,
            $this->pos_id
        );
    }

Member Function Documentation

delete()

ilFileDataForum::delete

(

?array

$posting_ids_to_delete = null

)

Parameters

list<int>|null

$posting_ids_to_delete

Implements ilFileDataForumInterface.

Definition at line 82 of file class.ilFileDataForum.php.

                                                                : bool
    {
        return $this->rc_implementation->delete($posting_ids_to_delete);
    }

deliverFile()

ilFileDataForum::deliverFile

(

string

$file

)

Implements ilFileDataForumInterface.

Definition at line 113 of file class.ilFileDataForum.php.

                                             : void
    {
        $this->rc_implementation->deliverFile($file);
    }

deliverZipFile()

ilFileDataForum::deliverZipFile

(

)

Implements ilFileDataForumInterface.

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

                                    : bool
    {
        return $this->rc_implementation->deliverZipFile();
    }

getCurrentPosting()

ilFileDataForum::getCurrentPosting ( )

private

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

                                        : ilForumPost
    {
        return $this->posting_cache[$this->pos_id] ?? ($this->posting_cache[$this->pos_id] = new ilForumPost(
            $this->pos_id
        ));
    }

Referenced by importPath().

Here is the caller graph for this function:

getFileDataByMD5Filename()

ilFileDataForum::getFileDataByMD5Filename

(

string

$hashed_filename

)

Returns

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

Implements ilFileDataForumInterface.

Definition at line 100 of file class.ilFileDataForum.php.

                                                                     : ?array
    {
        return $this->rc_implementation->getFileDataByMD5Filename($hashed_filename);
    }

getFilesOfPost()

ilFileDataForum::getFilesOfPost

(

)

Returns

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

Implements ilFileDataForumInterface.

Definition at line 67 of file class.ilFileDataForum.php.

                                    : array
    {
        return $this->rc_implementation->getFilesOfPost();
    }

getForumPath()

ilFileDataForum::getForumPath

(

)

Implements ilFileDataForumInterface.

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

                                  : string
    {
        return $this->rc_implementation->getForumPath();
    }

getObjId()

ilFileDataForum::getObjId

(

)

Implements ilFileDataForumInterface.

Definition at line 44 of file class.ilFileDataForum.php.

                              : int
    {
        return $this->rc_implementation->getObjId();
    }

getPosId()

ilFileDataForum::getPosId

(

)

Implements ilFileDataForumInterface.

Definition at line 49 of file class.ilFileDataForum.php.

                              : int
    {
        return $this->rc_implementation->getPosId();
    }

ilClone()

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

Implements ilFileDataForumInterface.

Definition at line 77 of file class.ilFileDataForum.php.

                                                                 : bool
    {
        return $this->rc_implementation->ilClone($new_obj_id, $new_posting_id);
    }

importPath()

ilFileDataForum::importPath	(	string	$path_to_file,
		int	$posting_id
	)

Definition at line 123 of file class.ilFileDataForum.php.

                                                                     : void
    {
        // Importing is only possible for IRSS based files
        $this->setPosId($posting_id);
        $this->rc_implementation->importFileToCollection($path_to_file, $this->getCurrentPosting());
    }

References getCurrentPosting(), and setPosId().

Here is the call graph for this function:

moveFilesOfPost()

ilFileDataForum::moveFilesOfPost

(

int

$new_frm_id = 0

)

Implements ilFileDataForumInterface.

Definition at line 72 of file class.ilFileDataForum.php.

                                                        : bool
    {
        return $this->rc_implementation->moveFilesOfPost($new_frm_id);
    }

setPosId()

ilFileDataForum::setPosId

(

int

$posting_id

)

Implements ilFileDataForumInterface.

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

                                             : void
    {
        $this->rc_implementation->setPosId($posting_id);
    }

Referenced by importPath().

Here is the caller graph for this function:

storeUploadedFiles()

ilFileDataForum::storeUploadedFiles

(

)

Implements ilFileDataForumInterface.

Definition at line 87 of file class.ilFileDataForum.php.

                                        : bool
    {
        return $this->rc_implementation->storeUploadedFiles();
    }

unlinkFile()

ilFileDataForum::unlinkFile

(

string

$filename

)

Implements ilFileDataForumInterface.

Definition at line 92 of file class.ilFileDataForum.php.

                                                : bool
    {
        return $this->rc_implementation->unlinkFile($filename);
    }

References $filename.

unlinkFilesByMD5Filenames()

ilFileDataForum::unlinkFilesByMD5Filenames

(

$hashed_filename_or_filenames

)

Parameters

string | string[]

$hashed_filename_or_filenames

Implements ilFileDataForumInterface.

Definition at line 108 of file class.ilFileDataForum.php.

                                                                            : bool
    {
        return $this->rc_implementation->unlinkFilesByMD5Filenames($hashed_filename_or_filenames);
    }

Field Documentation

$posting_cache

array ilFileDataForum::$posting_cache = []

private

Definition at line 24 of file class.ilFileDataForum.php.

$rc_implementation

readonly ilFileDataForumRCImplementation ilFileDataForum::$rc_implementation

private

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

---

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

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