Sabre\DAV\FSExt\File Class Reference

File class. More...

Inheritance diagram for Sabre\DAV\FSExt\File:

Collaboration diagram for Sabre\DAV\FSExt\File:

Public Member Functions
	put ($data)
	Updates the data. More...
	patch ($data, $rangeType, $offset=null)
	Updates the file based on a range specification. More...
	get ()
	Returns the data. More...
	delete ()
	Delete the current file. More...
	getETag ()
	Returns the ETag for a file. More...
	getContentType ()
	Returns the mime-type for a file. More...
	getSize ()
	Returns the size of the file, in bytes. More...
Public Member Functions inherited from Sabre\DAV\FS\Node
	__construct ($path)
	Sets up the node, expects a full path name. More...
	getName ()
	Returns the name of the node. More...
	setName ($name)
	Renames the node. More...
	getLastModified ()
	Returns the last modification time, as a unix timestamp. More...

Additional Inherited Members
Protected Attributes inherited from Sabre\DAV\FS\Node
	$path

Detailed Description

File class.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 15 of file File.php.

Member Function Documentation

delete()

Sabre\DAV\FSExt\File::delete

(

)

Delete the current file.

Returns

bool

Implements Sabre\DAV\INode.

Definition at line 102 of file File.php.

                      {

        return unlink($this->path);

    }

get()

Sabre\DAV\FSExt\File::get

(

)

Returns the data.

Returns

resource

Implements Sabre\DAV\IFile.

Definition at line 91 of file File.php.

                   {

        return fopen($this->path, 'r');

    }

getContentType()

Sabre\DAV\FSExt\File::getContentType

(

)

Returns the mime-type for a file.

If null is returned, we'll assume application/octet-stream

Returns

string|null

Implements Sabre\DAV\IFile.

Definition at line 135 of file File.php.

                              {

        return null;

    }

getETag()

Sabre\DAV\FSExt\File::getETag

(

)

Returns the ETag for a file.

An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change. The ETag is an arbitrary string, but MUST be surrounded by double-quotes.

Return null if the ETag can not effectively be determined

Returns

string|null

Implements Sabre\DAV\IFile.

Definition at line 118 of file File.php.

                       {

        return '"' . sha1(
            fileinode($this->path) .
            filesize($this->path) .
            filemtime($this->path)
        ) . '"';

    }

getSize()

Sabre\DAV\FSExt\File::getSize

(

)

Returns the size of the file, in bytes.

Returns

int

Implements Sabre\DAV\IFile.

Definition at line 146 of file File.php.

                       {

        return filesize($this->path);

    }

patch()

Sabre\DAV\FSExt\File::patch	(		$data,
			$rangeType,
			$offset = null
	)

Updates the file based on a range specification.

The first argument is the data, which is either a readable stream resource or a string.

The second argument is the type of update we're doing. This is either:

• 1. append
• 2. update based on a start byte
• 3. update based on an end byte ; The third argument is the start or end byte.

After a successful put operation, you may choose to return an ETag. The ETAG must always be surrounded by double-quotes. These quotes must appear in the actual string you're returning.

Clients may use the ETag from a PUT request to later on make sure that when they update the file, the contents haven't changed in the mean time.

Parameters

resource | string	$data
int	$rangeType
int	$offset

Returns

string|null

Implements Sabre\DAV\PartialUpdate\IPatchSupport.

Definition at line 60 of file File.php.

References $data, $f, and Sabre\DAV\File\getETag().

                                                      {

        switch ($rangeType) {
            case 1 :
                $f = fopen($this->path, 'a');
                break;
            case 2 :
                $f = fopen($this->path, 'c');
                fseek($f, $offset);
                break;
            case 3 :
                $f = fopen($this->path, 'c');
                fseek($f, $offset, SEEK_END);
                break;
        }
        if (is_string($data)) {
            fwrite($f, $data);
        } else {
            stream_copy_to_stream($data, $f);
        }
        fclose($f);
        clearstatcache(true, $this->path);
        return $this->getETag();

    }

Here is the call graph for this function:

put()

Sabre\DAV\FSExt\File::put

(

$data

)

Updates the data.

Data is a readable stream resource.

Parameters

resource | string

$data

Returns

string

Implements Sabre\DAV\IFile.

Definition at line 25 of file File.php.

References $data, and Sabre\DAV\File\getETag().

                        {

        file_put_contents($this->path, $data);
        clearstatcache(true, $this->path);
        return $this->getETag();

    }

Here is the call graph for this function:

---

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

• libs/composer/vendor/sabre/dav/lib/DAV/FSExt/File.php