ilWebDAVDBManager Class Reference

Class ilWebDAVDBManager. More...

Collaboration diagram for ilWebDAVDBManager:

Public Member Functions
	__construct ($db)
	checkIfLockExistsInDB ($token)
	getLockObjectWithTokenFromDB ($token)
	Returns lock Object from given tocken. More...
	getLockObjectWithObjIdFromDB ($obj_id)
	saveLockToDB (ilWebDAVLockObject $ilias_lock)
	removeLockWithTokenFromDB ($token)
	Removes one specific lock. More...
	purgeExpiredLocksFromDB ()
	Removes all locks from DB that are expired (expires < time()) More...

Protected Attributes
	$db

Private Attributes
	$lock_table = 'dav_lock'

Detailed Description

Class ilWebDAVDBManager.

According to the repository pattern, this class manages the DB actions from other WebDAV classes. At the moment, the only direct interaction between WebDAV and the DB is for the locking mechanism.

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.ilWebDAVDBManager.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVDBManager::__construct

(

$db

)

Definition at line 21 of file class.ilWebDAVDBManager.php.

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

checkIfLockExistsInDB()

ilWebDAVDBManager::checkIfLockExistsInDB

(

$token

)

Definition at line 26 of file class.ilWebDAVDBManager.php.

References $row, and PHPMailer\PHPMailer\$token.

    {
        $select_query = "SELECT count(*) AS cnt FROM $this->locks_table WHERE token = " . $this->db->quote($token, 'text');
        $select_result = $this->db->query($select_query);
        $row = $this->db->fetchAssoc($select_result);
        if (isset($row)) {
            return true;
        }
        return false;
    }

getLockObjectWithObjIdFromDB()

ilWebDAVDBManager::getLockObjectWithObjIdFromDB

(

$obj_id

)

Definition at line 58 of file class.ilWebDAVDBManager.php.

References $query, $row, and ilWebDAVLockObject\createFromAssocArray().

    {
        $query = "SELECT * 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 ilWebDAVLockObject::createFromAssocArray($row);
        }
        
        return false;
    }

Here is the call graph for this function:

getLockObjectWithTokenFromDB()

ilWebDAVDBManager::getLockObjectWithTokenFromDB

(

$token

)

Returns lock Object from given tocken.

Parameters

string

$token

Returns

ilWebDAVLockObject|boolean

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

References $query, $row, PHPMailer\PHPMailer\$token, and ilWebDAVLockObject\createFromAssocArray().

    {
        $query = "SELECT * 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 ilWebDAVLockObject::createFromAssocArray($row);
        }
        
        return false;
    }

Here is the call graph for this function:

purgeExpiredLocksFromDB()

ilWebDAVDBManager::purgeExpiredLocksFromDB

(

)

Removes all locks from DB that are expired (expires < time())

Returns

array with all affected locks

Definition at line 103 of file class.ilWebDAVDBManager.php.

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

removeLockWithTokenFromDB()

ilWebDAVDBManager::removeLockWithTokenFromDB

(

$token

)

Removes one specific lock.

Parameters

integer

$token

Returns

array with affected lock (if there was a lock)

Definition at line 93 of file class.ilWebDAVDBManager.php.

References PHPMailer\PHPMailer\$token.

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

saveLockToDB()

ilWebDAVDBManager::saveLockToDB

(

ilWebDAVLockObject

$ilias_lock

)

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

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

    {
        $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:

Field Documentation

$db

ilWebDAVDBManager::$db

protected

Definition at line 17 of file class.ilWebDAVDBManager.php.

Referenced by __construct().

$lock_table

ilWebDAVDBManager::$lock_table = 'dav_lock'

private

Definition at line 19 of file class.ilWebDAVDBManager.php.

---

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

• Services/WebDAV/classes/db/class.ilWebDAVDBManager.php