dav/SabreDAV/lib/Sabre/DAV/PartialUpdate/IFile.php

   1 <?php
   2
   3 /**
   4  * This interface provides a way to modify only part of a target resource
   5  * It may be used to update a file chunk, upload big a file into smaller
   6  * chunks or resume an upload
   7  *
   8  * @package Sabre
   9  * @subpackage DAV
  10  * @copyright Copyright (C) 2007-2012 Rooftop Solutions. All rights reserved.
  11  * @author Jean-Tiare LE BIGOT (http://www.jtlebi.fr/)
  12  * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
  13  */
  14 interface Sabre_DAV_PartialUpdate_IFile extends Sabre_DAV_IFile {
  15
  16     /**
  17      * Updates the data at a given offset
  18      *
  19      * The data argument is a readable stream resource.
  20      * The offset argument is an integer describing the offset. Contrary to
  21      * what's sent in the request, the offset here is a 0-based index.
  22      *
  23      * After a successful put operation, you may choose to return an ETag. The
  24      * etag must always be surrounded by double-quotes. These quotes must
  25      * appear in the actual string you're returning.
  26      *
  27      * Clients may use the ETag from a PUT request to later on make sure that
  28      * when they update the file, the contents haven't changed in the mean
  29      * time.
  30      *
  31      * @param resource $data
  32      * @param integer $offset
  33      * @return string|null
  34      */
  35     function putRange($data, $offset);
  36
  37 }
  38