Sabre\CardDAV\VCFExportPlugin Class Reference

VCF Exporter. More...

Inheritance diagram for Sabre\CardDAV\VCFExportPlugin:

Collaboration diagram for Sabre\CardDAV\VCFExportPlugin:

Public Member Functions
	initialize (DAV\Server $server)
	Initializes the plugin and registers event handlers. More...
	httpGet (RequestInterface $request, ResponseInterface $response)
	Intercepts GET requests on addressbook urls ending with ?export. More...
	generateVCF (array $nodes)
	Merges all vcard objects, and builds one big vcf export. More...
	getPluginName ()
	Returns a plugin name. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...
Public Member Functions inherited from Sabre\DAV\ServerPlugin
	initialize (Server $server)
	This initializes the plugin. More...
	getFeatures ()
	This method should return a list of server-features. More...
	getHTTPMethods ($path)
	Use this method to tell the server this plugin defines additional HTTP methods. More...
	getPluginName ()
	Returns a plugin name. More...
	getSupportedReportSet ($uri)
	Returns a list of reports this plugin supports. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...

Protected Attributes
	$server

Detailed Description

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.

Copyright

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

Author

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

Thomas Tanghus (http://tanghus.net/) http://sabre.io/license/ Modified BSD License

Definition at line 22 of file VCFExportPlugin.php.

Member Function Documentation

generateVCF()

Sabre\CardDAV\VCFExportPlugin::generateVCF

(

array

$nodes

)

Merges all vcard objects, and builds one big vcf export.

Parameters

array

$nodes

Returns

string

Definition at line 113 of file VCFExportPlugin.php.

References Sabre\VObject\$output, Sabre\CardDAV\Plugin\NS_CARDDAV, and Sabre\VObject\Reader\read().

Referenced by Sabre\CardDAV\VCFExportPlugin\httpGet().

                                       {

        $output = "";

        foreach ($nodes as $node) {

            if (!isset($node[200]['{' . Plugin::NS_CARDDAV . '}address-data'])) {
                continue;
            }
            $nodeData = $node[200]['{' . Plugin::NS_CARDDAV . '}address-data'];

            // Parsing this node so VObject can clean up the output.
            $vcard = VObject\Reader::read($nodeData);
            $output .= $vcard->serialize();

            // Destroy circular references to PHP will GC the object.
            $vcard->destroy();

        }

        return $output;

    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginInfo()

Sabre\CardDAV\VCFExportPlugin::getPluginInfo

(

)

Returns a bunch of meta-data about the plugin.

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.

Returns

array

Definition at line 162 of file VCFExportPlugin.php.

References Sabre\CardDAV\VCFExportPlugin\getPluginName().

                             {

        return [
            'name'        => $this->getPluginName(),
            'description' => 'Adds the ability to export CardDAV addressbooks as a single vCard file.',
            'link'        => 'http://sabre.io/dav/vcf-export-plugin/',
        ];

    }

Here is the call graph for this function:

getPluginName()

Sabre\CardDAV\VCFExportPlugin::getPluginName

(

)

Returns a plugin name.

Using this name other plugins will be able to access other plugins using ::getPlugin

Returns

string

Definition at line 145 of file VCFExportPlugin.php.

Referenced by Sabre\CardDAV\VCFExportPlugin\getPluginInfo().

                             {

        return 'vcf-export';

    }

Here is the caller graph for this function:

httpGet()

Sabre\CardDAV\VCFExportPlugin::httpGet	(	RequestInterface	$request,
		ResponseInterface	$response
	)

Intercepts GET requests on addressbook urls ending with ?export.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns

bool

Definition at line 55 of file VCFExportPlugin.php.

References $aclPlugin, $filename, $format, $nodes, Sabre\VObject\$output, $path, Sabre\CardDAV\VCFExportPlugin\generateVCF(), Sabre\HTTP\RequestInterface\getPath(), Sabre\HTTP\RequestInterface\getQueryParameters(), Sabre\CardDAV\Plugin\NS_CARDDAV, Sabre\HTTP\MessageInterface\setBody(), Sabre\HTTP\MessageInterface\setHeader(), and Sabre\HTTP\ResponseInterface\setStatus().

                                                                             {

        $queryParams = $request->getQueryParameters();
        if (!array_key_exists('export', $queryParams)) return;

        $path = $request->getPath();

        $node = $this->server->tree->getNodeForPath($path);

        if (!($node instanceof IAddressBook)) return;

        $this->server->transactionType = 'get-addressbook-export';

        // Checking ACL, if available.
        if ($aclPlugin = $this->server->getPlugin('acl')) {
            $aclPlugin->checkPrivileges($path, '{DAV:}read');
        }

        $nodes = $this->server->getPropertiesForPath($path, [
            '{' . Plugin::NS_CARDDAV . '}address-data',
        ], 1);

        $format = 'text/directory';

        $output = null;
        $filenameExtension = null;

        switch ($format) {
            case 'text/directory':
                $output = $this->generateVCF($nodes);
                $filenameExtension = '.vcf';
                break;
        }

        $filename = preg_replace(
            '/[^a-zA-Z0-9-_ ]/um',
            '',
            $node->getName()
        );
        $filename .= '-' . date('Y-m-d') . $filenameExtension;

        $response->setHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
        $response->setHeader('Content-Type', $format);

        $response->setStatus(200);
        $response->setBody($output);

        // Returning false to break the event chain
        return false;

    }

Here is the call graph for this function:

initialize()

Sabre\CardDAV\VCFExportPlugin::initialize

(

DAV\Server

$server

)

Initializes the plugin and registers event handlers.

Parameters

DAV\Server

$server

Returns

void

Definition at line 37 of file VCFExportPlugin.php.

References $path, and Sabre\CardDAV\VCFExportPlugin\$server.

                                            {

        $this->server = $server;
        $this->server->on('method:GET', [$this, 'httpGet'], 90);
        $server->on('browserButtonActions', function($path, $node, &$actions) {
            if ($node instanceof IAddressBook) {
                $actions .= '<a href="' . htmlspecialchars($path, ENT_QUOTES, 'UTF-8') . '?export"><span class="oi" data-glyph="book"></span></a>';
            }
        });
    }

Field Documentation

$server

Sabre\CardDAV\VCFExportPlugin::$server

protected

Definition at line 29 of file VCFExportPlugin.php.

Referenced by Sabre\CardDAV\VCFExportPlugin\initialize().

---

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

• libs/composer/vendor/sabre/dav/lib/CardDAV/VCFExportPlugin.php