ILIAS\WebDAV\Lock\Backend Class Reference

Inheritance diagram for ILIAS\WebDAV\Lock\Backend:

Collaboration diagram for ILIAS\WebDAV\Lock\Backend:

Public Member Functions
	__construct (private Factory $entity_factory, private LocksRepository $locks_repository)
	getLocks ($uri, $returnChildLocks)
	lock ($uri, LockInfo $lock_info)
	unlock ($uri, LockInfo $lock_info)

Private Attributes
int	$user_id

Detailed Description

Author

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

Definition at line 31 of file Backend.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WebDAV\Lock\Backend::__construct	(	private Factory	$entity_factory,
		private LocksRepository	$locks_repository
	)

Definition at line 35 of file Backend.php.

      {
        global $DIC; // TODO remove Service Locator
        $this->user_id = $DIC->user()->getId();
    }

References $DIC.

Member Function Documentation

getLocks()

ILIAS\WebDAV\Lock\Backend::getLocks	(		$uri,
			$returnChildLocks
	)

Returns

LockInfo[]

Definition at line 46 of file Backend.php.

                                                     : array
    {
        $entity = $this->entity_factory->getByFullPath($uri);
        if ($entity === null) {
            return [];
        }
 
        $lock_object = $this->locks_repository->maybeGetLockFromObjId($entity->getObjectProxy()->getObjId());
        if ($lock_object === null) {
            return [];
        }
 
        return [
            $lock_object->getAsSabreDavLock($uri),
        ];
    }

lock()

ILIAS\WebDAV\Lock\Backend::lock	(		$uri,
		LockInfo	$lock_info
	)

Definition at line 63 of file Backend.php.

                                                   : bool
    {
        $entity = $this->entity_factory->getByFullPath($uri);
        $obj_id = $entity?->getObjectProxy()->getObjId();
        if ($obj_id === null) {
            return false;
        }
 
        $ilias_lock = new Lock(
            $lock_info->token,
            $obj_id,
            $this->user_id,
            $lock_info->owner,
            time() + 3600,
            $lock_info->depth,
            'w',
            $lock_info->scope
        );
        $this->locks_repository->save($ilias_lock);
 
        $proxy = $entity?->getObjectProxy();
        if ($proxy !== null && $proxy->getType() === Type::FILE) {
            $proxy->getStreamHandler()?->publish();
        }
        return true;
    }

unlock()

ILIAS\WebDAV\Lock\Backend::unlock	(		$uri,
		LockInfo	$lock_info
	)

Definition at line 90 of file Backend.php.

                                                     : bool
    {
        $ilias_lock = $this->locks_repository->maybeGetLockFromToken($lock_info->token);
 
        if ($ilias_lock !== null && $ilias_lock->getIliasOwner() === $this->user_id) {
            $this->locks_repository->remove($lock_info->token);
            return true;
        }
        return false;
    }

Field Documentation

$user_id

int ILIAS\WebDAV\Lock\Backend::$user_id

private

Definition at line 33 of file Backend.php.

---

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

• components/ILIAS/WebDAV/src/Lock/Backend.php