ilWebDAVLocksBackend Class Reference

Inheritance diagram for ilWebDAVLocksBackend:

Collaboration diagram for ilWebDAVLocksBackend:

Public Member Functions
	__construct (ilWebDAVLocksRepository $wedav_locks_repository, ilWebDAVRepositoryHelper $webdav_repository_helper, ilWebDAVObjFactory $webdav_object_factory, ilWebDAVLockUriPathResolver $webdav_path_resolver, ilObjUser $user)
	getLocks ($uri, $returnChildLocks)
	unlock ($uri, LockInfo $lockInfo)
	lock ($uri, LockInfo $lock_info)
	getLocksOnObjectId (int $obj_id)

Protected Member Functions
	getLocksRecursive (array $sabre_locks, int $ref_id, string $uri)

Protected Attributes
ilWebDAVLocksRepository	$wedav_locks_repository
ilWebDAVRepositoryHelper	$webdav_repository_helper
ilWebDAVObjFactory	$webdav_object_factory
ilWebDAVLockUriPathResolver	$webdav_path_resolver
ilObjUser	$user

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.ilWebDAVLocksBackend.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVLocksBackend::__construct	(	ilWebDAVLocksRepository	$wedav_locks_repository,
		ilWebDAVRepositoryHelper	$webdav_repository_helper,
		ilWebDAVObjFactory	$webdav_object_factory,
		ilWebDAVLockUriPathResolver	$webdav_path_resolver,
		ilObjUser	$user
	)

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

      {
        $this->wedav_locks_repository = $wedav_locks_repository;
        $this->webdav_repository_helper = $webdav_repository_helper;
        $this->webdav_object_factory = $webdav_object_factory;
        $this->webdav_path_resolver = $webdav_path_resolver;
        $this->user = $user;
    }

References $user, $webdav_object_factory, $webdav_path_resolver, $webdav_repository_helper, $wedav_locks_repository, and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

getLocks()

ilWebDAVLocksBackend::getLocks	(		$uri,
			$returnChildLocks
	)

Parameters

string	$uri
bool	$returnChildLocks

Returns

LockInfo[]

Definition at line 56 of file class.ilWebDAVLocksBackend.php.

                                                     : array
    {
        $sabre_locks = [];
 
        try {
            $ref_id = $this->webdav_path_resolver->getRefIdForWebDAVPath($uri);
 
            $obj_id = $this->webdav_repository_helper->getObjectIdFromRefId($ref_id);
            $lock_on_obj = $this->getLocksOnObjectId($obj_id);
 
            if (!is_null($lock_on_obj)) {
                $sabre_locks[] = $lock_on_obj->getAsSabreDavLock($uri);
            }
 
            if ($returnChildLocks) {
                $sabre_locks = $this->getLocksRecursive($sabre_locks, $ref_id, $uri);
            }
        } catch (Exception\NotFound $e) {
        }
 
        return $sabre_locks;
    }

References Vendor\Package\$e, $ref_id, getLocksOnObjectId(), and getLocksRecursive().

Here is the call graph for this function:

getLocksOnObjectId()

ilWebDAVLocksBackend::getLocksOnObjectId

(

int

$obj_id

)

Definition at line 155 of file class.ilWebDAVLocksBackend.php.

                                                   : ?ilWebDAVLockObject
    {
        try {
            return $this->wedav_locks_repository->getLockObjectWithObjIdFromDB($obj_id);
        } catch (Exception $e) {
        }
    }

References Vendor\Package\$e.

Referenced by getLocks(), and getLocksRecursive().

Here is the caller graph for this function:

getLocksRecursive()

ilWebDAVLocksBackend::getLocksRecursive ( array  $sabre_locks, int  $ref_id, string  $uri  )

protected

Parameters

LockInfo[]

$sabre_locks

Returns

LockInfo[]

Definition at line 83 of file class.ilWebDAVLocksBackend.php.

                                                                                      : array
    {
        foreach ($this->webdav_repository_helper->getChildrenOfRefId($ref_id) as $child_ref) {
            try {
                $child_obj_id = $this->webdav_repository_helper->getObjectIdFromRefId($child_ref);
                $child_obj = $this->webdav_object_factory->retrieveDAVObjectByRefID($child_ref);
 
                $child_ilias_lock = $this->getLocksOnObjectId($child_obj_id);
                if (!is_null($child_ilias_lock)) {
                    $sabre_locks[] = $child_ilias_lock->getAsSabreDavLock($uri . '/' . $child_obj->getName());
                }
 
                $sabre_locks = $this->getLocksRecursive($sabre_locks, $child_ref, $uri . $child_obj->getName() . '/');
            } catch (ilWebDAVNotDavableException | NotFound | RuntimeException $e) {
            }
        }
 
        return $sabre_locks;
    }

References Vendor\Package\$e, $ref_id, getLocksOnObjectId(), and getLocksRecursive().

Referenced by getLocks(), and getLocksRecursive().

Here is the call graph for this function:

Here is the caller graph for this function:

lock()

ilWebDAVLocksBackend::lock	(		$uri,
		LockInfo	$lock_info
	)

See also

\Sabre\DAV\Locks\Backend\BackendInterface::lock()

Definition at line 124 of file class.ilWebDAVLocksBackend.php.

                                                   : bool
    {
        try {
            $ref_id = $this->webdav_path_resolver->getRefIdForWebDAVPath($uri);
 
            if ($ref_id > 0 && $this->webdav_repository_helper->checkAccess('write', $ref_id)) {
                $obj_id = $this->webdav_repository_helper->getObjectIdFromRefId($ref_id);
                $ilias_lock = new ilWebDAVLockObject(
                    $lock_info->token,
                    $obj_id,
                    $this->user->getId(),
                    $lock_info->owner,
                    time() + 360,
                    $lock_info->depth,
                    'w',
                    $lock_info->scope
                );
                $this->wedav_locks_repository->saveLockToDB($ilias_lock);
                return true;
            } else {
                throw new Exception\Forbidden();
            }
        } catch (Exception\NotFound $e) {
            if ($e->getCode() == -1) {
                return false;
            } else {
                throw $e;
            }
        }
    }

References Vendor\Package\$e, and $ref_id.

unlock()

ilWebDAVLocksBackend::unlock	(		$uri,
		LockInfo	$lockInfo
	)

See also

\Sabre\DAV\Locks\Backend\BackendInterface::unlock()

Definition at line 107 of file class.ilWebDAVLocksBackend.php.

                                                    : bool
    {
        $ilias_lock = $this->wedav_locks_repository->getLockObjectWithTokenFromDB($lockInfo->token);
 
        if (!is_null($ilias_lock) && $ilias_lock->getIliasOwner() == $this->user->getId()) {
            $this->wedav_locks_repository->removeLockWithTokenFromDB($lockInfo->token);
            return true;
        } else {
            throw new Exception\Forbidden();
        }
    }

Field Documentation

$user

ilObjUser ilWebDAVLocksBackend::$user

protected

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

Referenced by __construct().

$webdav_object_factory

ilWebDAVObjFactory ilWebDAVLocksBackend::$webdav_object_factory

protected

Definition at line 33 of file class.ilWebDAVLocksBackend.php.

Referenced by __construct().

$webdav_path_resolver

ilWebDAVLockUriPathResolver ilWebDAVLocksBackend::$webdav_path_resolver

protected

Definition at line 34 of file class.ilWebDAVLocksBackend.php.

Referenced by __construct().

$webdav_repository_helper

ilWebDAVRepositoryHelper ilWebDAVLocksBackend::$webdav_repository_helper

protected

Definition at line 32 of file class.ilWebDAVLocksBackend.php.

Referenced by __construct().

$wedav_locks_repository

ilWebDAVLocksRepository ilWebDAVLocksBackend::$wedav_locks_repository

protected

Definition at line 31 of file class.ilWebDAVLocksBackend.php.

Referenced by __construct().

---

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

• Services/WebDAV/classes/lock/class.ilWebDAVLocksBackend.php