ilFileDataForumDrafts Class Reference

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

Inheritance diagram for ilFileDataForumDrafts:

Collaboration diagram for ilFileDataForumDrafts:

Public Member Functions
	__construct ($obj_id=0, $draft_id)
	getObjId ()
	setObjId ($obj_id)
	getDraftId ()
	setDraftId ($draft_id)
	getDraftsPath ()
	moveFilesOfDraft ($forum_path, $new_post_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...
	deliverFile ($file)
	createZipFile ()
Public Member Functions inherited from ilFileData
	__construct ()
	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
	__construct ()
	Constructor get ilias object @access public. More...
	deleteTrailingSlash ($a_path)
	delete trailing slash of path variables More...

Protected Attributes
	$obj_id = 0
	$draft_id = 0
	$drafts_path = ''

Additional Inherited Members
Data Fields inherited from ilFile
	$path
	$ilias

Detailed Description

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

Author

Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilFileDataForumDrafts::__construct	(		$obj_id = 0,
			$draft_id
	)

Definition at line 20 of file class.ilFileDataForumDrafts.php.

        {
                $this->obj_id = $obj_id;
                $this->draft_id = $draft_id;
                
                define('FORUM_DRAFTS_PATH', 'forum/drafts');
                parent::__construct();
                $this->drafts_path = parent::getPath()."/".FORUM_DRAFTS_PATH;
                
                // IF DIRECTORY ISN'T CREATED CREATE IT
                if(!$this->__checkPath())
                {
                        $this->__initDirectory();
                }
        }

References $draft_id, $obj_id, __checkPath(), and __initDirectory().

Here is the call graph for this function:

Member Function Documentation

__checkPath()

ilFileDataForumDrafts::__checkPath

(

)

Definition at line 337 of file class.ilFileDataForumDrafts.php.

        {
                if(!@file_exists($this->getDraftsPath().'/'.$this->getDraftId()))
                {
                        return false;
                }
                $this->__checkReadWrite();
                
                return true;
        }

References __checkReadWrite(), getDraftId(), and getDraftsPath().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

__checkReadWrite()

ilFileDataForumDrafts::__checkReadWrite

(

)

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

Returns

bool

Definition at line 353 of file class.ilFileDataForumDrafts.php.

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

References getDraftId(), and getDraftsPath().

Referenced by __checkPath().

Here is the call graph for this function:

Here is the caller graph for this function:

__initDirectory()

ilFileDataForumDrafts::__initDirectory

(

)

init directory overwritten method @access public

Returns

string path

Definition at line 370 of file class.ilFileDataForumDrafts.php.

        {
                if(is_writable($this->getPath()))
                {
                        if(ilUtil::makeDirParents($this->getDraftsPath()."/".$this->getDraftId()))
                        {
                                if(chmod($this->getDraftsPath()."/".$this->getDraftId(),0755))
                                {
                                        return true;
                                }
                        }
                }
                return false;
        }

References getDraftId(), getDraftsPath(), ilFileData\getPath(), and ilUtil\makeDirParents().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

__rotateFiles()

ilFileDataForumDrafts::__rotateFiles

(

$a_path

)

rotate files with same name recursive method

Parameters

string

filename @access private

Returns

bool

Definition at line 391 of file class.ilFileDataForumDrafts.php.

        {
                if(file_exists($a_path))
                {
                        $this->__rotateFiles($a_path.".old");
                        return \ilFileUtils::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()

ilFileDataForumDrafts::checkFilesExist

(

$a_files

)

check if files exist

Parameters

array

filenames to check @access public

Returns

bool

Definition at line 320 of file class.ilFileDataForumDrafts.php.

        {
                if($a_files)
                {
                        foreach($a_files as $file)
                        {
                                if(!file_exists($this->getDraftsPath().'/'.$this->getDraftId().'/'.$file))
                                {
                                        return false;
                                }
                        }
                        return true;
                }
                return true;
        }

References $file, getDraftId(), and getDraftsPath().

Here is the call graph for this function:

createZipFile()

ilFileDataForumDrafts::createZipFile

(

)

Returns

null|string

Definition at line 443 of file class.ilFileDataForumDrafts.php.

        {
                $filesOfDraft = $this->getFilesOfPost();
                if(count($filesOfDraft))
                {
                        ksort($filesOfDraft);
 
                        ilUtil::makeDirParents($this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId());
                        $tmp_dir = $this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId();
                        foreach($filesOfDraft as $file)
                        {
                                @copy($file['path'], $tmp_dir . '/' . $file['name']);
                        }
                }
 
                $zip_file = null;
                if(ilUtil::zip($tmp_dir, $this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId() . '.zip'))
                {
                        $zip_file = $this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId() . '.zip';
                }
 
                return $zip_file;
        }

References $file, getDraftId(), getDraftsPath(), ilUtil\makeDirParents(), and ilUtil\zip().

Here is the call graph for this function:

delete()

ilFileDataForumDrafts::delete

(

)

Returns

bool

Definition at line 150 of file class.ilFileDataForumDrafts.php.

        {
                ilUtil::delDir($this->getDraftsPath().'/'.$this->getDraftId());
                return true;
        }

References ilUtil\delDir(), getDraftId(), and getDraftsPath().

Here is the call graph for this function:

deliverFile()

ilFileDataForumDrafts::deliverFile

(

$file

)

Parameters

$file

$_GET['file']

Returns

bool|void

Definition at line 405 of file class.ilFileDataForumDrafts.php.

        {
                if(!$path = $this->getFileDataByMD5Filename($file))
                {
                        global $lng;
                        return ilUtil::sendFailure($lng->txt('error_reading_file'), true);
                }
                else
                {
                        return ilUtil::deliverFile($path['path'], $path['clean_filename']);
                }
        }

References $lng, ilFile\$path, ilUtil\deliverFile(), getFileDataByMD5Filename(), and ilUtil\sendFailure().

Here is the call graph for this function:

getAbsolutePath()

ilFileDataForumDrafts::getAbsolutePath

(

$a_path

)

get absolute path of filename

Parameters

string

relative path @access public

Returns

string absolute path

Definition at line 250 of file class.ilFileDataForumDrafts.php.

        {
                return $this->getDraftsPath().'/'.$this->getDraftId();
        }

References getDraftId(), and getDraftsPath().

Here is the call graph for this function:

getDraftId()

ilFileDataForumDrafts::getDraftId

(

)

Returns

int

Definition at line 55 of file class.ilFileDataForumDrafts.php.

        {
                return $this->draft_id;
        }

References $draft_id.

Referenced by __checkPath(), __checkReadWrite(), __initDirectory(), checkFilesExist(), createZipFile(), delete(), getAbsolutePath(), getFileDataByMD5Filename(), storeUploadedFile(), unlinkFile(), and unlinkFilesByMD5Filenames().

Here is the caller graph for this function:

getDraftsPath()

ilFileDataForumDrafts::getDraftsPath

(

)

Returns

string

Definition at line 71 of file class.ilFileDataForumDrafts.php.

        {
                return $this->drafts_path;
        }

References $drafts_path.

Referenced by __checkPath(), __checkReadWrite(), __initDirectory(), checkFilesExist(), createZipFile(), delete(), getAbsolutePath(), getFileDataByMD5Filename(), storeUploadedFile(), unlinkFile(), and unlinkFilesByMD5Filenames().

Here is the caller graph for this function:

getFileDataByMD5Filename()

ilFileDataForumDrafts::getFileDataByMD5Filename

(

$a_md5_filename

)

get file data of a specific attachment

Parameters

string

md5 encrypted filename @access public

Returns

array filedata

Definition at line 261 of file class.ilFileDataForumDrafts.php.

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

References $file, $files, ilUtil\getDir(), getDraftId(), and getDraftsPath().

Referenced by deliverFile().

Here is the call graph for this function:

Here is the caller graph for this function:

getObjId()

ilFileDataForumDrafts::getObjId

(

)

Returns

int

Definition at line 39 of file class.ilFileDataForumDrafts.php.

        {
                return $this->obj_id;
        }

References $obj_id.

moveFilesOfDraft()

ilFileDataForumDrafts::moveFilesOfDraft	(		$forum_path,
			$new_post_id
	)

Definition at line 137 of file class.ilFileDataForumDrafts.php.

        {
                foreach($this->getFilesOfPost() as $file)
                {
                        @copy($file['path'],
                                $forum_path.'/'.$this->obj_id.'_'.$new_post_id.'_'.$file['name']);
                }
                return true;
        }

References $file.

setDraftId()

ilFileDataForumDrafts::setDraftId

(

$draft_id

)

Parameters

int

$draft_id

Definition at line 63 of file class.ilFileDataForumDrafts.php.

        {
                $this->draft_id = $draft_id;
        }

References $draft_id.

setObjId()

ilFileDataForumDrafts::setObjId

(

$obj_id

)

Parameters

int

$obj_id

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

        {
                $this->obj_id = $obj_id;
        }

References $obj_id.

storeUploadedFile()

ilFileDataForumDrafts::storeUploadedFile

(

$files

)

Store uploaded files in filesystem.

Parameters

array

$files

Copy of $_FILES array, @access public

Returns

bool

Definition at line 165 of file class.ilFileDataForumDrafts.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->getDraftsPath().'/'.$this->getDraftId().'/'.$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->getDraftsPath().'/'.$this->getDraftId().'/'.$filename;
                        
                        $this->__rotateFiles($path);
                        ilUtil::moveUploadedFile($temp_name, $filename, $path);
                        
                        return true;
                }
                
                return false;
        }

References $error, $filename, $files, ilFile\$path, __rotateFiles(), ilUtil\_sanitizeFilemame(), getDraftId(), getDraftsPath(), and ilUtil\moveUploadedFile().

Here is the call graph for this function:

unlinkFile()

ilFileDataForumDrafts::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 237 of file class.ilFileDataForumDrafts.php.

        {
                if(file_exists($this->getDraftsPath().'/'.$this->getDraftId().'/'.$a_filename))
                {
                        return unlink($this->getDraftsPath().'/'.$this->getDraftId().'/'.$a_filename);
                }
        }

References getDraftId(), and getDraftsPath().

Referenced by unlinkFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

unlinkFiles()

ilFileDataForumDrafts::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 217 of file class.ilFileDataForumDrafts.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()

ilFileDataForumDrafts::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 285 of file class.ilFileDataForumDrafts.php.

        {
                $files = ilUtil::getDir( $this->getDraftsPath().'/'.$this->getDraftId() );
                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->getDraftsPath().'/'.$this->getDraftId().'/'.$file['entry'] );
                                }
                        }
                        
                        return true;
                }
                else
                {
                        foreach((array)$files as $file)
                        {
                                if($file['type'] == 'file' && md5($file['entry']) == $a_md5_filename)
                                {
                                        return unlink( $this->getDraftsPath().'/'.$this->getDraftId().'/'.$file['entry'] );
                                }
                        }
                }
                
                return false;
        }

References $file, $files, ilUtil\getDir(), getDraftId(), and getDraftsPath().

Here is the call graph for this function:

Field Documentation

$draft_id

ilFileDataForumDrafts::$draft_id = 0

protected

Definition at line 17 of file class.ilFileDataForumDrafts.php.

Referenced by __construct(), getDraftId(), and setDraftId().

$drafts_path

ilFileDataForumDrafts::$drafts_path = ''

protected

Definition at line 18 of file class.ilFileDataForumDrafts.php.

Referenced by getDraftsPath().

$obj_id

ilFileDataForumDrafts::$obj_id = 0

protected

Definition at line 16 of file class.ilFileDataForumDrafts.php.

Referenced by __construct(), getObjId(), and setObjId().

---

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

• Modules/Forum/classes/class.ilFileDataForumDrafts.php