WebDAV

Represent web d a v.

class WebDAV extends \Hazaar\HTTP\WebDAV implements \Hazaar\File\Backend\BackendInterface , \Hazaar\File\Backend\DriverInterface

Properties

separator

Store the separator.

public string $separator = '/'

manager

Store the manager.

protected Manager $manager

options

private array $options

cache

Store the cache.

private Adapter $cache

meta

private array $meta

Methods

__construct

WebDAV constructor.

public __construct(array $options): void

Parameters

Parameter	Type	Description
$options	array

__destruct

Clean up resources before destruction.

public __destruct(): void

label

Return the human-readable label for this backend implementation.

public label(): string

refresh

Refresh the remote authorization token used by this backend.

public refresh(bool $reset = true): bool

Parameters

Parameter	Type	Description
$reset	bool

scandir

List directory entries for a path in backend storage.

public scandir(string $path, ?string $regexFilter, int $sort = 'SCANDIR_SORT_ASCENDING', bool $showHidden, ?string $relativePath, bool $): void

Parameters

Parameter	Type	Description
$path	string
$regexFilter	string
$sort	int
$showHidden	bool
$relativePath	string
$	bool

exists

Determine whether a path exists in backend storage.

public exists(string $path): bool

Parameters

Parameter	Type	Description
$path	string

realpath

Resolve a logical backend path to its canonical remote representation.

public realpath(string $path): ?string

Parameters

Parameter	Type	Description
$path	string

isReadable

Check whether the instance readable.

public isReadable(string $path): bool

Parameters

Parameter	Type	Description
$path	string

isWritable

Check whether the instance writable.

public isWritable(string $path): bool

Parameters

Parameter	Type	Description
$path	string

isDir

Check whether the instance dir.

public isDir(string $path): bool

Parameters

Parameter	Type	Description
$path	string

isLink

Check whether the instance link.

public isLink(string $path): bool

Parameters

Parameter	Type	Description
$path	string

isFile

Check whether the instance file.

public isFile(string $path): bool

Parameters

Parameter	Type	Description
$path	string

filetype

Return the file type for a backend path.

public filetype(string $path): string

Parameters

Parameter	Type	Description
$path	string

filectime

Return the creation timestamp for a backend path.

public filectime(string $path): int

Parameters

Parameter	Type	Description
$path	string

filemtime

Return the last-modified timestamp for a backend path.

public filemtime(string $path): int

Parameters

Parameter	Type	Description
$path	string

touch

Create a file or update modification time for a backend path.

public touch(string $path): bool

Parameters

Parameter	Type	Description
$path	string

fileatime

Return the last-access timestamp for a backend path.

public fileatime(string $path): int

Parameters

Parameter	Type	Description
$path	string

filesize

Return the file size in bytes for a backend path.

public filesize(string $path): int

Parameters

Parameter	Type	Description
$path	string

fileperms

Return permission metadata for a backend path when available.

public fileperms(string $path): int

Parameters

Parameter	Type	Description
$path	string

chmod

Update permission metadata for a backend path when supported.

public chmod(string $path, int $mode): bool

Parameters

Parameter	Type	Description
$path	string
$mode	int

chown

Update owner metadata for a backend path when supported.

public chown(string $path, string $user): bool

Parameters

Parameter	Type	Description
$path	string
$user	string

chgrp

Update group metadata for a backend path when supported.

public chgrp(string $path, string $group): bool

Parameters

Parameter	Type	Description
$path	string
$group	string

cwd

Return the current working directory for this backend.

public cwd(): string

unlink

Delete a file at the supplied backend path.

public unlink(string $path): bool

Parameters

Parameter	Type	Description
$path	string

mimeContentType

Mime content type.

public mimeContentType(string $path): ?string

Parameters

Parameter	Type	Description
$path	string

md5Checksum

Md5 checksum.

public md5Checksum(string $path): ?string

Parameters

Parameter	Type	Description
$path	string

thumbnailURL

Get the URL to a thumbnail of the file.

public thumbnailURL(string $path, int $width = 100, int $height = 100, string $format = 'jpeg', array $params): string

Parameters

Parameter	Type	Description
$path	string
$width	int
$height	int
$format	string
$params	array

mkdir

Create a directory at the supplied backend path.

public mkdir(string $path): bool

Parameters

Parameter	Type	Description
$path	string

rmdir

Remove a directory at the supplied backend path.

public rmdir(string $path, bool $recurse): bool

Parameters

Parameter	Type	Description
$path	string
$recurse	bool

copy

Copy a file or directory within backend storage.

public copy(string $src, string $dst, bool $overwrite): bool

Parameters

Parameter	Type	Description
$src	string
$dst	string
$overwrite	bool

link

Create a link or alias to a backend object when supported.

public link(string $src, string $dst): bool

Parameters

Parameter	Type	Description
$src	string
$dst	string

move

Move or rename a backend object.

public move(string $src, string $dst, bool $overwrite): bool

Parameters

Parameter	Type	Description
$src	string
$dst	string
$overwrite	bool

read

Read and return file contents from backend storage.

public read(string $path, int $offset = -1, ?int $maxlen): string

Parameters

Parameter	Type	Description
$path	string
$offset	int
$maxlen	int

write

Write content to a backend path and return bytes written.

public write(string $path, string $data, ?string $contentType, bool $overwrite): ?int

Parameters

Parameter	Type	Description
$path	string
$data	string
$contentType	string
$overwrite	bool

upload

Upload a file that was uploaded with a POST.

public upload(string $path, array $file, bool $overwrite = true): bool

Parameters

Parameter	Type	Description
$path	string
$file	array
$overwrite	bool

getMeta

Get the meta.

public getMeta(string $path, ?string $key, string $): void

Parameters

Parameter	Type	Description
$path	string
$key	string
$	string

setMeta

public setMeta(string $path, array $values): bool

Parameters

Parameter	Type	Description
$path	string
$values	array

previewURL

public previewURL(string $path, array $params): string

Parameters

Parameter	Type	Description
$path	string
$params	array

directURL

Direct u r l.

public directURL(string $path): string

Parameters

Parameter	Type	Description
$path	string

authorised

Check whether this backend currently has valid authorization credentials.

public authorised(): bool

authorise

Run the authorization flow required by the remote backend service.

public authorise(?string $redirectUri): bool

Parameters

Parameter	Type	Description
$redirectUri	string

authoriseWithCode

Authorise with code.

public authoriseWithCode(string $code, ?string $redirectUri, string $grantType = 'authorization_code'): bool

Parameters

Parameter	Type	Description
$code	string
$redirectUri	string
$grantType	string

buildAuthURL

Build auth u r l.

public buildAuthURL(?string $callbackUrl): ?string

Parameters

Parameter	Type	Description
$callbackUrl	string

openStream

Open stream.

public openStream(string $path, string $mode): mixed

Parameters

Parameter	Type	Description
$path	string
$mode	string

writeStream

public writeStream(resource $stream, string $bytes, ?int $length): int

Parameters

Parameter	Type	Description
$stream	resource
$bytes	string
$length	int

readStream

public readStream(resource $stream, int $length): string

Parameters

Parameter	Type	Description
$stream	resource
$length	int

seekStream

public seekStream(mixed $stream, int $offset, int $whence = 'SEEK_SET'): int

Parameters

Parameter	Type	Description
$stream	mixed
$offset	int
$whence	int

tellStream

public tellStream(mixed $stream): int

Parameters

Parameter	Type	Description
$stream	mixed

eofStream

public eofStream(mixed $stream): bool

Parameters

Parameter	Type	Description
$stream	mixed

truncateStream

public truncateStream(mixed $stream, int $size): bool

Parameters

Parameter	Type	Description
$stream	mixed
$size	int

lockStream

public lockStream(mixed $stream, int $operation, ?int $wouldblock): bool

Parameters

Parameter	Type	Description
$stream	mixed
$operation	int
$wouldblock	int

flushStream

public flushStream(mixed $stream): bool

Parameters

Parameter	Type	Description
$stream	mixed

getsStream

public getsStream(mixed $stream, ?int $length): string

Parameters

Parameter	Type	Description
$stream	mixed
$length	int

closeStream

public closeStream(resource $stream): bool

Parameters

Parameter	Type	Description
$stream	resource

find

Search backend storage for entries matching the supplied pattern.

public find(?string $search, string $path = '/', bool $caseInsensitive, false $): void

Parameters

Parameter	Type	Description
$search	string
$path	string
$caseInsensitive	bool
$	false

fsck

Run a backend consistency check and return diagnostic results.

public fsck(bool $skipRoot_reload): bool

Parameters

Parameter	Type	Description
$skipRoot_reload	bool

info

private info(string $path, bool $forceUpdate, false $): void

Parameters

Parameter	Type	Description
$path	string
$forceUpdate	bool
$	false

updateMeta

Update meta.

private updateMeta(string $path): bool

Parameters

Parameter	Type	Description
$path	string

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:24 +0000