SabreDAV DAV client. More...

Inheritance diagram for Sabre\DAV\Client:

Collaboration diagram for Sabre\DAV\Client:

Public Member Functions
	__construct (array $settings)
	Constructor. More...

	propFind ($url, array $properties, $depth=0)
	Does a PROPFIND request. More...

	propPatch ($url, array $properties)
	Updates a list of properties on the server. More...

	options ()
	Performs an HTTP options request. More...

	request ($method, $url='', $body=null, array $headers=[])
	Performs an actual HTTP request, and returns the result. More...

	getAbsoluteUrl ($url)
	Returns the full url based on the given url (which may be relative). More...

	parseMultiStatus ($body)
	Parses a WebDAV multistatus response body. More...

Public Member Functions inherited from Sabre\HTTP\Client
	__construct ()
	Initializes the client. More...

	send (RequestInterface $request)
	Sends a request to a HTTP server, and returns a response. More...

	sendAsync (RequestInterface $request, callable $success=null, callable $error=null)
	Sends a HTTP request asynchronously. More...

	poll ()
	This method checks if any http requests have gotten results, and if so, call the appropriate success or error handlers. More...

	wait ()
	Processes every HTTP request in the queue, and waits till they are all completed. More...

	setThrowExceptions ($throwExceptions)
	If this is set to true, the Client will automatically throw exceptions upon HTTP errors. More...

	addCurlSetting ($name, $value)
	Adds a CURL setting. More...

Public Member Functions inherited from Sabre\Event\EventEmitterInterface
	on ($eventName, callable $callBack, $priority=100)
	Subscribe to an event. More...

	once ($eventName, callable $callBack, $priority=100)
	Subscribe to an event exactly once. More...

	emit ($eventName, array $arguments=[], callable $continueCallBack=null)
	Emits an event. More...

	listeners ($eventName)
	Returns the list of listeners for an event. More...

	removeListener ($eventName, callable $listener)
	Removes a specific listener from an event. More...

	removeAllListeners ($eventName=null)
	Removes all listeners. More...

Data Fields
	$xml

	$propertyMap = []

const	AUTH_BASIC = 1
	Basic authentication. More...

const	AUTH_DIGEST = 2
	Digest authentication. More...

const	AUTH_NTLM = 4
	NTLM authentication. More...

const	ENCODING_IDENTITY = 1
	Identity encoding, which basically does not nothing. More...

const	ENCODING_DEFLATE = 2
	Deflate encoding. More...

const	ENCODING_GZIP = 4
	Gzip encoding. More...

const	ENCODING_ALL = 7
	Sends all encoding headers. More...

Data Fields inherited from Sabre\HTTP\Client
const	STATUS_SUCCESS = 0

const	STATUS_CURLERROR = 1

const	STATUS_HTTPERROR = 2

Protected Attributes
	$baseUri

	$encoding = self::ENCODING_IDENTITY

Protected Attributes inherited from Sabre\HTTP\Client
	$curlSettings = []

	$throwExceptions = false

	$maxRedirects = 5

Additional Inherited Members
Protected Member Functions inherited from Sabre\HTTP\Client
	doRequest (RequestInterface $request)
	This method is responsible for performing a single request. More...

	createCurlSettingsArray (RequestInterface $request)
	Turns a RequestInterface object into an array with settings that can be fed to curl_setopt. More...

	parseCurlResult ($response, $curlHandle)
	Parses the result of a curl call in a format that's a bit more convenient to work with. More...

	sendAsyncInternal (RequestInterface $request, callable $success, callable $error, $retryCount=0)
	Sends an asynchronous HTTP request. More...

	curlExec ($curlHandle)
	Calls curl_exec. More...

	curlStuff ($curlHandle)
	Returns a bunch of information about a curl request. More...

Detailed Description

SabreDAV DAV client.

This client wraps around Curl to provide a convenient API to a WebDAV server.

NOTE: This class is experimental, it's api will likely change in the future.

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

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 20 of file Client.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAV\Client::__construct ( array $settings )

Constructor.

Settings are provided through the 'settings' argument. The following settings are supported:

baseUri
userName (optional)
password (optional)
proxy (optional)
authType (optional)
encoding (optional)

authType must be a bitmap, using self::AUTH_BASIC, self::AUTH_DIGEST and self::AUTH_NTLM. If you know which authentication method will be used, it's recommended to set it, as it will save a great deal of requests to 'discover' this information.

Encoding is a bitmap with one of the ENCODING constants.

Parameters

array $settings

Definition at line 115 of file Client.php.

                                          {
 
        if (!isset($settings['baseUri'])) {
            throw new \InvalidArgumentException('A baseUri must be provided');
        }
 
        parent::__construct();
 
        $this->baseUri = $settings['baseUri'];
 
        if (isset($settings['proxy'])) {
            $this->addCurlSetting(CURLOPT_PROXY, $settings['proxy']);
        }
 
        if (isset($settings['userName'])) {
            $userName = $settings['userName'];
            $password = isset($settings['password']) ? $settings['password'] : '';
 
            if (isset($settings['authType'])) {
                $curlType = 0;
                if ($settings['authType'] & self::AUTH_BASIC) {
                    $curlType |= CURLAUTH_BASIC;
                }
                if ($settings['authType'] & self::AUTH_DIGEST) {
                    $curlType |= CURLAUTH_DIGEST;
                }
                if ($settings['authType'] & self::AUTH_NTLM) {
                    $curlType |= CURLAUTH_NTLM;
                }
            } else {
                $curlType = CURLAUTH_BASIC | CURLAUTH_DIGEST;
            }
 
            $this->addCurlSetting(CURLOPT_HTTPAUTH, $curlType);
            $this->addCurlSetting(CURLOPT_USERPWD, $userName . ':' . $password);
 
        }
 
        if (isset($settings['encoding'])) {
            $encoding = $settings['encoding'];
 
            $encodings = [];
            if ($encoding & self::ENCODING_IDENTITY) {
                $encodings[] = 'identity';
            }
            if ($encoding & self::ENCODING_DEFLATE) {
                $encodings[] = 'deflate';
            }
            if ($encoding & self::ENCODING_GZIP) {
                $encodings[] = 'gzip';
            }
            $this->addCurlSetting(CURLOPT_ENCODING, implode(',', $encodings));
        }
 
        $this->addCurlSetting(CURLOPT_USERAGENT, 'sabre-dav/' . Version::VERSION . ' (http://sabre.io/)');
 
        $this->xml = new Xml\Service();
        // BC
        $this->propertyMap = & $this->xml->elementMap;
 
    }

References Sabre\DAV\Client\$encoding, $password, Sabre\HTTP\Client\addCurlSetting(), and Sabre\DAV\Version\VERSION.

Here is the call graph for this function:

Member Function Documentation

◆ getAbsoluteUrl()

Sabre\DAV\Client::getAbsoluteUrl ( $url )

Returns the full url based on the given url (which may be relative).

All urls are expanded based on the base url as given by the server.

Parameters

string $url

Returns: string

Reimplemented in Sabre\DAV\ClientMock.

Definition at line 389 of file Client.php.

                                  {
 
        return Uri\resolve(
            $this->baseUri,
            $url
        );
 
    }

References $url, and Sabre\Uri\resolve().

Referenced by Sabre\DAV\Client\options(), Sabre\DAV\Client\propFind(), Sabre\DAV\Client\propPatch(), and Sabre\DAV\Client\request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ options()

Sabre\DAV\Client::options ( )

Performs an HTTP options request.

This method returns all the features from the 'DAV:' header as an array. If there was no DAV header, or no contents this method will return an empty array.

Returns: array

Definition at line 322 of file Client.php.

                       {
 
        $request = new HTTP\Request('OPTIONS', $this->getAbsoluteUrl(''));
        $response = $this->send($request);
 
        $dav = $response->getHeader('Dav');
        if (!$dav) {
            return [];
        }
 
        $features = explode(',', $dav);
        foreach ($features as &$v) {
            $v = trim($v);
        }
        return $features;
 
    }

References $request, $response, Sabre\DAV\Client\getAbsoluteUrl(), and Sabre\HTTP\Client\send().

Here is the call graph for this function:

◆ parseMultiStatus()

Sabre\DAV\Client::parseMultiStatus ( $body )

Parses a WebDAV multistatus response body.

This method returns an array with the following structure

[ 'url/to/resource' => [ '200' => [ '{DAV:}property1' => 'value1', '{DAV:}property2' => 'value2', ], '404' => [ '{DAV:}property1' => null, '{DAV:}property2' => null, ], ], 'url/to/resource2' => [ .. etc .. ] ]

Parameters

string $body xml body

Returns: array

Definition at line 423 of file Client.php.

                                     {
 
        $multistatus = $this->xml->expect('{DAV:}multistatus', $body);
 
        $result = [];
 
        foreach ($multistatus->getResponses() as $response) {
 
            $result[$response->getHref()] = $response->getResponseProperties();
 
        }
 
        return $result;
 
    }

References $response, and $result.

Referenced by Sabre\DAV\Client\propFind(), and Sabre\DAV\Client\propPatch().

Here is the caller graph for this function:

◆ propFind()

Sabre\DAV\Client::propFind	(		$url,
		array	$properties,
			$depth = `0`
	)

Does a PROPFIND request.

The list of requested properties must be specified as an array, in clark notation.

The returned array will contain a list of filenames as keys, and properties as values.

The properties array will contain the list of properties. Only properties that are actually returned from the server (without error) will be returned, anything else is discarded.

Depth should be either 0 or 1. A depth of 1 will cause a request to be made to the server to also return all child resources.

Parameters

string	$url
array	$properties
int	$depth

Returns: array

Definition at line 198 of file Client.php.

                                                           {
 
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->formatOutput = true;
        $root = $dom->createElementNS('DAV:', 'd:propfind');
        $prop = $dom->createElement('d:prop');
 
        foreach ($properties as $property) {
 
            list(
                $namespace,
                $elementName
            ) = \Sabre\Xml\Service::parseClarkNotation($property);
 
            if ($namespace === 'DAV:') {
                $element = $dom->createElement('d:' . $elementName);
            } else {
                $element = $dom->createElementNS($namespace, 'x:' . $elementName);
            }
 
            $prop->appendChild($element);
        }
 
        $dom->appendChild($root)->appendChild($prop);
        $body = $dom->saveXML();
 
        $url = $this->getAbsoluteUrl($url);
 
        $request = new HTTP\Request('PROPFIND', $url, [
            'Depth'        => $depth,
            'Content-Type' => 'application/xml'
        ], $body);
 
        $response = $this->send($request);
 
        if ((int)$response->getStatus() >= 400) {
            throw new HTTP\ClientHttpException($response);
        }
 
        $result = $this->parseMultiStatus($response->getBodyAsString());
 
        // If depth was 0, we only return the top item
        if ($depth === 0) {
            reset($result);
            $result = current($result);
            return isset($result[200]) ? $result[200] : [];
        }
 
        $newResult = [];
        foreach ($result as $href => $statusList) {
 
            $newResult[$href] = isset($statusList[200]) ? $statusList[200] : [];
 
        }
 
        return $newResult;
 
    }

References $namespace, $request, $response, $result, $root, $url, Sabre\DAV\Client\getAbsoluteUrl(), Sabre\Xml\Service\parseClarkNotation(), Sabre\DAV\Client\parseMultiStatus(), and Sabre\HTTP\Client\send().

Here is the call graph for this function:

◆ propPatch()

Sabre\DAV\Client::propPatch	(		$url,
		array	$properties
	)

Updates a list of properties on the server.

The list of properties must have clark-notation properties for the keys, and the actual (string) value for the value. If the value is null, an attempt is made to delete the property.

Parameters

string	$url
array	$properties

Returns: bool

Definition at line 268 of file Client.php.

                                                {
 
        $propPatch = new Xml\Request\PropPatch();
        $propPatch->properties = $properties;
        $xml = $this->xml->write(
            '{DAV:}propertyupdate',
            $propPatch
        );
 
        $url = $this->getAbsoluteUrl($url);
        $request = new HTTP\Request('PROPPATCH', $url, [
            'Content-Type' => 'application/xml',
        ], $xml);
        $response = $this->send($request);
 
        if ($response->getStatus() >= 400) {
            throw new HTTP\ClientHttpException($response);
        }
 
        if ($response->getStatus() === 207) {
            // If it's a 207, the request could still have failed, but the
            // information is hidden in the response body.
            $result = $this->parseMultiStatus($response->getBodyAsString());
 
            $errorProperties = [];
            foreach ($result as $href => $statusList) {
                foreach ($statusList as $status => $properties) {
 
                    if ($status >= 400) {
                        foreach ($properties as $propName => $propValue) {
                            $errorProperties[] = $propName . ' (' . $status . ')';
                        }
                    }
 
                }
            }
            if ($errorProperties) {
 
                throw new HTTP\ClientException('PROPPATCH failed. The following properties errored: ' . implode(', ', $errorProperties));
            }
        }
        return true;
 
    }

References $request, $response, $result, $url, Sabre\DAV\Client\$xml, Sabre\DAV\Client\getAbsoluteUrl(), Sabre\DAV\Client\parseMultiStatus(), and Sabre\HTTP\Client\send().

Here is the call graph for this function:

◆ request()

Sabre\DAV\Client::request	(		$method,
			$url = `''`,
			$body = `null`,
		array	$headers = `[]`
	)

Performs an actual HTTP request, and returns the result.

If the specified url is relative, it will be expanded based on the base url.

The returned array contains 3 keys:

body - the response body
httpCode - a HTTP code (200, 404, etc)
headers - a list of response http headers. The header names have been lowercased.

For large uploads, it's highly recommended to specify body as a stream resource. You can easily do this by simply passing the result of fopen(..., 'r').

This method will throw an exception if an HTTP error was received. Any HTTP status code above 399 is considered an error.

Note that it is no longer recommended to use this method, use the send() method instead.

Parameters

string	$method
string	$url
string \| resource \| null	$body
array	$headers

Exceptions

ClientException,in case a curl error occurred.

Returns: array

Definition at line 369 of file Client.php.

                                                                            {
 
        $url = $this->getAbsoluteUrl($url);
 
        $response = $this->send(new HTTP\Request($method, $url, $headers, $body));
        return [
            'body'       => $response->getBodyAsString(),
            'statusCode' => (int)$response->getStatus(),
            'headers'    => array_change_key_case($response->getHeaders()),
        ];
 
    }

References $response, $url, Sabre\DAV\Client\getAbsoluteUrl(), and Sabre\HTTP\Client\send().

Referenced by Sabre\DAV\ClientMock\doRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $baseUri

Sabre\DAV\Client::$baseUri

protected

Definition at line 49 of file Client.php.

◆ $encoding

Sabre\DAV\Client::$encoding = self::ENCODING_IDENTITY

protected

Definition at line 91 of file Client.php.

Referenced by Sabre\DAV\Client\__construct().

◆ $propertyMap

Sabre\DAV\Client::$propertyMap = []

Definition at line 40 of file Client.php.

◆ $xml

Sabre\DAV\Client::$xml

Definition at line 29 of file Client.php.

Referenced by Sabre\DAV\Client\propPatch().

◆ AUTH_BASIC

const Sabre\DAV\Client::AUTH_BASIC = 1

Basic authentication.

Definition at line 54 of file Client.php.

Referenced by Sabre\DAV\ClientTest\testBasicAuth().

◆ AUTH_DIGEST

const Sabre\DAV\Client::AUTH_DIGEST = 2

Digest authentication.

Definition at line 59 of file Client.php.

Referenced by Sabre\DAV\ClientTest\testDigestAuth().

◆ AUTH_NTLM

const Sabre\DAV\Client::AUTH_NTLM = 4

NTLM authentication.

Definition at line 64 of file Client.php.

Referenced by Sabre\DAV\ClientTest\testNTLMAuth().

◆ ENCODING_ALL

const Sabre\DAV\Client::ENCODING_ALL = 7

Sends all encoding headers.

Definition at line 84 of file Client.php.

◆ ENCODING_DEFLATE

const Sabre\DAV\Client::ENCODING_DEFLATE = 2

Deflate encoding.

Definition at line 74 of file Client.php.

Referenced by Sabre\DAV\ClientTest\testEncoding().

◆ ENCODING_GZIP

const Sabre\DAV\Client::ENCODING_GZIP = 4

Gzip encoding.

Definition at line 79 of file Client.php.

Referenced by Sabre\DAV\ClientTest\testEncoding().

◆ ENCODING_IDENTITY

const Sabre\DAV\Client::ENCODING_IDENTITY = 1

Identity encoding, which basically does not nothing.

Definition at line 69 of file Client.php.

Referenced by Sabre\DAV\ClientTest\testEncoding().

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

libs/composer/vendor/sabre/dav/lib/DAV/Client.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAbsoluteUrl()

◆ options()

◆ parseMultiStatus()

◆ propFind()

◆ propPatch()

◆ request()

Field Documentation

◆ $baseUri

◆ $encoding

◆ $propertyMap

◆ $xml

◆ AUTH_BASIC

◆ AUTH_DIGEST

◆ AUTH_NTLM

◆ ENCODING_ALL

◆ ENCODING_DEFLATE

◆ ENCODING_GZIP

◆ ENCODING_IDENTITY