ilExportImportDirectory Class Reference

Import directory interface. More...

Inheritance diagram for ilExportImportDirectory:

Collaboration diagram for ilExportImportDirectory:

Public Member Functions
	hasFilesFor (int $user_id, string $type)
	getFilesFor (int $user_id, string $type)
	getAbsolutePathForHash (int $user_id, string $type, string $post_hash)
Public Member Functions inherited from ilImportDirectory
	__construct (Filesystem $storage, ilLogger $logger)
	getRelativePath ()
	exists ()
	getAbsolutePath ()

Protected Member Functions
	getPathPrefix ()
	matchesType (string $type, string $filename)
	Check if filename matches a given type. More...
Protected Member Functions inherited from ilImportDirectory
	getPathPrefix ()

Private Attributes
const	PATH_PREFIX = 'export'

Additional Inherited Members
Protected Attributes inherited from ilImportDirectory
	$storage
	$logger

Detailed Description

Import directory interface.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 13 of file class.ilExportImportDirectory.php.

Member Function Documentation

getAbsolutePathForHash()

ilExportImportDirectory::getAbsolutePathForHash	(	int	$user_id,
		string	$type,
		string	$post_hash
	)

Parameters

int	$user_id
string	$type
string	$post_hash

Returns

string

Definition at line 96 of file class.ilExportImportDirectory.php.

References ilUtil\getDataDir(), and getFilesFor().

                                                                                          : string
    {
        foreach ($this->getFilesFor($user_id, $type) as $hash => $file) {
            if (strcmp($hash, $post_hash) === 0) {
                $file_path = base64_decode($hash);
                return ilUtil::getDataDir() . '/' . base64_decode($hash);
            }
        }
        return '';
    }

Here is the call graph for this function:

getFilesFor()

ilExportImportDirectory::getFilesFor	(	int	$user_id,
		string	$type
	)

Parameters

int	$user_id
string	$type

Returns

array

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

References ilImportDirectory\exists(), ilImportDirectory\getRelativePath(), and matchesType().

Referenced by getAbsolutePathForHash(), and hasFilesFor().

                                                            : array
    {
        if (!$this->exists()) {
            return [];
        }
        $finder = $this->storage->finder()
                                ->in([$this->getRelativePath()])
                                ->files()
                                ->depth('< 1')
                                ->sortByName();
        $files = [];
        foreach ($finder as $file) {
            $basename = basename($file->getPath());
            if ($this->matchesType($type, $basename)) {
                $files[base64_encode($file->getPath())] = $basename;
            }
        }
        if ($this->storage->hasDir($this->getRelativePath() . '/' . (string) $user_id)) {
            $finder = $this->storage->finder()->in([$this->getRelativePath() . '/' . (string) $user_id])
                ->depth('< 1')
                ->files()
                ->sortByName();
            foreach ($finder as $file) {
                $basename = basename($file->getPath());
                if ($this->matchesType($type, $basename)) {
                    $files[base64_encode($file->getPath())] = $basename;
                }
            }
        }
        asort($files);
        return $files;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPathPrefix()

ilExportImportDirectory::getPathPrefix ( )

protected

Returns

string

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

                                       : string
    {
        return self::PATH_PREFIX;
    }

hasFilesFor()

ilExportImportDirectory::hasFilesFor	(	int	$user_id,
		string	$type
	)

Parameters

int	$user_id
string	$type

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

References getFilesFor().

                                                            : bool
    {
        return (bool) count($this->getFilesFor($user_id, $type));
    }

Here is the call graph for this function:

matchesType()

ilExportImportDirectory::matchesType ( string  $type, string  $filename  )

protected

Check if filename matches a given type.

Parameters

string

$type

Returns

bool

Definition at line 77 of file class.ilExportImportDirectory.php.

References $result.

Referenced by getFilesFor().

                                                                   : bool
    {
        $matches = [];
        $result = preg_match('/[0-9]{10}__[0-9]{1,6}__([a-z]{1,4})_[0-9]{2,9}.zip/', $filename, $matches);
        if (!$result) {
            return false;
        }
        if (isset($matches[1]) && $matches[1] == $type) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

Field Documentation

PATH_PREFIX

const ilExportImportDirectory::PATH_PREFIX = 'export'

private

Definition at line 15 of file class.ilExportImportDirectory.php.

---

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

• Services/Export/classes/ImportDirectory/class.ilExportImportDirectory.php