ILIAS\WebDAV\Entity\Factory Class Reference

Collaboration diagram for ILIAS\WebDAV\Entity\Factory:

Public Member Functions
	__construct (private RequestTranslation $request_translation, private TreeProxyRepository $proxy_generator,)
	getMountPoint ()
	get (string $path, ?Container $parent=null)
	getProblemInfoFile (Container $container)
	createFile (Container $container, string $name, mixed $data=null)
	createContainer (Container $container, string $name)
	has (Container $container, string $name)
	rename (Entity $entity)
	delete (Entity $entity)
	getChildren (Container $container)
	getByFullPath (string $full_path)

Private Member Functions
	buildEntity (Proxy $proxy, ?Container $container)

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 36 of file Factory.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WebDAV\Entity\Factory::__construct	(	private RequestTranslation	$request_translation,
		private TreeProxyRepository	$proxy_generator
	)

Definition at line 40 of file Factory.php.

      {
    }

Member Function Documentation

buildEntity()

ILIAS\WebDAV\Entity\Factory::buildEntity ( Proxy  $proxy, ?Container  $container  )

private

Definition at line 80 of file Factory.php.

                                                                     : Entity
    {
        if ($proxy->getType() === Type::FILE) {
            return new File(
                $this,
                $container?->getFullPath() . '/' . $proxy->getName(),
                $proxy,
                $container
            );
        }
        return new Container(
            $this,
            $container?->getFullPath() . '/' . $proxy->getName(),
            $proxy,
            $container
        );
    }

References $container, ILIAS\WebDAV\Objects\Proxy\getName(), and ILIAS\WebDAV\Objects\Proxy\getType().

Referenced by ILIAS\WebDAV\Entity\Factory\get(), and ILIAS\WebDAV\Entity\Factory\getChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

createContainer()

ILIAS\WebDAV\Entity\Factory::createContainer	(	Container	$container,
		string	$name
	)

Definition at line 114 of file Factory.php.

                                                                       : string
    {
        $proxy = $this->proxy_generator->createContainer($container, $name);
        if ($proxy === null || $proxy instanceof NullProxy) {
            throw new Forbidden("Cannot create container '{$name}' in '{$container->getName()}'");
        }
        return $proxy->getName();
    }

References $container.

createFile()

ILIAS\WebDAV\Entity\Factory::createFile	(	Container	$container,
		string	$name,
		mixed	$data = null
	)

Definition at line 98 of file Factory.php.

                                                                                      : ?string
    {
        $proxy = $this->proxy_generator->createFile($container, $name);
        if (!$proxy instanceof FileProxy) {
            throw new Forbidden("Cannot create file '{$name}' in container '{$container->getName()}'");
        }
        $proxy->getStreamHandler()->put($name, $data, !$this->isEmpty($data));
 
        $entity = $this->get($name, $container);
        if (!$entity instanceof File) {
            throw new Forbidden("Created file '{$name}' could not be retrieved");
        }
 
        return $entity->getEtag();
    }

References $container, and $data.

delete()

ILIAS\WebDAV\Entity\Factory::delete

(

Entity

$entity

)

Definition at line 135 of file Factory.php.

                                          : void
    {
        if (!$this->proxy_generator->delete($entity)) {
            throw new Forbidden("Cannot delete '{$entity->getName()}'");
        }
    }

get()

ILIAS\WebDAV\Entity\Factory::get	(	string	$path,
		?Container	$parent = null
	)

Definition at line 59 of file Factory.php.

                                                                : ?Entity
    {
        $proxy = $this->proxy_generator->get($path, $parent);
        if ($proxy === null || $proxy instanceof NullProxy) {
            return null;
        }
        return $this->buildEntity($proxy, $parent);
    }

References $path, and ILIAS\WebDAV\Entity\Factory\buildEntity().

Here is the call graph for this function:

getByFullPath()

ILIAS\WebDAV\Entity\Factory::getByFullPath

(

string

$full_path

)

Definition at line 163 of file Factory.php.

                                                    : ?Entity
    {
        $parts = array_values(array_filter(explode('/', $full_path), static fn(string $p): bool => $p !== ''));
        if ($parts === []) {
            return null;
        }
 
        $entity = $this->get(array_shift($parts));
        foreach ($parts as $part) {
            if (!$entity instanceof Container) {
                return null;
            }
            $entity = $this->get($part, $entity);
        }
 
        return $entity;
    }

References $parts.

getChildren()

ILIAS\WebDAV\Entity\Factory::getChildren

(

Container

$container

)

Definition at line 142 of file Factory.php.

                                                     : array
    {
        $entities = [];
        foreach ($this->proxy_generator->in($container) as $proxy) {
            if ($proxy === null) {
                continue;
            }
            if ($proxy instanceof NullProxy) {
                continue;
            }
            $entities[] = $this->buildEntity($proxy, $container);
        }
 
        $info_file = $this->getProblemInfoFile($container);
        if ($info_file->hasProblems()) {
            $entities[] = $info_file;
        }
 
        return $entities;
    }

References $container, ILIAS\WebDAV\Entity\Factory\buildEntity(), and ILIAS\WebDAV\Entity\Factory\getProblemInfoFile().

Here is the call graph for this function:

getMountPoint()

ILIAS\WebDAV\Entity\Factory::getMountPoint

(

)

Definition at line 46 of file Factory.php.

                                   : ?ICollection
    {
        $base_path = $this->request_translation->getRequestedPathAsArray()[0] ?? '';
        if (empty($base_path)) {
            return null;
        }
 
        return new MountPoint(
            $this,
            $base_path
        );
    }

getProblemInfoFile()

ILIAS\WebDAV\Entity\Factory::getProblemInfoFile

(

Container

$container

)

Definition at line 68 of file Factory.php.

                                                            : ProblemInfoFile
    {
        global $DIC;
        $problems = $this->proxy_generator->analyseProblems($container);
        return new ProblemInfoFile(
            $problems['duplicates'],
            $problems['forbidden'],
            $problems['info_name_collision'],
            $DIC->language()
        );
    }

References $container, and $DIC.

Referenced by ILIAS\WebDAV\Entity\Factory\getChildren().

Here is the caller graph for this function:

has()

ILIAS\WebDAV\Entity\Factory::has	(	Container	$container,
		string	$name
	)

Definition at line 123 of file Factory.php.

                                                           : bool
    {
        return $this->proxy_generator->get($name, $container) !== null;
    }

References $container.

rename()

ILIAS\WebDAV\Entity\Factory::rename

(

Entity

$entity

)

Definition at line 128 of file Factory.php.

                                          : void
    {
        if (!$this->proxy_generator->rename($entity)) {
            throw new Forbidden("Cannot rename '{$entity->getName()}'");
        }
    }

---

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

• components/ILIAS/WebDAV/src/Entity/Factory.php