ILIAS\WebDAV\Lock\CacheBackend Class Reference

Inheritance diagram for ILIAS\WebDAV\Lock\CacheBackend:

Collaboration diagram for ILIAS\WebDAV\Lock\CacheBackend:

Public Member Functions
	__construct (private Factory $entity_factory)
	getContainerKey ()
	isForced ()
	getLocks ($uri, $returnChildLocks)
	lock ($uri, LockInfo $lockInfo)
	unlock ($uri, LockInfo $lockInfo)
	getContainerKey ()
	isForced ()

Private Member Functions
	key (string $uri)
	asArray (LockInfo $lockInfo)
	asLockInfo (array $item)

Private Attributes
Container	$cache
Transformation	$raw

Detailed Description

Author

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

Definition at line 36 of file CacheBackend.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WebDAV\Lock\CacheBackend::__construct

(

private Factory

$entity_factory

)

Definition at line 42 of file CacheBackend.php.

      {
        global $DIC;
        $this->cache = $DIC->globalCache()->get($this);
        $this->cache->flush();
        $this->raw = new class () implements Transformation {
            use DeriveApplyToFromTransform;
            use DeriveInvokeFromTransform;
 
            public function transform($from)
            {
                return $from;
            }
 
        };
    }

References $DIC, ILIAS\Repository\raw(), and ILIAS\Refinery\transform().

Here is the call graph for this function:

Member Function Documentation

asArray()

ILIAS\WebDAV\Lock\CacheBackend::asArray ( LockInfo  $lockInfo )

private

Definition at line 94 of file CacheBackend.php.

                                                : array
    {
        return [
            'owner' => $lockInfo->owner,
            'token' => $lockInfo->token,
            'scope' => $lockInfo->scope,
            'depth' => $lockInfo->depth,
            'timeout' => $lockInfo->timeout,
            'uri' => $lockInfo->uri,
            'created' => $lockInfo->created,
        ];
    }

Referenced by ILIAS\WebDAV\Lock\CacheBackend\lock().

Here is the caller graph for this function:

asLockInfo()

ILIAS\WebDAV\Lock\CacheBackend::asLockInfo ( array  $item )

private

Definition at line 107 of file CacheBackend.php.

                                            : LockInfo
    {
        $lock = new LockInfo();
        $lock->owner = $item['owner'];
        $lock->token = $item['token'];
        $lock->scope = $item['scope'];
        $lock->depth = $item['depth'];
        $lock->timeout = $item['timeout'];
        $lock->uri = $item['uri'];
        $lock->created = $item['created'];
 
        return $lock;
    }

Referenced by ILIAS\WebDAV\Lock\CacheBackend\getLocks().

Here is the caller graph for this function:

getContainerKey()

ILIAS\WebDAV\Lock\CacheBackend::getContainerKey

(

)

Implements ILIAS\Cache\Container\Request.

Definition at line 60 of file CacheBackend.php.

                                     : string
    {
        return 'webdav:locks';
    }

getLocks()

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

Definition at line 75 of file CacheBackend.php.

                                                     : array
    {
        $key = $this->key($uri);
        if ($key === null) {
            return [];
        }
 
        if (!$this->cache->has($key)) {
            return [];
        }
 
        $locks = [];
        foreach ($this->cache->get($key, $this->raw) as $item) {
            $locks[] = $this->asLockInfo($item);
        }
 
        return $locks;
    }

References ILIAS\WebDAV\Lock\CacheBackend\asLockInfo(), and ILIAS\WebDAV\Lock\CacheBackend\key().

Here is the call graph for this function:

isForced()

ILIAS\WebDAV\Lock\CacheBackend::isForced

(

)

Implements ILIAS\Cache\Container\Request.

Definition at line 65 of file CacheBackend.php.

                              : bool
    {
        return true;
    }

key()

ILIAS\WebDAV\Lock\CacheBackend::key ( string  $uri )

private

Definition at line 70 of file CacheBackend.php.

                                     : string
    {
        return 'locks:' . md5($uri);
    }

Referenced by ILIAS\WebDAV\Lock\CacheBackend\getLocks(), ILIAS\WebDAV\Lock\CacheBackend\lock(), and ILIAS\WebDAV\Lock\CacheBackend\unlock().

Here is the caller graph for this function:

lock()

ILIAS\WebDAV\Lock\CacheBackend::lock	(		$uri,
		LockInfo	$lockInfo
	)

Definition at line 121 of file CacheBackend.php.

                                                  : bool
    {
        $key = $this->key($uri);
 
        $locks = $this->cache->get($key, $this->raw) ?? [];
 
        $lock = new LockInfo();
        $lock->owner = $lockInfo->owner;
        $lock->token = $lockInfo->token;
        $lock->scope = LockInfo::EXCLUSIVE;
        $lock->depth = $lockInfo->depth;
        $lock->timeout = $lockInfo->timeout;
        $lock->uri = $uri;
        $lock->created = $lockInfo->created ?? time();
 
        $locks[] = $this->asArray($lock);
 
        $this->cache->set($key, $locks);
 
        return true;
    }

References ILIAS\WebDAV\Lock\CacheBackend\asArray(), ILIAS\WebDAV\Lock\CacheBackend\key(), and ILIAS\Repository\raw().

Here is the call graph for this function:

unlock()

ILIAS\WebDAV\Lock\CacheBackend::unlock	(		$uri,
		LockInfo	$lockInfo
	)

Definition at line 143 of file CacheBackend.php.

                                                    : bool
    {
        $key = $this->key($uri);
        if ($key === null) {
            return false;
        }
        $this->cache->set($key, []);
 
        $entity = $this->entity_factory->getByFullPath($uri);
        $proxy = $entity?->getObjectProxy();
        if ($proxy !== null && $proxy->getType() === Type::FILE) {
            $proxy->getStreamHandler()->publish();
        }
 
        return true;
    }

References ILIAS\WebDAV\Lock\CacheBackend\key().

Here is the call graph for this function:

Field Documentation

$cache

Container ILIAS\WebDAV\Lock\CacheBackend::$cache

private

Definition at line 38 of file CacheBackend.php.

$raw

Transformation ILIAS\WebDAV\Lock\CacheBackend::$raw

private

Definition at line 40 of file CacheBackend.php.

---

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

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