BackendInterface

Propertystorage backend interface.

Propertystorage backends must implement this interface to be used by the propertystorage plugin.

Full name: \Sabre\DAV\PropertyStorage\Backend\BackendInterface

Methods

propFind

Fetches properties for a path.

public propFind(string $path, \Sabre\DAV\PropFind $propFind): mixed

This method received a PropFind object, which contains all the information about the properties that need to be fetched.

Usually you would just want to call 'get404Properties' on this object, as this will give you the exact list of properties that need to be fetched, and haven't yet.

However, you can also support the 'allprops' property here. In that case, you should check for $propFind->isAllProps().

Parameters:

Parameter	Type	Description
`$path`	string
`$propFind`	\Sabre\DAV\PropFind

propPatch

Updates properties for a path.

public propPatch(string $path, \Sabre\DAV\PropPatch $propPatch): mixed

This method received a PropPatch object, which contains all the information about the update.

Usually you would want to call 'handleRemaining' on this object, to get; a list of all properties that need to be stored.

Parameters:

Parameter	Type	Description
`$path`	string
`$propPatch`	\Sabre\DAV\PropPatch

delete

This method is called after a node is deleted.

public delete(string $path): mixed

This allows a backend to clean up all associated properties.

The delete method will get called once for the deletion of an entire tree.

Parameters:

Parameter	Type	Description
`$path`	string

move

This method is called after a successful MOVE.

public move(string $source, string $destination): mixed

This should be used to migrate all properties from one path to another. Note that entire collections may be moved, so ensure that all properties for children are also moved along.

Parameters:

Parameter	Type	Description
`$source`	string
`$destination`	string

Automatically generated on 2025-03-18