Class: Sabre_DAV_Locks_Backend_FS

Source Location: /includes/classes/SabreDAV/lib/Sabre/DAV/Locks/Backend/FS.php

Class Overview [line 15]

Sabre_DAV_Locks_Backend_Abstract
   |
   --Sabre_DAV_Locks_Backend_FS

The Lock manager allows you to handle all file-locks centrally.

Author(s):

  • Evert Pot (http://www.rooftopsolutions.nl/)

Version:

Copyright:

  • Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

The Lock manager allows you to handle all file-locks centrally.

This Lock Manager stores all its data in the filesystem. By default it will do this in PHP's standard temporary session directory, but this can be overriden by specifiying an alternative path in the contructor

Tags:

[ Top ]


Class Variables


Class Methods

__construct

Sabre_DAV_Locks_Backend_FS __construct( $dataDir)

[line 24]

Tags:

  • access - public

Parameters:

  • $dataDir -

[ Top ]

getData

array getData( string $uri)

[line 132]

Returns the stored data for a uri

Tags:

  • access - protected

Parameters:

  • string $uri -

[ Top ]

getFileNameForUri

void getFileNameForUri( $uri)

[line 30]

Tags:

  • access - protected

Parameters:

  • $uri -

[ Top ]

getLocks

array getLocks( string $uri)

[line 46]

Returns a list of Sabre_DAV_Locks_LockInfo objects

This method should return all the locks for a particular uri, including locks that might be set on a parent uri.

Tags:

  • access - public

Overrides Sabre_DAV_Locks_Backend_Abstract::getLocks() (Returns a list of Sabre_DAV_Locks_LockInfo objects)

Parameters:

  • string $uri -

[ Top ]

lock

bool lock( string $uri, Sabre_DAV_Locks_LockInfo $lockInfo)

[line 86]

Locks a uri

Tags:

  • access - public

Overrides Sabre_DAV_Locks_Backend_Abstract::lock() (Locks a uri)

Parameters:

[ Top ]

putData

void putData( string $uri, $newData)

[line 164]

Updates the lock information

Tags:

  • access - protected

Parameters:

  • string $uri -
  • array $newData -

[ Top ]

unlock

bool unlock( string $uri, Sabre_DAV_Locks_LockInfo $lockInfo)

[line 109]

Removes a lock from a uri

Tags:

  • access - public

Overrides Sabre_DAV_Locks_Backend_Abstract::unlock() (Removes a lock from a uri)

Parameters:

[ Top ]


Class Constants


Documentation generated on Mon, 31 May 2010 12:53:21 -0400 by phpDocumentor 1.4.3