dav/SabreDAV/lib/Sabre/DAV/Locks/LockInfo.php

   1 <?php
   2
   3 /**
   4  * LockInfo class
   5  *
   6  * An object of the LockInfo class holds all the information relevant to a
   7  * single lock.
   8  *
   9  * @package Sabre
  10  * @subpackage DAV
  11  * @copyright Copyright (C) 2007-2012 Rooftop Solutions. All rights reserved.
  12  * @author Evert Pot (http://www.rooftopsolutions.nl/)
  13  * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
  14  */
  15 class Sabre_DAV_Locks_LockInfo {
  16
  17     /**
  18      * A shared lock
  19      */
  20     const SHARED = 1;
  21
  22     /**
  23      * An exclusive lock
  24      */
  25     const EXCLUSIVE = 2;
  26
  27     /**
  28      * A never expiring timeout
  29      */
  30     const TIMEOUT_INFINITE = -1;
  31
  32     /**
  33      * The owner of the lock
  34      *
  35      * @var string
  36      */
  37     public $owner;
  38
  39     /**
  40      * The locktoken
  41      *
  42      * @var string
  43      */
  44     public $token;
  45
  46     /**
  47      * How long till the lock is expiring
  48      *
  49      * @var int
  50      */
  51     public $timeout;
  52
  53     /**
  54      * UNIX Timestamp of when this lock was created
  55      *
  56      * @var int
  57      */
  58     public $created;
  59
  60     /**
  61      * Exclusive or shared lock
  62      *
  63      * @var int
  64      */
  65     public $scope = self::EXCLUSIVE;
  66
  67     /**
  68      * Depth of lock, can be 0 or Sabre_DAV_Server::DEPTH_INFINITY
  69      */
  70     public $depth = 0;
  71
  72     /**
  73      * The uri this lock locks
  74      *
  75      * TODO: This value is not always set
  76      * @var mixed
  77      */
  78     public $uri;
  79
  80 }
  81