ilFSStorageGroup Class Reference

Inheritance diagram for ilFSStorageGroup:

Collaboration diagram for ilFSStorageGroup:

Public Member Functions
	__construct ($a_container_id=0)
	Constructor. More...
	initMemberExportDirectory ()
	Init export directory and create it if it does not exist. More...
	getMemberExportDirectory ()
	Get path of export directory. More...
	addMemberExportFile ($a_data, $a_rel_name)
	Add new export file. More...
	getMemberExportFiles ()
	Get all member export files. More...
	getMemberExportFile ($a_name)
	deleteMemberExportFile ($a_export_name)
	Delete Member Export File. More...
Public Member Functions inherited from ilFileSystemStorage
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...
	getContainerId ()
	create ()
	Create directory. More...
	getAbsolutePath ()
	Get absolute path of storage directory. More...
	writeToFile ($a_data, $a_absolute_path)
	Write data to file. More...
	deleteFile ($a_abs_name)
	Delete file. More...
	deleteDirectory ($a_abs_name)
	Delete directory. More...
	delete ()
	Delete complete directory. More...
	copyFile ($a_from, $a_to)
	Copy files. More...
	appendToPath ($a_appendix)
	getStorageType ()
	getPath ()
	Get path. More...
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...
	create ()
	Create directory. More...
	getAbsolutePath ()
	Get absolute path of storage directory. More...
	getShortPath ()
	rename ($from, $to)

Data Fields
const	MEMBER_EXPORT_DIR = 'memberExport'
Data Fields inherited from ilFileSystemStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3
const	FACTOR = 100
const	MAX_EXPONENT = 3
const	SECURED_DIRECTORY = "sec"

Protected Member Functions
	getPathPostfix ()
	Implementation of abstract method. More...
	getPathPrefix ()
	Implementation of abstract method. More...
Protected Member Functions inherited from ilFileSystemStorage
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...
	init ()
	Read path info. More...
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...

Private Attributes
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemStorage
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...
static	_copyDirectory ($a_source, $a_target)
	Copy directory and all contents. More...
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...
Protected Attributes inherited from ilFileSystemStorage
	$path

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilFSStorageGroup::__construct

(

$a_container_id = 0

)

Constructor.

@access public

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

        {
                global $log;
                
                $this->log = $log;
                parent::__construct(ilFileSystemStorage::STORAGE_DATA,true,$a_container_id);
        }

References $log, and ilFileSystemStorage\STORAGE_DATA.

Member Function Documentation

addMemberExportFile()

ilFSStorageGroup::addMemberExportFile	(		$a_data,
			$a_rel_name
	)

Add new export file.

@access public

Parameters

string	data
string	filename

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

        {
                $this->initMemberExportDirectory();
                if(!$this->writeToFile($a_data,$this->getMemberExportDirectory().'/'.$a_rel_name))
                {
                        $this->log->write('Cannot write to file: '.$this->getMemberExportDirectory().'/'.$a_rel_name);
                        return false;
                }
 
                return true;
                
        }

References getMemberExportDirectory(), initMemberExportDirectory(), and ilFileSystemStorage\writeToFile().

Here is the call graph for this function:

deleteMemberExportFile()

ilFSStorageGroup::deleteMemberExportFile

(

$a_export_name

)

Delete Member Export File.

@access public

Parameters

Definition at line 132 of file class.ilFSStorageGroup.php.

        {
                return $this->deleteFile($this->getMemberExportDirectory().'/'.$a_export_name);
        }

References ilFileSystemStorage\deleteFile(), and getMemberExportDirectory().

Here is the call graph for this function:

getMemberExportDirectory()

ilFSStorageGroup::getMemberExportDirectory

(

)

Get path of export directory.

@access public

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

        {
                return $this->getAbsolutePath().'/'.self::MEMBER_EXPORT_DIR;
        }

References ilFileSystemStorage\getAbsolutePath(), and MEMBER_EXPORT_DIR.

Referenced by addMemberExportFile(), deleteMemberExportFile(), getMemberExportFile(), getMemberExportFiles(), and initMemberExportDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

getMemberExportFile()

ilFSStorageGroup::getMemberExportFile

(

$a_name

)

Definition at line 115 of file class.ilFSStorageGroup.php.

        {
                $file_name = $this->getMemberExportDirectory().'/'.$a_name;
                
                if(@file_exists($file_name))
                {
                        return file_get_contents($file_name);
                }
        }

References getMemberExportDirectory().

Here is the call graph for this function:

getMemberExportFiles()

ilFSStorageGroup::getMemberExportFiles

(

)

Get all member export files.

@access public

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

        {
                if(!@is_dir($this->getMemberExportDirectory()))
                {
                        return array();
                }
                
                $files = array();
                $dp = @opendir($this->getMemberExportDirectory());
 
                while($file = readdir($dp))
                {
                        if(is_dir($file))
                        {
                                continue;
                        }
                        
                        if(preg_match("/^([0-9]{10})_[a-zA-Z]*_export_([a-z]+)_([0-9]+)\.[a-z]+$/",$file,$matches) and $matches[3] == $this->getContainerId())
                        {
                                $timest = $matches[1];
                                $file_info['name'] = $matches[0];
                                $file_info['timest'] = $matches[1];
                                $file_info['type'] = $matches[2];
                                $file_info['id'] = $matches[3];
                                $file_info['size'] = filesize($this->getMemberExportDirectory().'/'.$file);
                                
                                $files[$timest] = $file_info;
                        }
                }
                closedir($dp);
                return $files ? $files : array();
        }

References $file, $files, ilFileSystemStorage\getContainerId(), and getMemberExportDirectory().

Here is the call graph for this function:

getPathPostfix()

ilFSStorageGroup::getPathPostfix ( )

protected

Implementation of abstract method.

@access protected

Reimplemented from ilFileSystemStorage.

Definition at line 147 of file class.ilFSStorageGroup.php.

        {
                return 'grp';
        }

getPathPrefix()

ilFSStorageGroup::getPathPrefix ( )

protected

Implementation of abstract method.

@access protected

Reimplemented from ilFileSystemStorage.

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

        {
                return 'ilGroup';
        }

initMemberExportDirectory()

ilFSStorageGroup::initMemberExportDirectory

(

)

Init export directory and create it if it does not exist.

@access public

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

        {
                ilUtil::makeDirParents($this->getMemberExportDirectory());
        }

References getMemberExportDirectory(), and ilUtil\makeDirParents().

Referenced by addMemberExportFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$log

ilFSStorageGroup::$log

private

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

Referenced by __construct().

MEMBER_EXPORT_DIR

const ilFSStorageGroup::MEMBER_EXPORT_DIR = 'memberExport'

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

Referenced by getMemberExportDirectory().

---

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

• Modules/Group/classes/class.ilFSStorageGroup.php