Represents a lock on an ilias object. More...

Collaboration diagram for ilWebDAVLockObject:

Public Member Functions
	__construct ($token, $obj_id, $ilias_owner, $dav_owner, $expires, $depth, $type, $scope)

	getToken ()

	getObjId ()

	getIliasOwner ()

	getDavOwner ()

	getExpires ()

	getDepth ()

	getType ()

	getScope ()

	getAsSabreDavLock ($uri)

Static Public Member Functions
static	createFromAssocArray ($assoc_array)

static	createFromSabreLock (Sabre\DAV\Locks\LockInfo $lock_info, $obj_id)
	Creates an ILIAS lock object from a sabreDAV lock object. More...

Protected Attributes
	$token

	$obj_id

	$ilias_owner

	$dav_owner

	$expires

	$depth

	$type

	$scope

Detailed Description

Represents a lock on an ilias object.

Objects from this class are immutable!

Author: Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch $Id$

Definition at line 12 of file class.ilWebDAVLockObject.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebDAVLockObject::__construct	(	$token,
		$obj_id,
		$ilias_owner,
		$dav_owner,
		$expires,
		$depth,
		$type,
		$scope
	)

Parameters

string	$token	example:
int	$obj_id	example: 1111
int	$ilias_owner	example: 2222
string	$dav_owner	example: 'Desktop\Raphi'
int	$expires	example: '795596280'
int	$depth	example: '-1'
string	$type	example: 'w'
string	$scope	example: 'x'

Definition at line 25 of file class.ilWebDAVLockObject.php.

    {
        $this->token = $token;
        $this->obj_id = $obj_id;
        $this->ilias_owner = $ilias_owner;
        $this->dav_owner = $dav_owner;
        $this->expires = $expires;
        $this->depth = $depth;
        $this->type = $type;
        $this->scope = $scope;
    }

References $dav_owner, $depth, $expires, $ilias_owner, $obj_id, $scope, $token, and $type.

Member Function Documentation

◆ createFromAssocArray()

static ilWebDAVLockObject::createFromAssocArray ( $assoc_array )

static

Definition at line 110 of file class.ilWebDAVLockObject.php.

    {
        return new ilWebDAVLockObject(
            $assoc_array['token'],
            $assoc_array['obj_id'],
            $assoc_array['ilias_owner'],
            $assoc_array['dav_owner'],
            $assoc_array['expires'],
            $assoc_array['depth'],
            $assoc_array['type'],
            $assoc_array['scope']
        );
    }

Referenced by ilWebDAVDBManager\getLockObjectWithObjIdFromDB(), and ilWebDAVDBManager\getLockObjectWithTokenFromDB().

Here is the caller graph for this function:

◆ createFromSabreLock()

static ilWebDAVLockObject::createFromSabreLock	(	Sabre\DAV\Locks\LockInfo	$lock_info,
			$obj_id
	)

static

Creates an ILIAS lock object from a sabreDAV lock object.

IMPORTANT: This method just creates and initializes an object. It does not create any record in the database!

Parameters

Sabre\DAV\Locks\LockInfo $lock_info

Definition at line 132 of file class.ilWebDAVLockObject.php.

    {
        global $DIC;
 
        $ilias_lock = new ilWebDAVLockObject(
            $lock_info->token,                  // token
            $obj_id,                            // obj_id
            $DIC->user()->getId(),              // ilias_owner
            $lock_info->owner,                  // dav_owner
            time() + 360,              // expires (hard coded like in the old webdav)
            $lock_info->depth,                  // depth
            'w',                          // type
            $lock_info->scope
        );                 // scope
            
        return $ilias_lock;
    }

References $DIC, and $obj_id.

Referenced by ilWebDAVLockBackend\lock().

Here is the caller graph for this function:

◆ getAsSabreDavLock()

ilWebDAVLockObject::getAsSabreDavLock ( $uri )

Definition at line 150 of file class.ilWebDAVLockObject.php.

    {
        global $DIC;
        
        $timestamp = time();
        
        $sabre_lock = new Sabre\DAV\Locks\LockInfo();
        $sabre_lock->created;
        $sabre_lock->depth = $this->depth;
        $sabre_lock->owner = $this->dav_owner;
        $sabre_lock->scope = $this->scope;
        $sabre_lock->timeout = $this->expires - $timestamp;
        $sabre_lock->created = $this->expires - 3600;
        $sabre_lock->token = $this->token;
        $sabre_lock->uri = $uri;
        
        return $sabre_lock;
    }

References $dav_owner, $depth, $DIC, $scope, $timestamp, and $token.

◆ getDavOwner()

ilWebDAVLockObject::getDavOwner ( )

Returns: string

Definition at line 73 of file class.ilWebDAVLockObject.php.

    {
        return $this->dav_owner;
    }

References $dav_owner.

Referenced by ilWebDAVDBManager\saveLockToDB().

Here is the caller graph for this function:

◆ getDepth()

ilWebDAVLockObject::getDepth ( )

Returns: int

Definition at line 89 of file class.ilWebDAVLockObject.php.

    {
        return $this->depth;
    }

References $depth.

Referenced by ilWebDAVDBManager\saveLockToDB().

Here is the caller graph for this function:

◆ getExpires()

ilWebDAVLockObject::getExpires ( )

Returns: int

Definition at line 81 of file class.ilWebDAVLockObject.php.

    {
        return $this->expires;
    }

References $expires.

Referenced by ilWebDAVDBManager\saveLockToDB().

Here is the caller graph for this function:

◆ getIliasOwner()

ilWebDAVLockObject::getIliasOwner ( )

Returns: int

Definition at line 65 of file class.ilWebDAVLockObject.php.

    {
        return $this->ilias_owner;
    }

References $ilias_owner.

Referenced by ilWebDAVDBManager\saveLockToDB().

Here is the caller graph for this function:

◆ getObjId()

ilWebDAVLockObject::getObjId ( )

Returns: int

Definition at line 57 of file class.ilWebDAVLockObject.php.

    {
        return $this->obj_id;
    }

References $obj_id.

Referenced by ilWebDAVDBManager\saveLockToDB().

Here is the caller graph for this function:

◆ getScope()

ilWebDAVLockObject::getScope ( )

Returns: string

Definition at line 105 of file class.ilWebDAVLockObject.php.

    {
        return $this->scope;
    }

References $scope.

Referenced by ilWebDAVDBManager\saveLockToDB().

Here is the caller graph for this function:

◆ getToken()

ilWebDAVLockObject::getToken ( )

Returns: string

Definition at line 49 of file class.ilWebDAVLockObject.php.

    {
        return $this->token;
    }

References $token.

Referenced by ilWebDAVDBManager\saveLockToDB().

Here is the caller graph for this function:

◆ getType()

ilWebDAVLockObject::getType ( )

Returns: string

Definition at line 97 of file class.ilWebDAVLockObject.php.

    {
        return $this->type;
    }

References $type.

Referenced by ilWebDAVDBManager\saveLockToDB().

Here is the caller graph for this function:

Field Documentation

◆ $dav_owner

ilWebDAVLockObject::$dav_owner

protected

Definition at line 40 of file class.ilWebDAVLockObject.php.

Referenced by __construct(), getAsSabreDavLock(), and getDavOwner().

◆ $depth

ilWebDAVLockObject::$depth

protected

Definition at line 42 of file class.ilWebDAVLockObject.php.

Referenced by __construct(), getAsSabreDavLock(), and getDepth().

◆ $expires

ilWebDAVLockObject::$expires

protected

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

Referenced by __construct(), and getExpires().

◆ $ilias_owner

ilWebDAVLockObject::$ilias_owner

protected

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

Referenced by __construct(), and getIliasOwner().

◆ $obj_id

ilWebDAVLockObject::$obj_id

protected

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

Referenced by __construct(), createFromSabreLock(), and getObjId().

◆ $scope

ilWebDAVLockObject::$scope

protected

Definition at line 44 of file class.ilWebDAVLockObject.php.

Referenced by __construct(), getAsSabreDavLock(), and getScope().

◆ $token

ilWebDAVLockObject::$token

protected

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

Referenced by __construct(), getAsSabreDavLock(), and getToken().

◆ $type

ilWebDAVLockObject::$type

protected

Definition at line 43 of file class.ilWebDAVLockObject.php.

Referenced by __construct(), and getType().

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

Services/WebDAV/classes/lock/class.ilWebDAVLockObject.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createFromAssocArray()

◆ createFromSabreLock()

◆ getAsSabreDavLock()

◆ getDavOwner()

◆ getDepth()

◆ getExpires()

◆ getIliasOwner()

◆ getObjId()

◆ getScope()

◆ getToken()

◆ getType()

Field Documentation

◆ $dav_owner

◆ $depth

◆ $expires

◆ $ilias_owner

◆ $obj_id

◆ $scope

◆ $token

◆ $type