1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. SystemDMS
  7. \
  8. Hook
  9. \
  10. Webdav
  11. \
  12. WebdavService

WebdavService

class WebdavService extends xm_webdav_service

Class XELOS\Modules\SystemDMS\Hook\Webdav\xm_system_dms_webdav

Properties

SystemDMSController $mod
array $unsupported_methods
string $group_title
protected string $tmp_file_name
protected Document $last_document

Methods

bool|string
categoryPathToId(array $path_parts, int $pid)

No description

string
copy(string $source, string $dest, bool $overwrite = false)

Copy File or Folder

bool|string|array
create_dir(string $working_dir, string $new_dir)

Resource Handler wraps Create Dir/Collection

bool
delete(string $path)

Delete File or Folder

string
document_index_to_path(DocumentIndex $document_index)

Document index to WebDAV path

static string
getETag(Document $document)

No description

array|bool
get_catinfo(int $category_id)

Get Information about category

void
get_directory_listing($info, bool $path = false)

GET method handler for directories This is a very simple mod_index lookalike.

array|bool
get_docinfo($document, $cat_id)

Get properties for a single file/resource

string
get_lockinfo(string $path, array $options = null)

Get lock info

array|bool
get_propinfo(string $path, int|string $depth = 0)

Get Properties for path

string
id_to_path($id, $type = 'category')

No description

init()

Initialization

bool
is_available()

No description

string
move(string $source, string $dest, bool $overwrite = false)

Move File or Folder

bool
onUploadFinished($server)

No description

DocumentIndex|null
path_to_document_index(string $path)

Convert path to document_index

array|bool
path_to_id(string $path, string $what = 'auto')

Path Traversal Function

string|array
read(string $path = null)

Read File / Folder

string
write(string $path, array $params)

Write File

Details

at line 982
bool|string categoryPathToId(array $path_parts, int $pid)

No description

Parameters

array $path_parts
int $pid

Return Value

bool|string

at line 448
string copy(string $source, string $dest, bool $overwrite = false)

Copy File or Folder

Parameters

string $source

path_to_file [always relative]
string $dest destination
bool $overwrite

Overwrite Destination?

Return Value

string

(NEW?) ? "201 Created" : "204 No Content"

at line 182
bool|string|array create_dir(string $working_dir, string $new_dir)

Resource Handler wraps Create Dir/Collection

Parameters

string $working_dir

Current Working Directory (relative to resource)
string $new_dir

New Directory

Return Value

bool|string|array

at line 382
bool delete(string $path)

Delete File or Folder

Parameters

string $path

path_to_file [always relative]

Return Value

bool success?

at line 1051
string document_index_to_path(DocumentIndex $document_index)

Document index to WebDAV path

Parameters

DocumentIndex $document_index

OR id(int)

Return Value

string

at line 1065
static string getETag(Document $document)

No description

Parameters

Document $document

Return Value

string

at line 732
array|bool get_catinfo(int $category_id)

Get Information about category

Parameters

int $category_id

Category ID

Return Value

array|bool

at line 54
void get_directory_listing($info, bool $path = false)

GET method handler for directories This is a very simple mod_index lookalike.

See RFC 2518, Section 8.4 on GET/HEAD for collections

Parameters

$info
bool $path

Return Value

void

function has to handle HTTP response itself

at line 772
array|bool get_docinfo($document, $cat_id)

Get properties for a single file/resource

Parameters

$document
$cat_id

Return Value

array|bool

resource properties

at line 281
string get_lockinfo(string $path, array $options = null)

Get lock info

Parameters

string $path
array $options

Return Value

string

at line 662
array|bool get_propinfo(string $path, int|string $depth = 0)

Get Properties for path

Parameters

string $path

path of directory
int|string $depth

depth of search request (0, 1, infinity)

Return Value

array|bool

at line 832
string id_to_path($id, $type = 'category')

No description

Parameters

$id
$type

Return Value

string

at line 40
init()

Initialization

at line 161
bool is_available()

No description

Return Value

bool

at line 476
string move(string $source, string $dest, bool $overwrite = false)

Move File or Folder

Parameters

string $source

path_to_file [always relative]
string $dest destination
bool $overwrite

Overwrite Destination?

Return Value

string

(NEW?) ? "201 Created" : "204 No Content"

at line 363
bool onUploadFinished($server)

No description

Parameters

$server

Return Value

bool

at line 1028
DocumentIndex|null path_to_document_index(string $path)

Convert path to document_index

Parameters

string $path

Return Value

DocumentIndex|null

at line 934
array|bool path_to_id(string $path, string $what = 'auto')

Path Traversal Function

Parameters

string $path Path
string $what

Return Value

array|bool

[cat_id, file_id]

at line 247
string|array read(string $path = null)

Read File / Folder

Parameters

string $path

path_to_file [always relative]

Return Value

string|array

FS Path

at line 298
string write(string $path, array $params)

Write File

Parameters

string $path

path_to_file [always relative]
array $params

Return Value

string

FS Path