ilWebDAVLocksRepository Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilWebDAVLocksRepository:

Public Member Functions
	__construct (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)

Protected Attributes
ilDBInterface	$db

Private Attributes
string	$lock_table = 'dav_lock'

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

(

ilDBInterface

$db

)

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

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

checkIfLockExistsInDB()

ilWebDAVLocksRepository::checkIfLockExistsInDB

(

string

$token

)

Definition at line 36 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);
        if (isset($row)) {
            return true;
        }
        return false;
    }

getLockObjectWithObjIdFromDB()

ilWebDAVLocksRepository::getLockObjectWithObjIdFromDB

(

int

$obj_id

)

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

References $query.

                                                             : ?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 49 of file class.ilWebDAVLocksRepository.php.

References $query.

                                                               : ?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 117 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 112 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 98 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, array(
            'token' => array('text', $ilias_lock->getToken()),
            'obj_id' => array('integer', $ilias_lock->getObjId()),
            'ilias_owner' => array('integer', $ilias_lock->getIliasOwner()),
            'dav_owner' => array('text', $ilias_lock->getDavOwner()),
            'expires' => array('integer', $ilias_lock->getExpires()),
            'depth' => array('integer', $ilias_lock->getDepth()),
            'type' => array('text', $ilias_lock->getType()),
            'scope' => array('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 122 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

$db

ilDBInterface ilWebDAVLocksRepository::$db

protected

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

Referenced by __construct().

$lock_table

string ilWebDAVLocksRepository::$lock_table = 'dav_lock'

private

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

---

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

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