ilWebDAVObjFactory Class Reference

Collaboration diagram for ilWebDAVObjFactory:

Public Member Functions
	__construct (protected ilWebDAVRepositoryHelper $repository_helper, protected ilObjUser $current_user, protected Services $resource_storage, protected RequestInterface $request, protected ilLanguage $language, protected string $client_id, protected bool $versioning_enabled)
	retrieveDAVObjectByRefID (int $ref_id)
	createDAVObject (ilObject $ilias_object, int $parent_ref_id)
	getProblemInfoFile (int $container_ref_id)
	getMountPoint ()
	getClientNode (string $name)

Protected Member Functions
	checkReadAndVisibleAccessForObj (int $child_ref)

Protected Attributes
array	$_cache = []

Private Attributes
array	$davable_object_types

Detailed Description

Author

Stephan Winiker steph.nosp@m.an.w.nosp@m.inike.nosp@m.r@hs.nosp@m.lu.ch

Definition at line 30 of file class.ilWebDAVObjFactory.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVObjFactory::__construct	(	protected ilWebDAVRepositoryHelper	$repository_helper,
		protected ilObjUser	$current_user,
		protected Services	$resource_storage,
		protected RequestInterface	$request,
		protected ilLanguage	$language,
		protected string	$client_id,
		protected bool	$versioning_enabled
	)

Definition at line 47 of file class.ilWebDAVObjFactory.php.

      {
    }

Member Function Documentation

checkReadAndVisibleAccessForObj()

ilWebDAVObjFactory::checkReadAndVisibleAccessForObj ( int  $child_ref )

protected

Definition at line 167 of file class.ilWebDAVObjFactory.php.

Referenced by retrieveDAVObjectByRefID().

                                                                      : bool
    {
        return $this->repository_helper->checkAccess("visible", $child_ref) && $this->repository_helper->checkAccess(
            "read",
            $child_ref
        );
    }

Here is the caller graph for this function:

createDAVObject()

ilWebDAVObjFactory::createDAVObject	(	ilObject	$ilias_object,
		int	$parent_ref_id
	)

Definition at line 108 of file class.ilWebDAVObjFactory.php.

References $ref_id, ilObject\create(), ilObject\createReference(), ilObject\getRefId(), ilObject\getTitle(), ilObject\getType(), ilWebDAVNotDavableException\OBJECT_TITLE_NOT_DAVABLE, ilObject\putInTree(), and ilObject\setPermissions().

                                                                               : INode
    {
        if (!$this->isDAVableObjTitle($ilias_object->getTitle())) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE);
        }

        if ($ilias_object->getType() === 'file' &&
            !$this->hasValidFileExtension($ilias_object->getTitle())) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE);
        }

        if ($ilias_object->getRefId() === 0) {
            $ilias_object->create();
            $ilias_object->createReference();
            $ilias_object->putInTree($parent_ref_id);
            $ilias_object->setPermissions($parent_ref_id);
        }

        $ref_id = $ilias_object->getRefId();

        if ($ilias_object->getType() === 'file') {
            return $this->_cache[$ref_id] = new ilDAVFile(
                $ilias_object,
                $this->repository_helper,
                $this->resource_storage,
                $this->request,
                $this,
                $this->versioning_enabled
            );
        }

        return $this->_cache[$ref_id] = new ilDAVContainer(
            $ilias_object,
            $this->current_user,
            $this->request,
            $this,
            $this->repository_helper
        );
    }

Here is the call graph for this function:

getClientNode()

ilWebDAVObjFactory::getClientNode

(

string

$name

)

Definition at line 158 of file class.ilWebDAVObjFactory.php.

                                               : ilDAVClientNode
    {
        if ($name !== $this->client_id) {
            throw new NotFound();
        }

        return new ilDAVClientNode($this->client_id, $this, $this->repository_helper);
    }

getMountPoint()

ilWebDAVObjFactory::getMountPoint

(

)

Definition at line 153 of file class.ilWebDAVObjFactory.php.

                                   : ilDAVMountPoint
    {
        return new ilDAVMountPoint($this->client_id, $this, $this->repository_helper, $this->current_user);
    }

getProblemInfoFile()

ilWebDAVObjFactory::getProblemInfoFile

(

int

$container_ref_id

)

Definition at line 148 of file class.ilWebDAVObjFactory.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                                             : ilDAVProblemInfoFile
    {
        return new ilDAVProblemInfoFile($container_ref_id, $this->repository_helper, $this, $this->language);
    }

Here is the call graph for this function:

retrieveDAVObjectByRefID()

ilWebDAVObjFactory::retrieveDAVObjectByRefID

(

int

$ref_id

)

Definition at line 58 of file class.ilWebDAVObjFactory.php.

References $ref_id, checkReadAndVisibleAccessForObj(), ilObjectFactory\getInstanceByRefId(), null, ilWebDAVNotDavableException\OBJECT_HIDDEN, ilWebDAVNotDavableException\OBJECT_TITLE_NOT_DAVABLE, and ilWebDAVNotDavableException\OBJECT_TYPE_NOT_DAVABLE.

                                                         : INode
    {
        if (!$this->checkReadAndVisibleAccessForObj($ref_id)) {
            throw new Forbidden("No read permission for object with reference ID $ref_id");
        }

        if (isset($this->_cache[$ref_id])) {
            return $this->_cache[$ref_id];
        }

        $ilias_object = ilObjectFactory::getInstanceByRefId($ref_id);

        if ($ilias_object === null) {
            throw new NotFound();
        }

        $ilias_object_type = $ilias_object->getType();

        if (!in_array($ilias_object_type, $this->davable_object_types)) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TYPE_NOT_DAVABLE);
        }

        if ($this->isHiddenFile($ilias_object->getTitle())) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_HIDDEN);
        }

        if ($this->hasTitleForbiddenChars($ilias_object->getTitle())) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE);
        }

        if ($ilias_object_type === 'file') {
            return $this->_cache[$ref_id] = new ilDAVFile(
                $ilias_object,
                $this->repository_helper,
                $this->resource_storage,
                $this->request,
                $this,
                $this->versioning_enabled
            );
        }

        return $this->_cache[$ref_id] = new ilDAVContainer(
            $ilias_object,
            $this->current_user,
            $this->request,
            $this,
            $this->repository_helper
        );
    }

Here is the call graph for this function:

Field Documentation

$_cache

array ilWebDAVObjFactory::$_cache = []

protected

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

$davable_object_types

array ilWebDAVObjFactory::$davable_object_types

private

Initial value:

= [
        'cat',
        'crs',
        'fold',
        'file',
        'grp'
    ]

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

---

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

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