API Documentation
\

\Horde_Kolab_Storage_Driver_Mock_Data

Data storage for the mock driver.

Copyright 2010-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
offsetGet()
offsetSet()
offsetExists()
offsetUnset()
arrayKeys()
hasPermissions()
getPermissions()
hasUserPermissions()
getUserPermissions()
setUserPermissions()
deleteUserPermissions()
hasAnnotation()
getAnnotation()
setAnnotation()
deleteAnnotation()
select()
status()
getUids()
_notDeleted()
fetchComplete()
fetchStructure()
fetchBodypart()
appendMessage()
deleteMessages()
moveMessage()
expunge()
No public properties found
FLAG_DELETED
No protected methods found
No protected properties found
N/A
_convertBrief()
$_data
$_selected
N/A

Constants

FLAG_DELETED

FLAG_DELETED

Flag to indicated a deleted message

Properties

$_data

$_data : array

The data array.

Type

array

$_selected

$_selected : string

The currently selected folder.

Type

string

Methods

__construct()

__construct(array  $data)

Constructor.

Parameters

array $data

This may be match the internal format used by this class to represent the IMAP mock data or it can be an abbreviated format (@see Horde_Kolab_Storage_Driver_Mock_Data::_setupBrief).

offsetGet()

offsetGet(string|integer  $offset) : mixed

Returns the value of the given offset in this array.

Parameters

string|integer $offset

The array offset.

Returns

mixed —

The data value.

offsetSet()

offsetSet(\mi  $offset,   $value) : NULL

Sets the value of the given offset in this array.

Parameters

\mi $offset

The array offset.
$value

Returns

NULL

offsetExists()

offsetExists(string|integer  $offset) : boolean

Tests if the value of the given offset exists in this array.

Parameters

string|integer $offset

The array offset.

Returns

boolean —

True if the offset exists.

offsetUnset()

offsetUnset(string|integer  $offset) : NULL

Removes the given offset exists from this array.

Parameters

string|integer $offset

The array offset.

Returns

NULL

arrayKeys()

arrayKeys() : array

Returns the array keys of this array.

Returns

array —

The keys of this array.

hasPermissions()

hasPermissions(  $folder)

Parameters

$folder

getPermissions()

getPermissions(  $folder)

Parameters

$folder

hasUserPermissions()

hasUserPermissions(  $folder,   $user)

Parameters

$folder
$user

getUserPermissions()

getUserPermissions(  $folder,   $user)

Parameters

$folder
$user

setUserPermissions()

setUserPermissions(  $folder,   $user,   $acl)

Parameters

$folder
$user
$acl

deleteUserPermissions()

deleteUserPermissions(  $folder,   $user)

Parameters

$folder
$user

hasAnnotation()

hasAnnotation(  $folder,   $annotation)

Parameters

$folder
$annotation

getAnnotation()

getAnnotation(  $folder,   $annotation)

Parameters

$folder
$annotation

setAnnotation()

setAnnotation(  $folder,   $annotation,   $value)

Parameters

$folder
$annotation
$value

deleteAnnotation()

deleteAnnotation(  $folder,   $annotation)

Parameters

$folder
$annotation

select()

select(  $folder)

Parameters

$folder

status()

status(  $folder)

Parameters

$folder

getUids()

getUids(  $folder)

Parameters

$folder

_notDeleted()

_notDeleted(array  $message) : boolean

Indicates if a message is considered deleted.

Parameters

array $message

The message information.

Returns

boolean —

True if the message has not been marked as deleted.

fetchComplete()

fetchComplete(  $folder,   $uid)

Parameters

$folder
$uid

fetchStructure()

fetchStructure(string  $folder, array  $uids) : array

Retrieves the messages for the given message ids.

Parameters

string $folder

The folder to fetch the messages from.
array $uids

The message UIDs.

Returns

array —

An array of message structures parsed into Horde_Mime_Part instances.

fetchBodypart()

fetchBodypart(string  $folder, array  $uid, array  $id) : resource

Retrieves a bodypart for the given message ID and mime part ID.

Parameters

string $folder

The folder to fetch the messages from.
array $uid

The message UID.
array $id

The mime part ID.

Returns

resource —

The body part, as a stream resource.

appendMessage()

appendMessage(string  $folder, resource  $msg) : mixed

Appends a message to the given folder.

Parameters

string $folder

The folder to append the message(s) to.
resource $msg

The message to append.

Returns

mixed —

True or the UID of the new message in case the backend supports UIDPLUS.

deleteMessages()

deleteMessages(  $folder,   $uids)

Parameters

$folder
$uids

moveMessage()

moveMessage(  $uid,   $old_folder,   $new_folder)

Parameters

$uid
$old_folder
$new_folder

expunge()

expunge(  $folder)

Parameters

$folder

_convertBrief()

_convertBrief(array  $data)

Generate the internal mock data representation from an abbreviated mock data format.

Parameters

array $data

The abbreviated data format.