Documentation

Plugin extends ServerPlugin
in package

PropertyStorage Plugin.

Adding this plugin to your server allows clients to store any arbitrary WebDAV property.

See: http://sabre.io/dav/property-storage/

for more information.

Tags
copyright

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

author

Evert Pot (http://evertpot.com/)

license

http://sabre.io/license/ Modified BSD License

Table of Contents

$backend  : BackendInterface
$pathFilter  : callable
If you only want this plugin to store properties for a limited set of paths, you can use a pathFilter to do this.
__construct()  : mixed
Creates the plugin.
afterMove()  : mixed
Called after a node is moved.
afterUnbind()  : mixed
Called after a node is deleted.
getFeatures()  : array<string|int, mixed>
This method should return a list of server-features.
getHTTPMethods()  : array<string|int, mixed>
Use this method to tell the server this plugin defines additional HTTP methods.
getPluginInfo()  : array<string|int, mixed>
Returns a bunch of meta-data about the plugin.
getPluginName()  : string
Returns a plugin name.
getSupportedReportSet()  : array<string|int, mixed>
Returns a list of reports this plugin supports.
initialize()  : mixed
This initializes the plugin.
propFind()  : mixed
Called during PROPFIND operations.
propPatch()  : mixed
Called during PROPPATCH operations.

Properties

$pathFilter

If you only want this plugin to store properties for a limited set of paths, you can use a pathFilter to do this.

public callable $pathFilter

The pathFilter should be a callable. The callable retrieves a path as its argument, and should return true or false whether it allows properties to be stored.

Methods

afterMove()

Called after a node is moved.

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

This allows the backend to move all the associated properties.

Parameters
$source : string
$destination : string
Return values
mixed —

afterUnbind()

Called after a node is deleted.

public afterUnbind(string $path) : mixed

This allows the backend to clean up any properties still in the database.

Parameters
$path : string
Return values
mixed —

getFeatures()

This method should return a list of server-features.

public getFeatures() : array<string|int, mixed>

This is for example 'versioning' and is added to the DAV: header in an OPTIONS response.

Return values
array<string|int, mixed> —

getHTTPMethods()

Use this method to tell the server this plugin defines additional HTTP methods.

public getHTTPMethods(string $path) : array<string|int, mixed>

This method is passed a uri. It should only return HTTP methods that are available for the specified uri.

Parameters
$path : string
Return values
array<string|int, mixed> —

getPluginInfo()

Returns a bunch of meta-data about the plugin.

public getPluginInfo() : array<string|int, mixed>

Providing this information is optional, and is mainly displayed by the Browser plugin.

The description key in the returned array may contain html and will not be sanitized.

Return values
array<string|int, mixed> —

getPluginName()

Returns a plugin name.

public getPluginName() : string

Using this name other plugins will be able to access other plugins using \Sabre\DAV\Server::getPlugin

Return values
string —

getSupportedReportSet()

Returns a list of reports this plugin supports.

public getSupportedReportSet(string $uri) : array<string|int, mixed>

This will be used in the {DAV:}supported-report-set property. Note that you still need to subscribe to the 'report' event to actually implement them

Parameters
$uri : string
Return values
array<string|int, mixed> —

initialize()

This initializes the plugin.

public initialize(Server $server) : mixed

This function is called by Sabre\DAV\Server, after addPlugin is called.

This method should set up the required event subscriptions.

Parameters
$server : Server
Return values
mixed —

propFind()

Called during PROPFIND operations.

public propFind(PropFind $propFind, INode $node) : mixed

If there's any requested properties that don't have a value yet, this plugin will look in the property storage backend to find them.

Parameters
$propFind : PropFind
$node : INode
Return values
mixed —

propPatch()

Called during PROPPATCH operations.

public propPatch(string $path, PropPatch $propPatch) : mixed

If there's any updated properties that haven't been stored, the propertystorage backend can handle it.

Parameters
$path : string
$propPatch : PropPatch
Return values
mixed —

Search results