Manager

About 5 min

Manager

Properties

default_config

public array $default_config = array (
  'enabled' => true,
  'auth' => false,
  'allow' => 
  array (
    'read' => false,
    0 => NULL,
    'cmd' => false,
    1 => NULL,
    'dir' => true,
    2 => NULL,
    'filebrowser' => false,
    3 => NULL,
  ),
  'userdef' => 
  array (
  ),
  'failover' => false,
  'log' => false,
)

name

public string $name

mime_types

public array $mime_types

backend_aliases

private array $backend_aliases = array (
  'googledrive' => 'GoogleDrive',
  'sharepoint' => 'SharePoint',
  'webdav' => 'WebDAV',
)

default_backend

private string $default_backend = 'local'

default_backend_options

private array $default_backend_options

backend

private Backend $backend

backendName

private string $backendName

options

private array $options

failover

public Manager $failover

in_failover

private bool $in_failover

Methods

__construct

Manager constructor.

public __construct(?string $backend, array $backend_options = [], ?string $name): void

Parameters

Parameter	Type	Description
`$backend`	`string`
`$backend_options`	`array`
`$name`	`string`

__destruct

public __destruct(): void

getAvailableBackends

public getAvailableBackends(false $): void

Parameters

Parameter	Type	Description
`$`	`false`

select

public select(string $name, ?array $options): Manager

Parameters

Parameter	Type	Description
`$name`	`string`
`$options`	`array`

refresh

public refresh(bool $reset = false): bool

Parameters

Parameter	Type	Description
`$reset`	`bool`

configure

public configure(string $backend, array $options): void

Parameters

Parameter	Type	Description
`$backend`	`string`
`$options`	`array`

activateFailover

public activateFailover(): void

failoverSync

public failoverSync(): bool

getBackend

public getBackend(): Backend

getBackendName

public getBackendName(): string

setOption

public setOption(string $name, mixed $value): void

Parameters

Parameter	Type	Description
`$name`	`string`
`$value`	`mixed`

getOption

public getOption(string $name): mixed

Parameters

Parameter	Type	Description
`$name`	`string`

fixPath

public fixPath(string $path, ?string $file): string

Parameters

Parameter	Type	Description
`$path`	`string`
`$file`	`string`

authorise

public authorise(?string $redirect_uri): bool

Parameters

Parameter	Type	Description
`$redirect_uri`	`string`

authorize

Alias to authorise() which is the CORRECT spelling.

public authorize(?string $redirect_uri): mixed

Parameters

Parameter	Type	Description
`$redirect_uri`	`string`

authorised

public authorised(): bool

authorized

public authorized(): bool

reset

public reset(): bool

buildAuthURL

public buildAuthURL(?string $callback_url): ?string

Parameters

Parameter	Type	Description
`$callback_url`	`string`

get

Return a file object for a given path.

public get(mixed $path): void

Parameters

Parameter	Type	Description
`$path`	`mixed`	The path to a file object

dir

Return a directory object for a given path.

public dir(string $path = '/'): void

Parameters

Parameter	Type	Description
`$path`	`string`	The path to a directory object

toArray

Return a directory object for a given path.

public toArray(string $path, int $sort = 'SCANDIR_SORT_ASCENDING', bool $allow_hidden = false): void

Parameters

Parameter	Type	Description
`$path`	`string`
`$sort`	`int`
`$allow_hidden`	`bool`

find

Return a directory object for a given path.

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

Parameters

Parameter	Type	Description
`$search`	`string`
`$path`	`string`
`$case_insensitive`	`bool`

exists

public exists(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

read

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

Parameters

Parameter	Type	Description
`$file`	`string`
`$offset`	`int`
`$maxlen`	`int`

write

public write(string $file, string $data, ?string $content_type, bool $overwrite = false): ?int

Parameters

Parameter	Type	Description
`$file`	`string`
`$data`	`string`
`$content_type`	`string`
`$overwrite`	`bool`

upload

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

Parameters

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

store

public store(string $source, string $target): bool

Parameters

Parameter	Type	Description
`$source`	`string`
`$target`	`string`

copy

public copy(string $src, string $dst, bool $recursive = false, ?Manager $srcManager, ?\Closure $callback): bool

Parameters

Parameter	Type	Description
`$src`	`string`
`$dst`	`string`
`$recursive`	`bool`
`$srcManager`	`Manager`
`$callback`	`\Closure`

move

public move(string $src, string $dst, ?Manager $srcManager): bool

Parameters

Parameter	Type	Description
`$src`	`string`
`$dst`	`string`
`$srcManager`	`Manager`

mkdir

public mkdir(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

rmdir

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

Parameters

Parameter	Type	Description
`$path`	`string`
`$recurse`	`bool`

unlink

public unlink(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

isEmpty

public isEmpty(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

filesize

public filesize(string $path): int

Parameters

Parameter	Type	Description
`$path`	`string`

fsck

public fsck(bool $skipRootReload = false): bool

Parameters

Parameter	Type	Description
`$skipRootReload`	`bool`

thumbnailURL

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`

link

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

Parameters

Parameter	Type	Description
`$src`	`string`
`$dst`	`string`

getMeta

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`

url

public url(?string $path): URL

Parameters

Parameter	Type	Description
`$path`	`string`

scandir

public scandir(string $path, ?string $regex_filter, int $sort = 'SCANDIR_SORT_ASCENDING', bool $show_hidden = false, ?string $relative_path, false $): void

Parameters

Parameter	Type	Description
`$path`	`string`
`$regex_filter`	`string`
`$sort`	`int`
`$show_hidden`	`bool`
`$relative_path`	`string`
`$`	`false`

touch

public touch(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

realpath

public realpath(string $path): ?string

Parameters

Parameter	Type	Description
`$path`	`string`

isReadable

public isReadable(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

isWritable

public isWritable(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

isDir

public isDir(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

isLink

public isLink(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

isFile

public isFile(string $path): bool

Parameters

Parameter	Type	Description
`$path`	`string`

filetype

public filetype(string $path): string

Parameters

Parameter	Type	Description
`$path`	`string`

filectime

public filectime(string $path): int

Parameters

Parameter	Type	Description
`$path`	`string`

filemtime

public filemtime(string $path): int

Parameters

Parameter	Type	Description
`$path`	`string`

fileatime

public fileatime(string $path): int

Parameters

Parameter	Type	Description
`$path`	`string`

fileperms

public fileperms(string $path): int

Parameters

Parameter	Type	Description
`$path`	`string`

chmod

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

Parameters

Parameter	Type	Description
`$path`	`string`
`$mode`	`int`

chown

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

Parameters

Parameter	Type	Description
`$path`	`string`
`$user`	`string`

chgrp

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

Parameters

Parameter	Type	Description
`$path`	`string`
`$group`	`string`

cwd

public cwd(): string

mimeContentType

public mimeContentType(string $path): ?string

Parameters

Parameter	Type	Description
`$path`	`string`

md5Checksum

public md5Checksum(string $path): ?string

Parameters

Parameter	Type	Description
`$path`	`string`

previewURL

public previewURL(string $path, array $params = []): string

Parameters

Parameter	Type	Description
`$path`	`string`
`$params`	`array`

directURL

public directURL(string $path): string

Parameters

Parameter	Type	Description
`$path`	`string`

openStream

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`

lookupContentType

public lookupContentType(string $extension): ?string

Parameters

Parameter	Type	Description
`$extension`	`string`

deepCopy

private deepCopy(string $src, string $dst, Manager $srcManager, ?\Closure $progressCallback): bool

Parameters

Parameter	Type	Description
`$src`	`string`
`$dst`	`string`
`$srcManager`	`Manager`
`$progressCallback`	`\Closure`

Generated by Hazaar API Doc Generator