VCFExportPlugin
extends ServerPlugin
in package
VCF Exporter.
This plugin adds the ability to export entire address books as .vcf files. This is useful for clients that don't support CardDAV yet. They often do support vcf files.
Tags
Table of Contents
- $server : Server
- Reference to Server class.
- generateVCF() : string
- Merges all vcard objects, and builds one big vcf export.
- 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.
- httpGet() : bool
- Intercepts GET requests on addressbook urls ending with ?export.
- initialize() : mixed
- Initializes the plugin and registers event handlers.
Properties
$server
Reference to Server class.
protected
Server
$server
Methods
generateVCF()
Merges all vcard objects, and builds one big vcf export.
public
generateVCF(array<string|int, mixed> $nodes) : string
Parameters
- $nodes : array<string|int, mixed>
Return values
string —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> —httpGet()
Intercepts GET requests on addressbook urls ending with ?export.
public
httpGet(RequestInterface $request, ResponseInterface $response) : bool
Parameters
- $request : RequestInterface
- $response : ResponseInterface
Return values
bool —initialize()
Initializes the plugin and registers event handlers.
public
initialize(Server $server) : mixed
Parameters
- $server : Server