Skip to content

omnidrive/webdav API reference

Floor
Provider · Omnidrive
Version
1.x
Conformance suite
runs, CI green
Verified for real
Verified in part
Licence
MIT
composer require omnidrive/webdav:1.x-dev

Read from the package's own PHP files at the commit f5225447a457: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.

Omnidrive\Webdav

  • WebdavDriveFactory class

    A collection of a WebDAV server - Nextcloud, ownCloud, Apache's mod_dav, nginx, any - through league/flysystem-webdav (sabre/dav's client, cURL):

    5 options

Omnidrive\Webdav

WebdavDriveFactory class

final class WebdavDriveFactory extends FlysystemDriveFactory WebdavDriveFactory.php:31

A collection of a WebDAV server - Nextcloud, ownCloud, Apache's mod_dav, nginx, any - through league/flysystem-webdav (sabre/dav's client, cURL):

(new WebdavDriveFactory())->create(['base_uri' => 'https://cloud.example.org/remote.php/dav/files/site/', 'username' => 'site', 'password' => '...']);

Options: base_uri (required: the collection behind the drive's paths, with its trailing slash; Nextcloud's and ownCloud's is https://<host>/remote.php/dav/files/<user>/), username and password (an application password on Nextcloud), auth (basic, digest, ntlm or any: the scheme asked first - "any" lets cURL find it at the cost of a request), prefix (every path under it), proxy, manual_copy and manual_move (a server that does not do COPY or MOVE: the file read and written again), public_url (else the file's WebDAV address, served to whoever the server serves it to).

WebDAV keeps no visibility of its own: writing with one is accepted and ignored, reading or changing it is a DriveException. Nothing is sent until the first operation.

Options

OptionDefault
auth'basic'
prefix''
manual_copyfalse
manual_movefalse
base_urirequired