class.ilHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Export\ImportHandler\File;

use ilImportException;
use ILIAS\Export\ImportHandler\I\File\ilHandlerInterface as ilFileHandlerInterface;
use ILIAS\Export\ImportHandler\I\File\Namespace\ilCollectionInterface as ilFileNamespaceCollectionInterface;
use ILIAS\Export\ImportHandler\I\File\Namespace\ilFactoryInterface as ilFileNamespaceFactoryInterface;
use ILIAS\Export\ImportHandler\I\File\Namespace\ilHandlerInterface as ilFileNamespaceHandlerInterface;
use SplFileInfo;

class ilHandler implements ilFileHandlerInterface
{
    protected SplFileInfo $xml_file_info;
    protected ilFileNamespaceFactoryInterface $namespace;
    protected ilFileNamespaceCollectionInterface $namespaces;

    public function __construct(
        ilFileNamespaceFactoryInterface $namespace
    ) {
        $this->namespace = $namespace;
        $this->namespaces = $namespace->collection();
    }

    public function withAdditionalNamespace(ilFileNamespaceHandlerInterface $namespace_handler): ilFileHandlerInterface
    {
        $clone = clone $this;
        $clone->namespaces = $clone->namespaces->withElement($namespace_handler);
        return $clone;
    }

    public function getNamespaces(): ilFileNamespaceCollectionInterface
    {
        return $this->namespaces;
    }

    public function withFileInfo(SplFileInfo $file_info): ilFileHandlerInterface
    {
        $clone = clone $this;
        $clone->xml_file_info = $file_info;
        return $clone;
    }

    public function getFileName(): string
    {
        return $this->xml_file_info->getFilename();
    }

    public function getFilePath(): string
    {
        return $this->fileExists()
            ? $this->xml_file_info->getRealPath()
            : $this->xml_file_info->getPath() . DIRECTORY_SEPARATOR . $this->xml_file_info->getFilename();
    }

    public function getSubPathToDirBeginningAtPathEnd(string $dir_name): ilFileHandlerInterface
    {
        $parts = explode(DIRECTORY_SEPARATOR, $this->getFilePath());
        $trimmed_str = '';
        for ($i = count($parts) - 1; $i >= 0; $i--) {
            $trimmed_str = $i < count($parts) - 1
                ? $parts[$i] . DIRECTORY_SEPARATOR . $trimmed_str
                : $parts[$i];
            if ($parts[$i] === $dir_name) {
                break;
            }
        }
        $clone = clone $this;
        $clone->xml_file_info = new SplFileInfo($trimmed_str);
        return $clone;
    }

    public function getSubPathToDirBeginningAtPathStart(string $dir_name): ilFileHandlerInterface
    {
        $parts = explode(DIRECTORY_SEPARATOR, $this->getFilePath());
        $trimmed_str = '';
        for ($i = 0; $i < count($parts); $i++) {
            $trimmed_str .= $i > 0
                ? DIRECTORY_SEPARATOR . $parts[$i]
                : $parts[$i];
            if ($parts[$i] === $dir_name) {
                break;
            }
        }
        $clone = clone $this;
        $clone->xml_file_info = new SplFileInfo($trimmed_str);
        return $clone;
    }

    public function getPathToFileLocation(): string
    {
        return $this->xml_file_info->getPath();
    }

    public function fileExists(): bool
    {
        return $this->xml_file_info->getRealPath() !== false;
    }

    public function getPathPart(string $pattern): string|null
    {
        $path_parts = explode(DIRECTORY_SEPARATOR, $this->getFilePath());
        foreach ($path_parts as $path_part) {
            if (preg_match($pattern, $path_part) === 1) {
                return $path_part;
            }
        }
        return null;
    }

    public function pathContainsFolderName(string $folder_name): bool
    {
        $path_parts = explode(DIRECTORY_SEPARATOR, $this->getFilePath());
        if (in_array($folder_name, $path_parts, true)) {
            return true;
        }
        return false;
    }
}