ICopyTarget

By implementing this interface, a collection can effectively say "other nodes may be copied into this collection".

If a backend supports a better optimized copy operation, e.g. by avoiding copying the contents, this can trigger some huge speed gains.

Full name: \Sabre\DAV\ICopyTarget
Parent interfaces: \Sabre\DAV\ICollection

Methods

copyInto

Copies a node into this collection.

public copyInto(string $targetName, string $sourcePath, \Sabre\DAV\INode $sourceNode): bool

It is up to the implementors to: 1. Create the new resource. 2. Copy the data and any properties.

If you return true from this function, the assumption is that the copy was successful. If you return false, sabre/dav will handle the copy itself.

Parameters:

Parameter	Type	Description
`$targetName`	string	new local file/collection name
`$sourcePath`	string	Full path to source node
`$sourceNode`	\Sabre\DAV\INode	Source node itself

Inherited methods

delete

Deleted the current node.

public delete(): mixed

getName

Returns the name of the node.

public getName(): string

This is used to generate the url.

setName

Renames the node.

public setName(string $name): mixed

Parameters:

Parameter	Type	Description
`$name`	string	The new name

getLastModified

Returns the last modification time, as a unix timestamp. Return null if the information is not available.

public getLastModified(): int|null

createFile

Creates a new file in the directory.

public createFile(string $name, resource|string $data = null): string|null

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:

Parameter	Type	Description
`$name`	string	Name of the file
`$data`	resource\|string	Initial payload

createDirectory

Creates a new subdirectory.

public createDirectory(string $name): mixed

Parameters:

Parameter	Type	Description
`$name`	string

getChild

Returns a specific child node, referenced by its name.

public getChild(string $name): \Sabre\DAV\INode

This method must throw Sabre\DAV\Exception\NotFound if the node does not exist.

Parameters:

Parameter	Type	Description
`$name`	string

getChildren

Returns an array with all the child nodes.

public getChildren(): \Sabre\DAV\INode[]

childExists

Checks if a child-node with the specified name exists.

public childExists(string $name): bool

Parameters:

Parameter	Type	Description
`$name`	string

Automatically generated on 2025-03-18