Inheritance diagram for ilFileSystemStorageMailMigration:

Collaboration diagram for ilFileSystemStorageMailMigration:

Public Member Functions
	__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 ()

Static Public Member Functions
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...

	_copyDirectory ($a_source, $a_target)
	Copy directory and all contents. More...

Data Fields
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	FACTOR = 100

const	MAX_EXPONENT = 3

Protected Member Functions
	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

Private Member Functions
	init ()
	Read path info. More...

Private Attributes
	$container_id

	$storage_type

	$path_conversion = false

	$path

Detailed Description

Definition at line 33 of file class.ilFileSystemStorageMailMigration.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileSystemStorageMailMigration::__construct	(	$a_storage_type,
		$a_path_conversion,
		$a_container_id
	)

Constructor.

@access public

Parameters

int	storage type
bool	En/Disable automatic path conversion. If enabled files with id 123 will be stored in directory files/1/file_123
int	object id of container (e.g file_id or mob_id)

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

        {
                $this->storage_type = $a_storage_type;
                $this->path_conversion = $a_path_conversion;
                $this->container_id = $a_container_id;
                
                // Get path info
                $this->init();
        }

References init().

Here is the call graph for this function:

Member Function Documentation

◆ _copyDirectory()

ilFileSystemStorageMailMigration::_copyDirectory	(	$a_source,
		$a_target
	)

static

Copy directory and all contents.

@access public

Parameters

string	absolute source path
string	absolute target path

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

        {
                return ilUpdateUtilsMailMigration::rCopy($a_source,$a_target);
        }

◆ _createPathFromId()

static ilFileSystemStorageMailMigration::_createPathFromId	(	$a_container_id,
		$a_name
	)

static

Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5.

@access public

Parameters

int	container id
string	name

Definition at line 81 of file class.ilFileSystemStorageMailMigration.php.

        {
                $path = array();
                $found = false;
                $num = $a_container_id;
                for($i = self::MAX_EXPONENT; $i > 0;$i--)
                {
                        $factor = pow(self::FACTOR,$i);
                        if(($tmp = (int) ($num / $factor)) or $found)
                        {
                                $path[] = $tmp;
                                $num = $num % $factor;
                                $found = true;
                        }       
                }
 
                if(count($path))
                {
                        $path_string = (implode('/',$path).'/');
                }
                return $path_string.$a_name.'_'.$a_container_id;
        }

References $path.

Referenced by init().

Here is the caller graph for this function:

◆ appendToPath()

ilFileSystemStorageMailMigration::appendToPath ( $a_appendix )

Definition at line 290 of file class.ilFileSystemStorageMailMigration.php.

        {
                $this->path .= $a_appendix;
        }

Referenced by ilFSStorageMailMailMigration\__construct().

Here is the caller graph for this function:

◆ copyFile()

ilFileSystemStorageMailMigration::copyFile	(	$a_from,
		$a_to
	)

Copy files.

@access public

Parameters

string	absolute source
string	absolute target

Definition at line 266 of file class.ilFileSystemStorageMailMigration.php.

        {
                if(@file_exists($a_from))
                {
                        @copy($a_from,$a_to);
                        return true;
                }
                return false;
        }

◆ create()

ilFileSystemStorageMailMigration::create ( )

Create directory.

@access public

Definition at line 133 of file class.ilFileSystemStorageMailMigration.php.

        {
                if(!file_exists($this->path))
                {
                        ilUpdateUtilsMailMigration::makeDirParents($this->path);
                }
                return true;
        }

References ilUpdateUtilsMailMigration\makeDirParents().

Here is the call graph for this function:

◆ delete()

ilFileSystemStorageMailMigration::delete ( )

Delete complete directory.

@access public

Parameters

Definition at line 252 of file class.ilFileSystemStorageMailMigration.php.

        {
                return ilUpdateUtilsMailMigration::delDir($this->getAbsolutePath());
        }

References ilUpdateUtilsMailMigration\delDir(), and getAbsolutePath().

Here is the call graph for this function:

◆ deleteDirectory()

ilFileSystemStorageMailMigration::deleteDirectory ( $a_abs_name )

Delete directory.

@access public

Parameters

string absolute name

Definition at line 234 of file class.ilFileSystemStorageMailMigration.php.

        {
                if(@file_exists($a_abs_name))
                {
                        ilUpdateUtilsMailMigration::delDir($a_abs_name);
                        return true;
                }
                return false;
        }

References ilUpdateUtilsMailMigration\delDir().

Here is the call graph for this function:

◆ deleteFile()

ilFileSystemStorageMailMigration::deleteFile ( $a_abs_name )

Delete file.

@access public

Parameters

string absolute name

Definition at line 217 of file class.ilFileSystemStorageMailMigration.php.

        {
                if(@file_exists($a_abs_name))
                {
                        @unlink($a_abs_name);
                        return true;
                }
                return false;
        }

◆ getAbsolutePath()

ilFileSystemStorageMailMigration::getAbsolutePath ( )

Get absolute path of storage directory.

@access public

Definition at line 149 of file class.ilFileSystemStorageMailMigration.php.

        {
                return $this->path;
        }

References $path.

Referenced by delete(), and ilFSStorageMailMailMigration\getRelativePathExMailDirectory().

Here is the caller graph for this function:

◆ getContainerId()

ilFileSystemStorageMailMigration::getContainerId ( )

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

        {
                return $this->container_id;
        }

References $container_id.

◆ getPathPostfix()

ilFileSystemStorageMailMigration::getPathPostfix ( )

abstractprotected

Get directory name.

E.g for files => file Only relative path, no trailing slash '_<obj_id>' will be appended automatically

@abstract @access protected

Returns: string directory name

Reimplemented in ilFSStorageMailMailMigration.

Referenced by init().

Here is the caller graph for this function:

◆ getPathPrefix()

ilFileSystemStorageMailMigration::getPathPrefix ( )

abstractprotected

Get path prefix.

Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files

@abstract @access protected

Returns: string path prefix e.g files

Reimplemented in ilFSStorageMailMailMigration.

Referenced by init().

Here is the caller graph for this function:

◆ getStorageType()

ilFileSystemStorageMailMigration::getStorageType ( )

Definition at line 295 of file class.ilFileSystemStorageMailMigration.php.

        {
                return $this->storage_type;
        }

References $storage_type.

Referenced by ilFSStorageMailMailMigration\getRelativePathExMailDirectory().

Here is the caller graph for this function:

◆ init()

ilFileSystemStorageMailMigration::init ( )

private

Read path info.

@access private

Definition at line 159 of file class.ilFileSystemStorageMailMigration.php.

        {
                switch($this->storage_type)
                {
                        case self::STORAGE_DATA:
                                $this->path = ilUpdateUtilsMailMigration::getDataDir();
                                break;
                                
                        case self::STORAGE_WEB:
                                $this->path = ilUpdateUtilsMailMigration::getWebspaceDir();
                                break;
                }
                $this->path = ilUpdateUtilsMailMigration::removeTrailingPathSeparators($this->path);
                $this->path .= '/';
                
                // Append path prefix
                $this->path .= ($this->getPathPrefix().'/');
                
                if($this->path_conversion)
                {
                        $this->path .= self::_createPathFromId($this->container_id,$this->getPathPostfix());
                }
                else
                {
                        $this->path .= ($this->getPathPostfix().'_'.$this->container_id);
                }
                return true;
        }

References $container_id, _createPathFromId(), ilUpdateUtilsMailMigration\getDataDir(), getPathPostfix(), getPathPrefix(), ilUpdateUtilsMailMigration\getWebspaceDir(), ilUpdateUtilsMailMigration\removeTrailingPathSeparators(), STORAGE_DATA, and STORAGE_WEB.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeToFile()

ilFileSystemStorageMailMigration::writeToFile	(	$a_data,
		$a_absolute_path
	)

Write data to file.

@access public

Parameters

Definition at line 195 of file class.ilFileSystemStorageMailMigration.php.

        {
                if(!$fp = @fopen($a_absolute_path,'w+'))
                {
                        return false;
                }
                if(@fwrite($fp,$a_data) === false)
                {
                        @fclose($fp);
                        return false;
                }
                @fclose($fp);
                return true;            
        }