Sabre\DAV\FS\Directory Class Reference

Directory class. More...

Inheritance diagram for Sabre\DAV\FS\Directory:

Collaboration diagram for Sabre\DAV\FS\Directory:

Public Member Functions
	createFile ($name, $data=null)
	Creates a new file in the directory. More...
	createDirectory ($name)
	Creates a new subdirectory. More...
	getChild ($name)
	Returns a specific child node, referenced by its name. More...
	getChildren ()
	Returns an array with all the child nodes. More...
	childExists ($name)
	Checks if a child exists. More...
	delete ()
	Deletes all files in this directory, and then itself. More...
	getQuotaInfo ()
	Returns available diskspace information. 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

Directory 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 14 of file Directory.php.

Member Function Documentation

childExists()

Sabre\DAV\FS\Directory::childExists

(

$name

)

Checks if a child exists.

Parameters

string

$name

Returns

bool

Implements Sabre\DAV\ICollection.

Definition at line 118 of file Directory.php.

References $name, and Sabre\DAV\FS\Node\$path.

                                {

        $path = $this->path . '/' . $name;
        return file_exists($path);

    }

createDirectory()

Sabre\DAV\FS\Directory::createDirectory

(

$name

)

Creates a new subdirectory.

Parameters

string

$name

Returns

void

Implements Sabre\DAV\ICollection.

Definition at line 54 of file Directory.php.

References $name.

                                    {

        $newPath = $this->path . '/' . $name;
        mkdir($newPath);
        clearstatcache(true, $newPath);

    }

createFile()

Sabre\DAV\FS\Directory::createFile	(		$name,
			$data = null
	)

Creates a new file in the directory.

Data will either be supplied as a stream resource, or in certain cases as a string. Keep in mind that you may have to support either.

After successful creation of the file, you may choose to return the ETag of the new file here.

The returned ETag must be surrounded by double-quotes (The quotes should be part of the actual string).

If you cannot accurately determine the ETag, you should not return it. If you don't store the file exactly as-is (you're transforming it somehow) you should also not return an ETag.

This means that if a subsequent GET to this new file does not exactly return the same contents of what was submitted here, you are strongly recommended to omit the ETag.

Parameters

string	$name	Name of the file
resource | string	$data	Initial payload

Returns

null|string

Implements Sabre\DAV\ICollection.

Definition at line 40 of file Directory.php.

References $data, and $name.

                                             {

        $newPath = $this->path . '/' . $name;
        file_put_contents($newPath, $data);
        clearstatcache(true, $newPath);

    }

delete()

Sabre\DAV\FS\Directory::delete

(

)

Deletes all files in this directory, and then itself.

Returns

void

Implements Sabre\DAV\INode.

Definition at line 130 of file Directory.php.

References Sabre\DAV\FS\Directory\getChildren().

                      {

        foreach ($this->getChildren() as $child) $child->delete();
        rmdir($this->path);

    }

Here is the call graph for this function:

getChild()

Sabre\DAV\FS\Directory::getChild

(

$name

)

Returns a specific child node, referenced by its name.

This method must throw DAV if the node does not exist.

Parameters

string

$name

Exceptions

DAV

Implements Sabre\DAV\ICollection.

Definition at line 72 of file Directory.php.

References $name, and Sabre\DAV\FS\Node\$path.

Referenced by Sabre\DAV\FS\Directory\getChildren().

                             {

        $path = $this->path . '/' . $name;

        if (!file_exists($path)) throw new DAV\Exception\NotFound('File with name ' . $path . ' could not be located');

        if (is_dir($path)) {

            return new self($path);

        } else {

            return new File($path);

        }

    }

Here is the caller graph for this function:

getChildren()

Sabre\DAV\FS\Directory::getChildren

(

)

Returns an array with all the child nodes.

Returns

DAV[]

Implements Sabre\DAV\ICollection.

Definition at line 95 of file Directory.php.

References $nodes, and Sabre\DAV\FS\Directory\getChild().

Referenced by Sabre\DAV\FS\Directory\delete().

                           {

        $nodes = [];
        $iterator = new \FilesystemIterator(
            $this->path,
            \FilesystemIterator::CURRENT_AS_SELF
          | \FilesystemIterator::SKIP_DOTS
        );
        foreach ($iterator as $entry) {

            $nodes[] = $this->getChild($entry->getFilename());

        }
        return $nodes;

    }

Here is the call graph for this function:

Here is the caller graph for this function:

getQuotaInfo()

Sabre\DAV\FS\Directory::getQuotaInfo

(

)

Returns available diskspace information.

Returns

array

Implements Sabre\DAV\IQuota.

Definition at line 142 of file Directory.php.

                            {
        $absolute = realpath($this->path);
        return [
            disk_total_space($absolute) - disk_free_space($absolute),
            disk_free_space($absolute)
        ];

    }

---

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

• libs/composer/vendor/sabre/dav/lib/DAV/FS/Directory.php