Inheritance diagram for Sabre\DAV\Mock\File:

Collaboration diagram for Sabre\DAV\Mock\File:

Public Member Functions
	__construct ($name, $contents, Collection $parent=null, $lastModified=-1)
	Creates the object. More...

	getName ()
	Returns the name of the node. More...

	setName ($name)
	Changes the name of the node. More...

	put ($data)
	Updates the data. More...

	get ()
	Returns the data. More...

	getETag ()
	Returns the ETag for a file. More...

	getSize ()
	Returns the size of the node, in bytes. More...

	delete ()
	Delete the node. More...

	getLastModified ()
	Returns the last modification time as a unix timestamp. More...

Public Member Functions inherited from Sabre\DAV\File
	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...

	getLastModified ()
	Returns the last modification time as a unix timestamp. More...

	delete ()
	Deletes the current node. More...

	setName ($name)
	Renames the node. More...

	delete ()
	Deleted the current node. 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...

	put ($data)
	Replaces the contents of the file. More...

	get ()
	Returns the data. More...

	getContentType ()
	Returns the mime-type for a file. More...

	getETag ()
	Returns the ETag for a file. More...

	getSize ()
	Returns the size of the node, in bytes. More...

Protected Attributes
	$name

	$contents

	$parent

	$lastModified

Detailed Description

Mock File.

See the Collection in this directory for more details.

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

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

Definition at line 16 of file File.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAV\Mock\File::__construct	(		$name,
			$contents,
		Collection	$parent = `null`,
			$lastModified = `-1`
	)

Creates the object.

Parameters

string	$name
resource	$contents
Collection	$parent
int	$lastModified

Returns: void

Definition at line 32 of file File.php.

                                                                                          {
 
        $this->name = $name;
        $this->put($contents);
        $this->parent = $parent;
 
        if ($lastModified === -1) {
            $lastModified = time();
        }
 
        $this->lastModified = $lastModified;
 
    }

References Sabre\DAV\Mock\File\$contents, Sabre\DAV\Mock\File\$lastModified, $name, Sabre\DAV\Mock\File\$parent, and Sabre\DAV\File\put().

Here is the call graph for this function:

Member Function Documentation

◆ delete()

Sabre\DAV\Mock\File::delete ( )

Delete the node.

Returns: void

Reimplemented from Sabre\DAV\Node.

Definition at line 145 of file File.php.

                      {
 
        $this->parent->deleteChild($this->name);
 
    }

◆ get()

Sabre\DAV\Mock\File::get ( )

Returns the data.

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

Returns: mixed

Reimplemented from Sabre\DAV\File.

Definition at line 108 of file File.php.

                   {
 
        return $this->contents;
 
    }

◆ getETag()

Sabre\DAV\Mock\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.

Return null if the ETag can not effectively be determined

Returns: void

Reimplemented from Sabre\DAV\File.

Definition at line 123 of file File.php.

                       {
 
        return '"' . md5($this->contents) . '"';
 
    }

◆ getLastModified()

Sabre\DAV\Mock\File::getLastModified ( )

Returns the last modification time as a unix timestamp.

If the information is not available, return null.

Returns: int

Reimplemented from Sabre\DAV\Node.

Definition at line 157 of file File.php.

                               {
 
        return $this->lastModified;
 
    }

◆ getName()

Sabre\DAV\Mock\File::getName ( )

Returns the name of the node.

This is used to generate the url.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 53 of file File.php.

                       {
 
        return $this->name;
 
    }

References $name.

◆ getSize()

Sabre\DAV\Mock\File::getSize ( )

Returns the size of the node, in bytes.

Returns: int

Reimplemented from Sabre\DAV\File.

Definition at line 134 of file File.php.

                       {
 
        return strlen($this->contents);
 
    }

◆ put()

Sabre\DAV\Mock\File::put ( $data )

Updates the data.

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

resource $data

Returns: string|null

Reimplemented from Sabre\DAV\File.

Definition at line 91 of file File.php.

                        {
 
        if (is_resource($data)) {
            $data = stream_get_contents($data);
        }
        $this->contents = $data;
        return '"' . md5($data) . '"';
 
    }

References $data.

◆ setName()

Sabre\DAV\Mock\File::setName ( $name )

Changes the name of the node.

Parameters

string $name

Returns: void

Reimplemented from Sabre\DAV\Node.

Definition at line 65 of file File.php.

                            {
 
        $this->name = $name;
 
    }

References $name.

Field Documentation

◆ $contents

Sabre\DAV\Mock\File::$contents

protected

Definition at line 19 of file File.php.

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

◆ $lastModified

Sabre\DAV\Mock\File::$lastModified

protected

Definition at line 21 of file File.php.

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

◆ $name

Sabre\DAV\Mock\File::$name

protected

Definition at line 18 of file File.php.

◆ $parent

Sabre\DAV\Mock\File::$parent

protected

Definition at line 20 of file File.php.

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

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

libs/composer/vendor/sabre/dav/tests/Sabre/DAV/Mock/File.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ get()

◆ getETag()

◆ getLastModified()

◆ getName()

◆ getSize()

◆ put()

◆ setName()

Field Documentation

◆ $contents

◆ $lastModified

◆ $name

◆ $parent