Documentation

Kolab_Resource
in package

Provides Kolab resource handling.

Tags
author

Steffen Hansen steffen@klaralvdalens-datakonsult.se

author

Gunnar Wrobel wrobel@pardus.de

Table of Contents

_getICal()  : mixed
_getResourceData()  : array<string|int, mixed>|PEAR_Error
Returns the resource policy applying for the given sender
_imapConnect()  : mixed
cleanArray()  : array<string|int, mixed>
Clear information from a date array.
cleanup()  : null
Helper function to clean up after handling an invitation
handleMessage()  : mixed
iCalDate2Kolab()  : string
Conveert iCal dates to Kolab format.
sendITipReply()  : mixed
Send an automated reply.

Methods

_getICal()

public _getICal(mixed $filename) : mixed
Parameters
$filename : mixed
Return values
mixed

_getResourceData()

Returns the resource policy applying for the given sender

public _getResourceData(string $sender, string $resource) : array<string|int, mixed>|PEAR_Error
Parameters
$sender : string

The sender address

$resource : string

The resource

Return values
array<string|int, mixed>|PEAR_Error

An array with "cn", "home server" and the policy.

_imapConnect()

public _imapConnect(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

cleanArray()

Clear information from a date array.

public cleanArray(array<string|int, mixed> $ical_date) : array<string|int, mixed>
Parameters
$ical_date : array<string|int, mixed>

The array to clear.

Return values
array<string|int, mixed>

The cleaned array.

cleanup()

Helper function to clean up after handling an invitation

public cleanup() : null
Return values
null

handleMessage()

public handleMessage(mixed $fqhostname, mixed $sender, mixed $resource, mixed $tmpfname) : mixed
Parameters
$fqhostname : mixed
$sender : mixed
$resource : mixed
$tmpfname : mixed
Return values
mixed

iCalDate2Kolab()

Conveert iCal dates to Kolab format.

public iCalDate2Kolab(array<string|int, mixed> $ical_date[, string $type = ' ' ]) : string

An all day event must have a dd--mm-yyyy notation and not a yyyy-dd-mmT00:00:00z notation Otherwise the event is shown as a 2-day event --> do not try to convert everything to epoch first

Parameters
$ical_date : array<string|int, mixed>

The array to convert.

$type : string = ' '

The type of the date to convert.

Return values
string

The converted date.

sendITipReply()

Send an automated reply.

public sendITipReply(string $cn, string $resource, mixed $itip, int $type, string $organiser, string $uid, bool $is_update[, mixed $comment = null ]) : mixed
Parameters
$cn : string

Common name to be used in the iTip response.

$resource : string

Resource we send the reply for.

$itip : mixed
$type : int

Type of response.

$organiser : string

The event organiser.

$uid : string

The UID of the event.

$is_update : bool

Is this an event update?

$comment : mixed = null
Return values
mixed

Search results