Sabre\DAV\File Class Reference

File class. More...

Inheritance diagram for Sabre\DAV\File:

Collaboration diagram for Sabre\DAV\File:

Public Member Functions
	put ($data)
	Replaces the contents of the file. More...
	get ()
	Returns the data. More...
	getSize ()
	Returns the size of the file, in bytes. More...
	getETag ()
	Returns the ETag for a file. More...
	getContentType ()
	Returns the mime-type for a file. More...
Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...
	delete ()
	Deletes the current node. More...
	setName ($name)
	Renames the node. More...
Public Member Functions inherited from Sabre\DAV\INode
	getName ()
	Returns the name of the node. More...

Detailed Description

File class.

This is a helper class, that should aid in getting file classes setup. Most of its methods are implemented, and throw permission denied exceptions

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

get()

Sabre\DAV\File::get

(

)

Returns the data.

This method may either return a string or a readable stream resource

Returns

mixed

Implements Sabre\DAV\IFile.

Definition at line 50 of file File.php.

                   {

        throw new Exception\Forbidden('Permission denied to read this file');

    }

getContentType()

Sabre\DAV\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 90 of file File.php.

                              {

        return null;

    }

getETag()

Sabre\DAV\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 77 of file File.php.

Referenced by Sabre\DAV\FSExt\File\patch(), and Sabre\DAV\FSExt\File\put().

                       {

        return null;

    }

Here is the caller graph for this function:

getSize()

Sabre\DAV\File::getSize

(

)

Returns the size of the file, in bytes.

Returns

int

Implements Sabre\DAV\IFile.

Definition at line 61 of file File.php.

                       {

        return 0;

    }

put()

Sabre\DAV\File::put

(

$data

)

Replaces the contents of the file.

The data argument is a readable stream resource.

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.

If you don't plan to store the file byte-by-byte, and you return a different object on a subsequent GET you are strongly recommended to not return an ETag, and just return null.

Parameters

string | resource

$data

Returns

string|null

Implements Sabre\DAV\IFile.

Definition at line 37 of file File.php.

Referenced by Sabre\DAV\Mock\File\__construct().

                        {

        throw new Exception\Forbidden('Permission denied to change data');

    }

Here is the caller graph for this function:

---

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

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