Class ilObjFileAbstractZipDelegate. More...

Inheritance diagram for ilObjFileAbstractZipDelegate:

Collaboration diagram for ilObjFileAbstractZipDelegate:

Public Member Functions
	__construct (object $access_checker, int $node_type, ilTree $tree)
	ilObjFileAbstractZipDelegate constructor. More...

	getUploadedSuffixes ()

Public Member Functions inherited from ilObjUploadDelegateInterface
	handle (int $parent_id, array $post_data, UploadResult $result, ilObjFileGUI $gui)

	getUploadedSuffixes ()

Protected Member Functions
	createSurroundingContainer (UploadResult $result, int $parent_id)

	tearDown ()

	initZip (UploadResult $result)

	isInWorkspace ()

	createContainer (string $original_path, int $parent_id)

	createFile (string $original_path, int $parent_id)

	getNextPath ()

	hasMultipleRootEntriesInZip ()

Protected Attributes
	$access_handler

	$node_type

	$tree

	$path_map = []

	$zip

	$uploaded_suffixes = []

	$create_base_container_for_multiple_root_entries = false
	@description Unzip on operating systems may behave differently when unzipping if there are only one or more root nodes in the zip. More...

Detailed Description

Class ilObjFileAbstractZipDelegate.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 27 of file class.ilObjFileAbstractZipDelegate.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileAbstractZipDelegate::__construct	(	object	$access_checker,
		int	$node_type,
		ilTree	$tree
	)

ilObjFileAbstractZipDelegate constructor.

Parameters

ilAccess \| ilWorkspaceAccessHandler	$access_checker
int	$node_type
ilTree	$tree

Definition at line 69 of file class.ilObjFileAbstractZipDelegate.php.

    {
        $this->access_handler = $access_checker;
        $this->node_type = $node_type;
        $this->tree = $tree;
    }

References $node_type, and $tree.

Member Function Documentation

◆ createContainer()

ilObjFileAbstractZipDelegate::createContainer	(	string	$original_path,
		int	$parent_id
	)

protected

Parameters

string	$original_path
int	$parent_id

Returns: ilObject

Definition at line 113 of file class.ilObjFileAbstractZipDelegate.php.

                                                                              : ilObject
    {
        // Create folder or cat or WorkspaceFolder
        $obj = $this->getPossibleContainer($parent_id);
        $obj->setTitle(basename($original_path));
        $obj->create();
 
        if (!$this->isInWorkspace()) {
            $obj->createReference();
            $obj->putInTree($parent_id);
            $obj->setPermissions($parent_id);
        } else {
            $node_id = $this->tree->insertObject($parent_id, $obj->getId());
            $this->access_handler->setPermissions($parent_id, $node_id);
            $obj->setRefId($node_id);
        }
 
        if ($obj->getType() === "cat") {
            global $DIC;
 
            $lng = $DIC->language();
            $obj->addTranslation(basename($original_path), "", $lng->getLangKey(), $lng->getLangKey());
        }
 
        return $obj;
    }

References $DIC, $lng, and isInWorkspace().

Referenced by createSurroundingContainer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFile()

ilObjFileAbstractZipDelegate::createFile	(	string	$original_path,
		int	$parent_id
	)

protected

Parameters

string	$original_path
int	$parent_id

Returns: ilObjFile

Definition at line 146 of file class.ilObjFileAbstractZipDelegate.php.

                                                                         : ilObjFile
    {
        $obj = new ilObjFile();
        $obj->setTitle(basename($original_path));
        $obj->create();
 
        $obj->appendStream(Streams::ofString($this->zip->getFromName($original_path)), basename($original_path));
 
        if (!$this->isInWorkspace()) {
            $obj->createReference();
            $obj->putInTree($parent_id);
            $obj->setPermissions($parent_id);
        } else {
            $node_id = $this->tree->insertObject($parent_id, $obj->getId());
            $this->access_handler->setPermissions($parent_id, $node_id);
            $obj->setRefId($node_id);
        }
 
        $this->uploaded_suffixes[] = $obj->getFileExtension();
 
        return $obj;
    }

References isInWorkspace().

Referenced by ilObjFileUnzipFlatDelegate\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSurroundingContainer()

ilObjFileAbstractZipDelegate::createSurroundingContainer	(	UploadResult	$result,
		int	$parent_id
	)

protected

Definition at line 76 of file class.ilObjFileAbstractZipDelegate.php.

                                                                                        : int
    {
        // create one base container with the name of the zip itself, all other containers will be created inside this one
        $info = new SplFileInfo($result->getName());
        $base_path = $info->getBasename("." . $info->getExtension());
        $base_container = $this->createContainer($base_path, $parent_id);
 
        return (int) $base_container->getRefId();
    }

References $result, and createContainer().

Referenced by ilObjFileUnzipRecursiveDelegate\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNextPath()

ilObjFileAbstractZipDelegate::getNextPath ( )

protected

Returns: Generator|string[]

Definition at line 172 of file class.ilObjFileAbstractZipDelegate.php.

                                     : Generator
    {
        $paths = [];
 
        for ($i = 0; $i < $this->zip->numFiles; $i++) {
            $original_path = $this->zip->getNameIndex($i, ZipArchive::FL_UNCHANGED);
            if (strpos($original_path, '__MACOSX') !== false || strpos($original_path, '.DS_') !== false) {
                continue;
            }
            $paths[] = $original_path;
        }
 
        $path_with_root_folders = [];
 
        foreach ($paths as $path) {
            $parent = dirname($path) . '/';
            if ($parent !== './' && !in_array($parent, $paths)) {
                $path_with_root_folders[] = $parent;
            }
            $path_with_root_folders[] = $path;
        }
 
        $path_with_root_folders = array_unique($path_with_root_folders);
        sort($path_with_root_folders);
 
        yield from $path_with_root_folders;
    }

References $i.

Referenced by hasMultipleRootEntriesInZip().

Here is the caller graph for this function:

◆ getUploadedSuffixes()

ilObjFileAbstractZipDelegate::getUploadedSuffixes ( )

Implements ilObjUploadDelegateInterface.

Definition at line 215 of file class.ilObjFileAbstractZipDelegate.php.

                                          : array
    {
        return array_map('strtolower', $this->uploaded_suffixes);
    }

◆ hasMultipleRootEntriesInZip()

ilObjFileAbstractZipDelegate::hasMultipleRootEntriesInZip ( )

protected

Definition at line 200 of file class.ilObjFileAbstractZipDelegate.php.

                                                     : bool
    {
        $amount = 0;
        foreach ($this->getNextPath() as $zip_directory) {
            $dirname = dirname($zip_directory);
            if ($dirname === '.') {
                $amount++;
            }
            if ($amount > 1) {
                return true;
            }
        }
        return false;
    }

References getNextPath().

Here is the call graph for this function:

◆ initZip()

ilObjFileAbstractZipDelegate::initZip ( UploadResult $result )

protected

Parameters

UploadResult $result

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

                                                     : void
    {
        $this->zip = new ZipArchive();
        $this->zip->open($result->getPath());
    }

References $result.

◆ isInWorkspace()

ilObjFileAbstractZipDelegate::isInWorkspace ( )

protected

Definition at line 103 of file class.ilObjFileAbstractZipDelegate.php.

                                       : bool
    {
        return $this->node_type === ilObjFileGUI::WORKSPACE_NODE_ID;
    }

References ilObject2GUI\WORKSPACE_NODE_ID.

Referenced by createContainer(), createFile(), and ilObjFileUnzipRecursiveDelegate\getPossibleContainer().

Here is the caller graph for this function:

◆ tearDown()

ilObjFileAbstractZipDelegate::tearDown ( )

protected

Definition at line 88 of file class.ilObjFileAbstractZipDelegate.php.

                                  : void
    {
        $this->zip->close();
    }

Field Documentation

◆ $access_handler

ilObjFileAbstractZipDelegate::$access_handler

protected

Definition at line 32 of file class.ilObjFileAbstractZipDelegate.php.

◆ $create_base_container_for_multiple_root_entries

ilObjFileAbstractZipDelegate::$create_base_container_for_multiple_root_entries = false

protected

@description Unzip on operating systems may behave differently when unzipping if there are only one or more root nodes in the zip.

Currently, the behavior is the same as in ILIAS 7 and earlier, that in any case the zip structure is checked out directly at the current location in the magazine. If this value is set to true here, another category/folder will be placed around the files and folders of the zip when unpacking if more than one root-node is present. For example, macOS behaves in exactly this way.

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

◆ $node_type

ilObjFileAbstractZipDelegate::$node_type

protected

Definition at line 36 of file class.ilObjFileAbstractZipDelegate.php.

Referenced by __construct().

◆ $path_map

ilObjFileAbstractZipDelegate::$path_map = []

protected

Definition at line 44 of file class.ilObjFileAbstractZipDelegate.php.

◆ $tree

ilObjFileAbstractZipDelegate::$tree

protected

Definition at line 40 of file class.ilObjFileAbstractZipDelegate.php.

Referenced by __construct().

◆ $uploaded_suffixes

ilObjFileAbstractZipDelegate::$uploaded_suffixes = []

protected

Definition at line 52 of file class.ilObjFileAbstractZipDelegate.php.

◆ $zip

ilObjFileAbstractZipDelegate::$zip

protected

Definition at line 48 of file class.ilObjFileAbstractZipDelegate.php.

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

Modules/File/classes/Upload/class.ilObjFileAbstractZipDelegate.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createContainer()

◆ createFile()

◆ createSurroundingContainer()

◆ getNextPath()

◆ getUploadedSuffixes()

◆ hasMultipleRootEntriesInZip()

◆ initZip()

◆ isInWorkspace()

◆ tearDown()

Field Documentation

◆ $access_handler

◆ $create_base_container_for_multiple_root_entries

◆ $node_type

◆ $path_map

◆ $tree

◆ $uploaded_suffixes

◆ $zip