Inheritance diagram for ilFileDataForumLegacyImplementation:

Collaboration diagram for ilFileDataForumLegacyImplementation:

Public Member Functions
	__construct (private readonly int $obj_id=0, private int $pos_id=0)

	getObjId ()

	getPosId ()

	setPosId (int $posting_id)

	getForumPath ()

	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 ()

Public Member Functions inherited from ilFileData
	__construct ()

	checkPath (string $a_path)

	getPath ()

Public Member Functions inherited from ilFile
	deleteTrailingSlash (string $a_path)
	delete trailing slash of path variables More...

Public Member Functions inherited from ilFileDataForumInterface
	getFilesOfPost ()

	moveFilesOfPost (int $new_frm_id=0)

Private Member Functions
	checkForumPath ()

	checkReadWrite ()

	initDirectory ()

	createZipFile ()

Private Attributes
const	FORUM_PATH = 'forum'

string	$forum_path

ilErrorHandling	$error

ilGlobalTemplateInterface	$main_tpl

Additional Inherited Members
Protected Attributes inherited from ilFile
string	$path

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), checkForumPath(), ilFileData\getPath(), and initDirectory().

     {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
 
         $this->error = $DIC['ilErr'];
 
         parent::__construct();
         $this->forum_path = $this->getPath() . '/' . self::FORUM_PATH;
 
         if (!$this->checkForumPath()) {
             $this->initDirectory();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkForumPath()

ilFileDataForumLegacyImplementation::checkForumPath ( )

private

Definition at line 238 of file class.ilFileDataForumLegacyImplementation.php.

References checkReadWrite(), and getForumPath().

Referenced by __construct().

                                      : bool
     {
         if (!is_dir($this->getForumPath())) {
             return false;
         }
         $this->checkReadWrite();
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkReadWrite()

ilFileDataForumLegacyImplementation::checkReadWrite ( )

private

Definition at line 248 of file class.ilFileDataForumLegacyImplementation.php.

Referenced by checkForumPath().

                                      : void
     {
         if (!is_writable($this->forum_path) || !is_readable($this->forum_path)) {
             $this->error->raiseError('Forum directory is not readable/writable by webserver', $this->error->FATAL);
         }
     }

Here is the caller graph for this function:

◆ createZipFile()

ilFileDataForumLegacyImplementation::createZipFile ( )

private

Definition at line 294 of file class.ilFileDataForumLegacyImplementation.php.

References ilFileDataForumInterface\getFilesOfPost(), getForumPath(), getObjId(), getPosId(), ilFileUtils\makeDirParents(), and ilFileUtils\zip().

Referenced by deliverZipFile().

                                     : ?string
     {
         $filesOfPost = $this->getFilesOfPost();
         ksort($filesOfPost);
 
         ilFileUtils::makeDirParents($this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId());
         $tmp_dir = $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId();
         foreach ($filesOfPost as $file) {
             copy($file['path'], $tmp_dir . '/' . $file['name']);
         }
 
         $zip_file = null;
         if (ilFileUtils::zip(
             $tmp_dir,
             $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId() . '.zip'
         )) {
             $zip_file = $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId() . '.zip';
         }
 
         return $zip_file;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilFileDataForumLegacyImplementation::delete ( array $posting_ids_to_delete = null )

Parameters

list<int>|null $posting_ids_to_delete

Implements ilFileDataForumInterface.

Definition at line 165 of file class.ilFileDataForumLegacyImplementation.php.

References getForumPath(), and getObjId().

                                                                : bool
     {
         if ($posting_ids_to_delete === null) {
             return true;
         }
 
         foreach ($this->getFiles() as $file) {
             if (is_file($this->getForumPath() . '/' . $this->getObjId() . '_' . $file['name'])) {
                 unlink($this->getForumPath() . '/' . $this->getObjId() . '_' . $file['name']);
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ deliverFile()

ilFileDataForumLegacyImplementation::deliverFile ( string $file )

Implements ilFileDataForumInterface.

Definition at line 265 of file class.ilFileDataForumLegacyImplementation.php.

References $DIC, ilFile\$path, ilFileDelivery\deliverFileLegacy(), and getFileDataByMD5Filename().

                                              : void
     {
         global $DIC;
 
         if (($path = $this->getFileDataByMD5Filename($file)) !== null) {
             ilFileDelivery::deliverFileLegacy($path['path'], $path['clean_filename']);
         } else {
             $this->main_tpl->setOnScreenMessage('failure', $DIC->lanuage()->txt('error_reading_file'), true);
         }
     }

Here is the call graph for this function:

◆ deliverZipFile()

ilFileDataForumLegacyImplementation::deliverZipFile ( )

Implements ilFileDataForumInterface.

Definition at line 276 of file class.ilFileDataForumLegacyImplementation.php.

References $DIC, $post, createZipFile(), ilFileUtils\delDir(), ilFileDelivery\deliverFileLegacy(), getForumPath(), getObjId(), and getPosId().

                                     : bool
     {
         global $DIC;
 
         $zip_file = $this->createZipFile();
         if (!$zip_file) {
             $this->main_tpl->setOnScreenMessage('failure', $DIC->language()->txt('error_reading_file'), true);
             return false;
         }
 
         $post = new ilForumPost($this->getPosId());
         ilFileDelivery::deliverFileLegacy($zip_file, $post->getSubject() . '.zip', '', false, true, false);
         ilFileUtils::delDir($this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId());
         $DIC->http()->close();
 
         return true; // never
     }

Here is the call graph for this function:

◆ getFileDataByMD5Filename()

ilFileDataForumLegacyImplementation::getFileDataByMD5Filename ( string $hashed_filename )

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

Implements ilFileDataForumInterface.

Definition at line 197 of file class.ilFileDataForumLegacyImplementation.php.

References ilFileUtils\getDir().

Referenced by deliverFile().

                                                                      : ?array
     {
         $files = ilFileUtils::getDir($this->forum_path);
         foreach ($files as $file) {
             if ($file['type'] === 'file' && md5($file['entry']) === $hashed_filename) {
                 return [
                     'path' => $this->forum_path . '/' . $file['entry'],
                     'filename' => $file['entry'],
                     'clean_filename' => str_replace($this->obj_id . '_' . $this->pos_id . '_', '', $file['entry'])
                 ];
             }
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForumPath()

ilFileDataForumLegacyImplementation::getForumPath ( )

Implements ilFileDataForumInterface.

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

References $forum_path, ilFileDataForumInterface\getFilesOfPost(), getPosId(), ILIAS\Repository\int(), ilFileDataForumInterface\moveFilesOfPost(), and ilFileUtils\rename().

Referenced by checkForumPath(), createZipFile(), delete(), deliverZipFile(), and ilClone().

                                   : string
     {
         return $this->forum_path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilFileDataForumLegacyImplementation::getObjId ( )

Implements ilFileDataForumInterface.

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

Referenced by createZipFile(), delete(), and deliverZipFile().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getPosId()

ilFileDataForumLegacyImplementation::getPosId ( )

Implements ilFileDataForumInterface.

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

Referenced by createZipFile(), deliverZipFile(), and getForumPath().

                               : int
     {
         return $this->pos_id;
     }

Here is the caller graph for this function:

◆ ilClone()

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

Implements ilFileDataForumInterface.

Definition at line 153 of file class.ilFileDataForumLegacyImplementation.php.

References ilFileDataForumInterface\getFilesOfPost(), and getForumPath().

                                                                  : bool
     {
         foreach ($this->getFilesOfPost() as $file) {
             copy(
                 $this->getForumPath() . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $file['name'],
                 $this->getForumPath() . '/' . $new_obj_id . '_' . $new_posting_id . '_' . $file['name']
             );
         }
 
         return true;
     }

Here is the call graph for this function:

◆ initDirectory()

ilFileDataForumLegacyImplementation::initDirectory ( )

private

Definition at line 255 of file class.ilFileDataForumLegacyImplementation.php.

References ilFileData\getPath().

Referenced by __construct().

                                     : void
     {
         if (is_writable($this->getPath()) && mkdir($this->getPath() . '/' . self::FORUM_PATH) && chmod(
             $this->getPath() . '/' . self::FORUM_PATH,
             0755
         )) {
             $this->forum_path = $this->getPath() . '/' . self::FORUM_PATH;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPosId()

ilFileDataForumLegacyImplementation::setPosId ( int $posting_id )

Implements ilFileDataForumInterface.

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

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

◆ storeUploadedFiles()

ilFileDataForumLegacyImplementation::storeUploadedFiles ( )

Implements ilFileDataForumInterface.

Definition at line 180 of file class.ilFileDataForumLegacyImplementation.php.

                                         : bool
     {
         throw new DomainException('Not implemented');
     }

◆ unlinkFile()

ilFileDataForumLegacyImplementation::unlinkFile ( string $filename )

Implements ilFileDataForumInterface.

Definition at line 185 of file class.ilFileDataForumLegacyImplementation.php.

                                                 : bool
     {
         if (is_file($this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $filename)) {
             return unlink($this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $filename);
         }
 
         return false;
     }

◆ unlinkFilesByMD5Filenames()

ilFileDataForumLegacyImplementation::unlinkFilesByMD5Filenames ( $hashed_filename_or_filenames )

Parameters

string|string[] $hashed_filename_or_filenames

Implements ilFileDataForumInterface.

Definition at line 216 of file class.ilFileDataForumLegacyImplementation.php.

References ilFileUtils\getDir().

                                                                             : bool
     {
         $files = ilFileUtils::getDir($this->forum_path);
         if (is_array($hashed_filename_or_filenames)) {
             foreach ($files as $file) {
                 if ($file['type'] === 'file' && in_array(md5($file['entry']), $hashed_filename_or_filenames, true)) {
                     unlink($this->forum_path . '/' . $file['entry']);
                 }
             }
 
             return true;
         }
 
         foreach ($files as $file) {
             if ($file['type'] === 'file' && md5($file['entry']) === $hashed_filename_or_filenames) {
                 return unlink($this->forum_path . '/' . $file['entry']);
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $error

ilErrorHandling ilFileDataForumLegacyImplementation::$error

private

Definition at line 26 of file class.ilFileDataForumLegacyImplementation.php.

◆ $forum_path

string ilFileDataForumLegacyImplementation::$forum_path

private

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

Referenced by getForumPath().

◆ $main_tpl

ilGlobalTemplateInterface ilFileDataForumLegacyImplementation::$main_tpl

private

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

◆ FORUM_PATH

const ilFileDataForumLegacyImplementation::FORUM_PATH = 'forum'

private

Definition at line 23 of file class.ilFileDataForumLegacyImplementation.php.

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

Modules/Forum/classes/Files/class.ilFileDataForumLegacyImplementation.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkForumPath()

◆ checkReadWrite()

◆ createZipFile()

◆ delete()

◆ deliverFile()

◆ deliverZipFile()

◆ getFileDataByMD5Filename()

◆ getForumPath()

◆ getObjId()

◆ getPosId()

◆ ilClone()

◆ initDirectory()

◆ setPosId()

◆ storeUploadedFiles()

◆ unlinkFile()

◆ unlinkFilesByMD5Filenames()

Field Documentation

◆ $error

◆ $forum_path

◆ $main_tpl

◆ FORUM_PATH