ilDAVContainer Class Reference

Inheritance diagram for ilDAVContainer:

Collaboration diagram for ilDAVContainer:

Public Member Functions
	__construct (protected ilObject $obj, protected ilObjUser $current_user, protected RequestInterface $request, protected ilWebDAVObjFactory $dav_factory, protected ilWebDAVRepositoryHelper $repository_helper)
	getName ()
	getChild ($name)
	getChildren ()
	childExists ($name)
	setName ($name)
	createFile ($name, $data=null)
	createDirectory ($name)
	delete ()
	getLastModified ()

Protected Member Functions
	getChildCollection ()

Detailed Description

Author

Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

ilDAVContainer::__construct	(	protected ilObject	$obj,
		protected ilObjUser	$current_user,
		protected RequestInterface	$request,
		protected ilWebDAVObjFactory	$dav_factory,
		protected ilWebDAVRepositoryHelper	$repository_helper
	)

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

      {
    }

Member Function Documentation

childExists()

ilDAVContainer::childExists

(

$name

)

See also

::childExists()

Definition at line 80 of file class.ilDAVContainer.php.

Referenced by createFile().

                                      : bool
    {
        return $this->checkIfChildExistsByParentRefId(
            $this->repository_helper,
            $this->dav_factory,
            $this->obj->getRefId(),
            $name
        );
    }

Here is the caller graph for this function:

createDirectory()

ilDAVContainer::createDirectory

(

$name

)

See also

::createDirectory()

Definition at line 157 of file class.ilDAVContainer.php.

References getChildCollection().

                                          : void
    {
        $new_obj = $this->getChildCollection();

        if (!$this->repository_helper->checkCreateAccessForType($this->obj->getRefId(), $new_obj->getType())) {
            throw new Forbidden('Permission denied');
        }

        try {
            $new_obj->setOwner($this->current_user->getId());
            $new_obj->setTitle($name);
            $this->dav_factory->createDAVObject($new_obj, $this->obj->getRefId());
        } catch (ilWebDAVNotDavableException) {
            throw new Forbidden('Forbidden characters in title');
        }
    }

Here is the call graph for this function:

createFile()

ilDAVContainer::createFile	(		$name,
			$data = null
	)

See also

::createFile()

Definition at line 112 of file class.ilDAVContainer.php.

References $data, Vendor\Package\$f, childExists(), ensureSuffix(), extractSuffixFromFilename(), getChild(), ilFileUtils\getPhpUploadSizeLimitInBytes(), and ILIAS\Repository\int().

                                                   : ?string
    {
        if (!$this->repository_helper->checkCreateAccessForType($this->obj->getRefId(), 'file')) {
            throw new Forbidden('Permission denied');
        }

        $size = 0;
        if ($this->request->hasHeader("Content-Length")) {
            $size = (int) $this->request->getHeader("Content-Length")[0];
        }
        if ($size === 0 && $this->request->hasHeader('X-Expected-Entity-Length')) {
            $size = (int) $this->request->getHeader('X-Expected-Entity-Length')[0];
        }
        if ($size > ilFileUtils::getPhpUploadSizeLimitInBytes()) {
            throw new Forbidden('File is too big');
        }

        $name = $this->ensureSuffix($name, $this->extractSuffixFromFilename($name));

        if ($this->childExists($name)) {
            $file_dav = $this->getChild($name);
        } else {
            try {
                $file_obj = new ilObjFile();
                $file_obj->setTitle($name);

                $file_dav = $this->dav_factory->createDAVObject($file_obj, $this->obj->getRefId());
            } catch (ilWebDAVNotDavableException) {
                throw new Forbidden('Forbidden characters in title');
            }
        }

        try {
            return $file_dav->put($data, $name);
        } catch (Forbidden $f) {
            throw $f;
        } catch (Throwable) {
            return null;
        }
    }

Here is the call graph for this function:

delete()

ilDAVContainer::delete

(

)

Definition at line 174 of file class.ilDAVContainer.php.

                            : void
    {
        $this->repository_helper->deleteObject($this->obj->getRefId());
    }

getChild()

ilDAVContainer::getChild

(

$name

)

See also

::getChild()

Definition at line 54 of file class.ilDAVContainer.php.

Referenced by createFile().

                                   : INode
    {
        return $this->getChildByParentRefId(
            $this->repository_helper,
            $this->dav_factory,
            $this->obj->getRefId(),
            $name
        );
    }

Here is the caller graph for this function:

getChildCollection()

ilDAVContainer::getChildCollection ( )

protected

Definition at line 184 of file class.ilDAVContainer.php.

Referenced by createDirectory().

                                           : ilContainer
    {
        if ($this->obj::class === 'ilObjCategory') {
            return new ilObjCategory();
        }

        return new ilObjFolder();
    }

Here is the caller graph for this function:

getChildren()

ilDAVContainer::getChildren

(

)

Returns

ilObject[]

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

                                 : array
    {
        return $this->getChildrenByParentRefId(
            $this->repository_helper,
            $this->dav_factory,
            $this->obj->getRefId()
        );
    }

getLastModified()

ilDAVContainer::getLastModified

(

)

Definition at line 179 of file class.ilDAVContainer.php.

                                     : ?int
    {
        return $this->retrieveLastModifiedAsIntFromObjectLastUpdateString($this->obj->getLastUpdateDate());
    }

getName()

ilDAVContainer::getName

(

)

Definition at line 45 of file class.ilDAVContainer.php.

                             : string
    {
        return $this->obj->getTitle();
    }

setName()

ilDAVContainer::setName

(

$name

)

See also

::setName()

Definition at line 94 of file class.ilDAVContainer.php.

                                  : void
    {
        if (!$this->repository_helper->checkAccess("write", $this->obj->getRefId())) {
            throw new Forbidden('Permission denied');
        }

        if ($this->isDAVableObjTitle($name)) {
            $this->obj->setTitle($name);
            $this->obj->update();
        } else {
            throw new Forbidden('Forbidden characters in title');
        }
    }

---

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

• components/ILIAS/WebDAV/classes/dav/class.ilDAVContainer.php