ilDAVContainer Class Reference

Inheritance diagram for ilDAVContainer:

Collaboration diagram for ilDAVContainer:

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

Protected Member Functions
	getChildCollection ()

Protected Attributes
ilObjUser	$current_user
ilObject	$obj
RequestInterface	$request
ilWebDAVObjFactory	$dav_factory
ilWebDAVRepositoryHelper	$repository_helper

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	(	ilContainer	$obj,
		ilObjUser	$current_user,
		RequestInterface	$request,
		ilWebDAVObjFactory	$dav_factory,
		ilWebDAVRepositoryHelper	$repository_helper
	)

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

References $current_user, $dav_factory, $obj, $repository_helper, and $request.

      {
        $this->obj = $obj;
        $this->current_user = $current_user;
        $this->request = $request;
        $this->dav_factory = $dav_factory;
        $this->repository_helper = $repository_helper;
    }

Member Function Documentation

childExists()

ilDAVContainer::childExists

(

$name

)

See also

::childExists()

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

References $name.

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 158 of file class.ilDAVContainer.php.

References Vendor\Package\$e, $name, and 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 $e) {
            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 122 of file class.ilDAVContainer.php.

References $data, Vendor\Package\$e, $name, childExists(), getChild(), and ilFileUtils\getUploadSizeLimitBytes().

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

        $size = $this->request->getHeader("Content-Length")[0] ?? 0;
        if ($size === 0 && $this->request->hasHeader('X-Expected-Entity-Length')) {
            $size = $this->request->getHeader('X-Expected-Entity-Length')[0];
        }

        if ($size > ilFileUtils::getUploadSizeLimitBytes()) {
            throw new Forbidden('File is too big');
        }

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

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

        return $file_dav->put($data);
    }

Here is the call graph for this function:

delete()

ilDAVContainer::delete

(

)

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

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

getChild()

ilDAVContainer::getChild

(

$name

)

See also

::getChild()

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

References $name.

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 185 of file class.ilDAVContainer.php.

Referenced by createDirectory().

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

        return new ilObjFolder();
    }

Here is the caller graph for this function:

getChildren()

ilDAVContainer::getChildren

(

)

Returns

ilObject[]

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

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

getLastModified()

ilDAVContainer::getLastModified

(

)

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

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

getName()

ilDAVContainer::getName

(

)

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

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

setName()

ilDAVContainer::setName

(

$name

)

See also

::setName()

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

References $name.

                                  : 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');
        }
    }

Field Documentation

$current_user

ilObjUser ilDAVContainer::$current_user

protected

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

Referenced by __construct().

$dav_factory

ilWebDAVObjFactory ilDAVContainer::$dav_factory

protected

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

Referenced by __construct().

$obj

ilObject ilDAVContainer::$obj

protected

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

Referenced by __construct().

$repository_helper

ilWebDAVRepositoryHelper ilDAVContainer::$repository_helper

protected

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

Referenced by __construct().

$request

RequestInterface ilDAVContainer::$request

protected

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

Referenced by __construct().

---

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

• Services/WebDAV/classes/dav/class.ilDAVContainer.php