ilWebDAVLocksRepository Class Reference

Collaboration diagram for ilWebDAVLocksRepository:

Public Member Functions
	__construct (protected ilDBInterface $db)
	checkIfLockExistsInDB (string $token)
	getLockObjectWithTokenFromDB (string $token)
	getLockObjectWithObjIdFromDB (int $obj_id)
	saveLockToDB (ilWebDAVLockObject $ilias_lock)
	removeLockWithTokenFromDB (string $token)
	purgeExpiredLocksFromDB ()
	updateLocks (int $old_obj_id, int $new_obj_id)

Private Attributes
string	$lock_table = 'dav_lock'

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilWebDAVLocksRepository::__construct

(

protected ilDBInterface

$db

)

Definition at line 29 of file class.ilWebDAVLocksRepository.php.

    {
    }

Member Function Documentation

checkIfLockExistsInDB()

ilWebDAVLocksRepository::checkIfLockExistsInDB

(

string

$token

)

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

                                                        : bool
    {
        $select_query = "SELECT SELECT EXISTS(SELECT 1 FROM $this->lock_table WHERE token = " .
            $this->db->quote($token, 'text') . ") AS count";
        $select_result = $this->db->query($select_query);
        $select_result->numRows();
        $row = $this->db->fetchAssoc($select_result);
        return isset($row);
    }

getLockObjectWithObjIdFromDB()

ilWebDAVLocksRepository::getLockObjectWithObjIdFromDB

(

int

$obj_id

)

Definition at line 68 of file class.ilWebDAVLocksRepository.php.

                                                             : ?ilWebDAVLockObject
    {
        $query = "SELECT token, ilias_owner, dav_owner, expires, depth, type, scope FROM $this->lock_table WHERE obj_id = "
            . $this->db->quote($obj_id, 'integer')
            . " AND expires > " . $this->db->quote(time(), 'integer');
        $select_result = $this->db->query($query);
        $row = $this->db->fetchAssoc($select_result);

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

        return null;
    }

getLockObjectWithTokenFromDB()

ilWebDAVLocksRepository::getLockObjectWithTokenFromDB

(

string

$token

)

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

                                                               : ?ilWebDAVLockObject
    {
        $query = "SELECT obj_id, ilias_owner, dav_owner, expires, depth, type, scope FROM $this->lock_table"
            . " WHERE token = " . $this->db->quote($token, 'text')
            . " AND expires > " . $this->db->quote(time(), 'integer');

        $select_result = $this->db->query($query);
        $row = $this->db->fetchAssoc($select_result);

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

        return null;
    }

purgeExpiredLocksFromDB()

ilWebDAVLocksRepository::purgeExpiredLocksFromDB

(

)

Definition at line 113 of file class.ilWebDAVLocksRepository.php.

                                             : int
    {
        return $this->db->manipulate(
            "DELETE FROM $this->lock_table WHERE expires < " . $this->db->quote(time(), 'integer')
        );
    }

removeLockWithTokenFromDB()

ilWebDAVLocksRepository::removeLockWithTokenFromDB

(

string

$token

)

Definition at line 106 of file class.ilWebDAVLocksRepository.php.

                                                            : int
    {
        return $this->db->manipulate(
            "DELETE FROM $this->lock_table WHERE token = " . $this->db->quote($token, "integer")
        );
    }

saveLockToDB()

ilWebDAVLocksRepository::saveLockToDB

(

ilWebDAVLockObject

$ilias_lock

)

Definition at line 92 of file class.ilWebDAVLocksRepository.php.

References ilWebDAVLockObject\getDavOwner(), ilWebDAVLockObject\getDepth(), ilWebDAVLockObject\getExpires(), ilWebDAVLockObject\getIliasOwner(), ilWebDAVLockObject\getObjId(), ilWebDAVLockObject\getScope(), ilWebDAVLockObject\getToken(), and ilWebDAVLockObject\getType().

                                                                : void
    {
        $this->db->insert($this->lock_table, [
            'token' => ['text', $ilias_lock->getToken()],
            'obj_id' => ['integer', $ilias_lock->getObjId()],
            'ilias_owner' => ['integer', $ilias_lock->getIliasOwner()],
            'dav_owner' => ['text', $ilias_lock->getDavOwner()],
            'expires' => ['integer', $ilias_lock->getExpires()],
            'depth' => ['integer', $ilias_lock->getDepth()],
            'type' => ['text', $ilias_lock->getType()],
            'scope' => ['integer', $ilias_lock->getScope()]
        ]);
    }

Here is the call graph for this function:

updateLocks()

ilWebDAVLocksRepository::updateLocks	(	int	$old_obj_id,
		int	$new_obj_id
	)

Definition at line 120 of file class.ilWebDAVLocksRepository.php.

                                                                 : int
    {
        return $this->db->update(
            $this->lock_table,
            ["obj_id" => ["integer", $new_obj_id]],
            ["obj_id" => ["integer", $old_obj_id]]
        );
    }

Field Documentation

$lock_table

string ilWebDAVLocksRepository::$lock_table = 'dav_lock'

private

Definition at line 27 of file class.ilWebDAVLocksRepository.php.

---

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

• components/ILIAS/WebDAV/classes/lock/class.ilWebDAVLocksRepository.php