Sabre\DAV\FSExt\Directory Class Reference

Directory class. More...

Inheritance diagram for Sabre\DAV\FSExt\Directory:

Collaboration diagram for Sabre\DAV\FSExt\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...
	childExists ($name)
	Checks if a child exists. More...
	getChildren ()
	Returns an array with all the child nodes. More...
	delete ()
	Deletes all files in this directory, and then itself. More...
	getQuotaInfo ()
	Returns available diskspace information. More...
	moveInto ($targetName, $sourcePath, DAV\INode $sourceNode)
	Moves a node into this collection. 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...
Public Member Functions inherited from Sabre\DAV\IMoveTarget
	moveInto ($targetName, $sourcePath, INode $sourceNode)
	Moves a node into this collection. 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 15 of file Directory.php.

Member Function Documentation

childExists()

Sabre\DAV\FSExt\Directory::childExists

(

$name

)

Checks if a child exists.

Parameters

string

$name

Returns

bool

Implements Sabre\DAV\ICollection.

Definition at line 108 of file Directory.php.

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

                                {

        if ($name == '.' || $name == '..')
            throw new DAV\Exception\Forbidden('Permission denied to . and ..');

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

    }

createDirectory()

Sabre\DAV\FSExt\Directory::createDirectory

(

$name

)

Creates a new subdirectory.

Parameters

string

$name

Returns

void

Implements Sabre\DAV\ICollection.

Definition at line 63 of file Directory.php.

References $name.

                                    {

        // We're not allowing dots
        if ($name == '.' || $name == '..') throw new DAV\Exception\Forbidden('Permission denied to . and ..');
        $newPath = $this->path . '/' . $name;
        mkdir($newPath);
        clearstatcache(true, $newPath);

    }

createFile()

Sabre\DAV\FSExt\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 41 of file Directory.php.

References $data, and $name.

                                             {

        // We're not allowing dots
        if ($name == '.' || $name == '..') throw new DAV\Exception\Forbidden('Permission denied to . and ..');
        $newPath = $this->path . '/' . $name;
        file_put_contents($newPath, $data);
        clearstatcache(true, $newPath);

        return '"' . sha1(
            fileinode($newPath) .
            filesize($newPath) .
            filemtime($newPath)
        ) . '"';

    }

delete()

Sabre\DAV\FSExt\Directory::delete

(

)

Deletes all files in this directory, and then itself.

Returns

bool

Implements Sabre\DAV\INode.

Definition at line 146 of file Directory.php.

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

                      {

        // Deleting all children
        foreach ($this->getChildren() as $child) $child->delete();

        // Removing the directory itself
        rmdir($this->path);

        return true;

    }

Here is the call graph for this function:

getChild()

Sabre\DAV\FSExt\Directory::getChild

(

$name

)

Returns a specific child node, referenced by its name.

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

Parameters

string

$name

Exceptions

DAV

Implements Sabre\DAV\ICollection.

Definition at line 83 of file Directory.php.

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

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

                             {

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

        if (!file_exists($path)) throw new DAV\Exception\NotFound('File could not be located');
        if ($name == '.' || $name == '..') throw new DAV\Exception\Forbidden('Permission denied to . and ..');

        if (is_dir($path)) {

            return new self($path);

        } else {

            return new File($path);

        }

    }

Here is the caller graph for this function:

getChildren()

Sabre\DAV\FSExt\Directory::getChildren

(

)

Returns an array with all the child nodes.

Returns

DAV[]

Implements Sabre\DAV\ICollection.

Definition at line 123 of file Directory.php.

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

Referenced by Sabre\DAV\FSExt\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\FSExt\Directory::getQuotaInfo

(

)

Returns available diskspace information.

Returns

array

Implements Sabre\DAV\IQuota.

Definition at line 163 of file Directory.php.

References $total.

                            {

        $total = disk_total_space(realpath($this->path));
        $free = disk_free_space(realpath($this->path));

        return [
            $total - $free,
            $free
        ];
    }

moveInto()

Sabre\DAV\FSExt\Directory::moveInto	(		$targetName,
			$sourcePath,
		DAV\INode	$sourceNode
	)

Moves a node into this collection.

It is up to the implementors to:

1. Create the new resource.
2. Remove the old resource.
3. Transfer any properties or other data.

Generally you should make very sure that your collection can easily move the move.

If you don't, just return false, which will trigger sabre/dav to handle the move itself. If you return true from this function, the assumption is that the move was successful.

Parameters

string	$targetName	New local file/collection name.
string	$sourcePath	Full path to source node
DAV\INode	$sourceNode	Source node itself

Returns

bool

Definition at line 194 of file Directory.php.

                                                                       {

        // We only support FSExt\Directory or FSExt\File objects, so
        // anything else we want to quickly reject.
        if (!$sourceNode instanceof self && !$sourceNode instanceof File) {
            return false;
        }

        // PHP allows us to access protected properties from other objects, as
        // long as they are defined in a class that has a shared inheritence
        // with the current class.
        rename($sourceNode->path, $this->path . '/' . $targetName);

        return true;

    }

---

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

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