Documentation

Horde_Dav_Collection extends Collection
in package
implements IProperties

A collection (directory) object.

Tags
author

Jan Schneider jan@horde.org

category

Horde

copyright

2013-2017 Horde LLC

license

http://www.horde.org/licenses/bsd BSD

Interfaces, Classes, Traits and Enums

IProperties

Table of Contents

$_item  : array<string|int, mixed>
Collection details.
$_mimedb  : string
The path to a MIME magic database.
$_path  : string
The path to the current collection.
$_propertyMap  : array<string|int, mixed>
Mapping of WebDAV property names to Horde API's browse() properties.
$_registry  : Horde_Registry
A registry object.
__construct()  : mixed
Constructor.
createFile()  : null|string
Creates a new file in the directory
getChildren()  : array<string|int, INode>
Returns an array with all the child nodes
getLastModified()  : int
Returns the last modification time, as a unix timestamp
getName()  : string
Returns the name of the node.
getProperties()  : void
Returns a list of properties for this nodes.
propPatch()  : mixed
updateProperties()  : bool|array<string|int, mixed>
Updates properties on this node.

Properties

$_item

Collection details.

protected array<string|int, mixed> $_item

$_mimedb

The path to a MIME magic database.

protected string $_mimedb

$_path

The path to the current collection.

protected string $_path

$_propertyMap

Mapping of WebDAV property names to Horde API's browse() properties.

protected static array<string|int, mixed> $_propertyMap = array('{DAV:}getcontentlength' => 'contentlength', '{DAV:}getcontenttype' => 'contentype', '{DAV:}getetag' => 'etag', '{DAV:}owner' => 'owner', '{http://sabredav.org/ns}read-only' => 'read-only')

$_registry

A registry object.

protected Horde_Registry $_registry

Methods

__construct()

Constructor.

public __construct([string $path = null ][, array<string|int, mixed> $item = array() ], Horde_Registry $registry, string $mimedb) : mixed
Parameters
$path : string = null

The path to this collection.

$item : array<string|int, mixed> = array()

Collection details.

$registry : Horde_Registry

A registry object.

$mimedb : string

Location of a MIME magic database.

Return values
mixed

createFile()

Creates a new file in the directory

public createFile(string $name[, resource|string $data = null ]) : null|string
Parameters
$name : string

Name of the file

$data : resource|string = null

Initial payload

Return values
null|string

getChildren()

Returns an array with all the child nodes

public getChildren() : array<string|int, INode>
Return values
array<string|int, INode>

getLastModified()

Returns the last modification time, as a unix timestamp

public getLastModified() : int
Return values
int

getName()

Returns the name of the node.

public getName() : string

This is used to generate the url.

Return values
string

getProperties()

Returns a list of properties for this nodes.

public getProperties(array<string|int, mixed> $properties) : void
Parameters
$properties : array<string|int, mixed>
Return values
void

propPatch()

public propPatch(PropPatch $propPatch) : mixed
Parameters
$propPatch : PropPatch
Return values
mixed

updateProperties()

Updates properties on this node.

public updateProperties(array<string|int, mixed> $mutations) : bool|array<string|int, mixed>
Parameters
$mutations : array<string|int, mixed>
Return values
bool|array<string|int, mixed>

Search results