This class handles all operations on files for the forum object. More...

Inheritance diagram for ilFileDataForum:

Collaboration diagram for ilFileDataForum:

Public Member Functions
	__construct ($a_obj_id=0, $a_pos_id=0)
	Constructor call base constructors checks if directory is writable and sets the optional obj_id. More...

	getObjId ()

	getPosId ()

	setPosId ($a_id)

	getForumPath ()
	get forum path @access public More...

	ilClone ($a_new_obj_id, $a_new_pos_id)

	delete ()

	storeUploadedFile ($files)
	Store uploaded files in filesystem. More...

	unlinkFiles ($a_filenames)
	unlink files: expects an array of filenames e.g. More...

	unlinkFile ($a_filename)
	unlink one uploaded file expects a filename e.g 'foo' More...

	getAbsolutePath ($a_path)
	get absolute path of filename More...

	getFileDataByMD5Filename ($a_md5_filename)
	get file data of a specific attachment More...

	unlinkFilesByMD5Filenames ($a_md5_filename)
	get file data of a specific attachment More...

	checkFilesExist ($a_files)
	check if files exist More...

	__checkPath ()

	__checkReadWrite ()
	check if directory is writable overwritten method from base class @access private More...

	__initDirectory ()
	init directory overwritten method @access public More...

	__rotateFiles ($a_path)
	rotate files with same name recursive method More...

Public Member Functions inherited from ilFileData
	ilFileData ()
	Constructor class bas constructor and read path of directory from ilias.ini setup an mail object @access public. More...

	checkPath ($a_path)
	check if path exists and is writable More...

	getPath ()
	get Path @access public More...

Public Member Functions inherited from ilFile
	ilFile ()
	Constructor get ilias object @access public. More...

	deleteTrailingSlash ($a_path)
	delete trailing slash of path variables More...

Data Fields
	$obj_id

	$pos_id

	$forum_path

Data Fields inherited from ilFile
	$path

	$ilias

Detailed Description

This class handles all operations on files for the forum object.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilFileDataForum::__construct	(	$a_obj_id = `0`,
		$a_pos_id = `0`
	)

Constructor call base constructors checks if directory is writable and sets the optional obj_id.

Parameters

integereger obj_id @access public

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

        {
                define('FORUM_PATH', 'forum');
                parent::__construct();
                $this->forum_path = parent::getPath()."/".FORUM_PATH;
                
                // IF DIRECTORY ISN'T CREATED CREATE IT
                if(!$this->__checkPath())
                {
                        $this->__initDirectory();
                }
                $this->obj_id = $a_obj_id;
                $this->pos_id = $a_pos_id;
        }

References __checkPath(), and __initDirectory().

Here is the call graph for this function:

Member Function Documentation

◆ __checkPath()

ilFileDataForum::__checkPath ( )

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

        {
                if(!@file_exists($this->getForumPath()))
                {
                        return false;
                }
                $this->__checkReadWrite();
 
                return true;
        }

References __checkReadWrite(), and getForumPath().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkReadWrite()

ilFileDataForum::__checkReadWrite ( )

check if directory is writable overwritten method from base class @access private

Returns: bool

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

        {
                if(is_writable($this->forum_path) && is_readable($this->forum_path))
                {
                        return true;
                }
                else
                {
                        $this->ilias->raiseError("Forum directory is not readable/writable by webserver",$this->ilias->error_obj->FATAL);
                }
        }

Referenced by __checkPath().

Here is the caller graph for this function:

◆ __initDirectory()

ilFileDataForum::__initDirectory ( )

init directory overwritten method @access public

Returns: string path

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

        {
                if(is_writable($this->getPath()))
                {
                        if(mkdir($this->getPath().'/'.FORUM_PATH))
                        {
                                if(chmod($this->getPath().'/'.FORUM_PATH,0755))
                                {
                                        $this->forum_path = $this->getPath().'/'.FORUM_PATH;
                                        return true;
                                }
                        } 
                }
                return false;
        }

References ilFileData\getPath().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __rotateFiles()

ilFileDataForum::__rotateFiles ( $a_path )

rotate files with same name recursive method

Parameters

string filename @access private

Returns: bool

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

        {
                if(file_exists($a_path))
                {
                        $this->__rotateFiles($a_path.".old");
                        return rename($a_path,$a_path.'.old');
                }
                return true;
        }

References __rotateFiles().

Referenced by __rotateFiles(), and storeUploadedFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkFilesExist()

ilFileDataForum::checkFilesExist ( $a_files )

check if files exist

Parameters

array filenames to check @access public

Returns: bool

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

        {
                if($a_files)
                {
                        foreach($a_files as $file)
                        {
                                if(!file_exists($this->forum_path.'/'.$this->obj_id.'_'.$this->pos_id.'_'.$file))
                                {
                                        return false;
                                }
                        }
                        return true;
                }
                return true;
        }

References $file.

◆ delete()

ilFileDataForum::delete ( )

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

        {
                foreach($this->getFiles() as $file)
                {
                        if(file_exists($this->getForumPath()."/".$this->getObjId()."_".$file["name"]))
                        {
                                unlink($this->getForumPath()."/".$this->getObjId()."_".$file["name"]);
                        }
                }
                return true;
        }

References $file, getForumPath(), and getObjId().

Here is the call graph for this function:

◆ getAbsolutePath()

ilFileDataForum::getAbsolutePath ( $a_path )

get absolute path of filename

Parameters

string relative path @access public

Returns: string absolute path

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

        {
                return $this->forum_path.'/'.$this->obj_id.'_'.$this->pos_id."_".$a_path;
        }

◆ getFileDataByMD5Filename()

ilFileDataForum::getFileDataByMD5Filename ( $a_md5_filename )

get file data of a specific attachment

Parameters

string md5 encrypted filename @access public

Returns: array filedata

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

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

References $file, and ilUtil\getDir().

Here is the call graph for this function:

◆ getForumPath()

ilFileDataForum::getForumPath ( )

get forum path @access public

Returns: string path

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

        {
                return $this->forum_path;
        }

References $forum_path.

Referenced by __checkPath(), delete(), ilClone(), and storeUploadedFile().

Here is the caller graph for this function:

◆ getObjId()

ilFileDataForum::getObjId ( )

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

        {
                return $this->obj_id;
        }

References $obj_id.

Referenced by delete().

Here is the caller graph for this function:

◆ getPosId()

ilFileDataForum::getPosId ( )

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

        {
                return $this->pos_id;
        }

References $pos_id.

◆ ilClone()

ilFileDataForum::ilClone	(	$a_new_obj_id,
		$a_new_pos_id
	)

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

        {
                foreach($this->getFilesOfPost() as $file)
                {
                        @copy($this->getForumPath()."/".$this->obj_id."_".$this->pos_id."_".$file["name"],
                                  $this->getForumPath()."/".$a_new_obj_id."_".$a_new_pos_id."_".$file["name"]);
                }
                return true;
        }

References $file, and getForumPath().

Here is the call graph for this function:

◆ setPosId()

ilFileDataForum::setPosId ( $a_id )

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

        {
                $this->pos_id = $a_id;
        }

◆ storeUploadedFile()

ilFileDataForum::storeUploadedFile ( $files )

Store uploaded files in filesystem.

Parameters

array $files Copy of $_FILES array, @access public

Returns: bool

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

        {
                if(isset($files['name']) && is_array($files['name']))
                {
                        foreach($files['name'] as $index => $name)
                        {
                                // remove trailing '/'
                                while(substr($name, -1) == '/')
                                {
                                        $name = substr($name, 0, -1);
                                }       
                                $filename = ilUtil::_sanitizeFilemame($name);                           
                                $temp_name = $files['tmp_name'][$index];
                                $error = $files['error'][$index];
                                
                                if(strlen($filename) && strlen($temp_name) && $error == 0)
                                {                               
                                        $path = $this->getForumPath().'/'.$this->obj_id.'_'.$this->pos_id.'_'.$filename;
                                        
                                        $this->__rotateFiles($path);
                                        ilUtil::moveUploadedFile($temp_name, $filename, $path);                         
                                }
                        }
                        
                        return true;
                }
                else if(isset($files['name']) && is_string($files['name']))
                {
                        // remove trailing '/'
                        while(substr($files['name'], -1) == '/')
                        {
                                $files['name'] = substr($files['name'], 0, -1);
                        }                       
                        $filename = ilUtil::_sanitizeFilemame($files['name']);
                        $temp_name = $files['tmp_name'];
                        
                        $path = $this->getForumPath().'/'.$this->obj_id.'_'.$this->pos_id.'_'.$filename;
                        
                        $this->__rotateFiles($path);
                        ilUtil::moveUploadedFile($temp_name, $filename, $path);
                        
                        return true;
                }
                
                return false;
        }

References $filename, ilFile\$path, __rotateFiles(), ilUtil\_sanitizeFilemame(), getForumPath(), and ilUtil\moveUploadedFile().

Here is the call graph for this function:

◆ unlinkFile()

ilFileDataForum::unlinkFile ( $a_filename )

unlink one uploaded file expects a filename e.g 'foo'

Parameters

string filename to delete @access public

Returns: bool

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

        {
                if(file_exists($this->forum_path.'/'.$this->obj_id.'_'.$this->pos_id.'_'.$a_filename))
                {
                        return unlink($this->forum_path.'/'.$this->obj_id.'_'.$this->pos_id."_".$a_filename);
                }
        }

Referenced by unlinkFiles().

Here is the caller graph for this function:

◆ unlinkFiles()

ilFileDataForum::unlinkFiles ( $a_filenames )

unlink files: expects an array of filenames e.g.

array('foo','bar')

Parameters

array filenames to delete @access public

Returns: string error message with filename that couldn't be deleted

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

        {
                if(is_array($a_filenames))
                {
                        foreach($a_filenames as $file)
                        {
                                if(!$this->unlinkFile($file))
                                {
                                        return $file;
                                }
                        }
                }
                return '';
        }

References $file, and unlinkFile().

Here is the call graph for this function:

◆ unlinkFilesByMD5Filenames()

ilFileDataForum::unlinkFilesByMD5Filenames ( $a_md5_filename )

get file data of a specific attachment

Parameters

string|array md5 encrypted filename or array of multiple md5 encrypted files @access public

Returns: boolean status

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

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

References $file, and ilUtil\getDir().

Here is the call graph for this function:

Field Documentation

◆ $forum_path

ilFileDataForum::$forum_path

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

Referenced by getForumPath().

◆ $obj_id

ilFileDataForum::$obj_id

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

Referenced by getObjId().

◆ $pos_id

ilFileDataForum::$pos_id

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

Referenced by getPosId().

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

Modules/Forum/classes/class.ilFileDataForum.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __checkPath()

◆ __checkReadWrite()

◆ __initDirectory()

◆ __rotateFiles()

◆ checkFilesExist()

◆ delete()

◆ getAbsolutePath()

◆ getFileDataByMD5Filename()

◆ getForumPath()

◆ getObjId()

◆ getPosId()

◆ ilClone()

◆ setPosId()

◆ storeUploadedFile()

◆ unlinkFile()

◆ unlinkFiles()

◆ unlinkFilesByMD5Filenames()

Field Documentation

◆ $forum_path

◆ $obj_id

◆ $pos_id