PHP Class Mnemo_Driver_Kolab, horde

Copyright 2004-2015 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/apache.
Author: Gunnar Wrobel ([email protected])
Author: Thomas Jarosch ([email protected])
Author: Stuart Binge ([email protected])
Inheritance: extends Mnemo_Driver
Afficher le fichier Open project: horde/horde

Méthodes publiques

Méthode Description
__construct ( string $notepad, array $params = [] ) Construct a new Kolab storage object.
get ( string $noteId, string $passphrase = null ) : array Retrieves one note from the backend.
getByUID ( string $uid, string $passphrase = null ) : array Retrieves one note from the backend by UID.
retrieve ( ) Retrieves all of the notes of the current notepad from the backend.
synchronize ( mixed $token = false ) Synchronize with the Kolab backend.

Méthodes protégées

Méthode Description
_add ( string $noteId, string $desc, string $body, string $tags ) : string Adds a note to the backend storage.
_buildNote ( array $note, string $passphrase = null ) : array Build a note based on data array
_buildObject ( string $noteId, string $desc, string $body, string $tags ) : object Converts a note hash to a Kolab hash.
_delete ( $noteId ) : string Deletes a note permanently.
_deleteAll ( ) : array Deletes all notes from the current notepad.
_generateId ( ) : string Generates a local note ID.
_getData ( boolean $force = false ) : Horde_Kolab_Storage_Data Return the Kolab data handler for the current notepad.
_getDataForNotepad ( string $notepad ) : Horde_Kolab_Storage_Data Return the Kolab data handler for the specified notepad.
_modify ( string $noteId, string $desc, string $body, string $tags ) : string Modifies an existing note.
_move ( string $noteId, string $newNotepad ) : string Moves a note to a new notepad.

Method Details

__construct() public méthode

Construct a new Kolab storage object.
public __construct ( string $notepad, array $params = [] )
$notepad string The name of the notepad to load/save notes from.
$params array The connection parameters

_add() protected méthode

Adds a note to the backend storage.
protected _add ( string $noteId, string $desc, string $body, string $tags ) : string
$noteId string The ID of the new note.
$desc string The first line of the note.
$body string The whole note body.
$tags string The tags of the note.
Résultat string The unique ID of the new note.

_buildNote() protected méthode

Build a note based on data array
protected _buildNote ( array $note, string $passphrase = null ) : array
$note array The data for the note
$passphrase string A passphrase for decrypting a note
Résultat array The converted data array representing the note

_buildObject() protected méthode

Converts a note hash to a Kolab hash.
protected _buildObject ( string $noteId, string $desc, string $body, string $tags ) : object
$noteId string The note to modify.
$desc string The first line of the note.
$body string The whole note body.
$tags string The tags of the note.
Résultat object The Kolab hash.

_delete() protected méthode

Deletes a note permanently.
protected _delete ( $noteId ) : string
Résultat string The note's UID.

_deleteAll() protected méthode

Deletes all notes from the current notepad.
protected _deleteAll ( ) : array
Résultat array An array of uids that have been removed.

_generateId() protected méthode

Generates a local note ID.
protected _generateId ( ) : string
Résultat string A new note ID.

_getData() protected méthode

Return the Kolab data handler for the current notepad.
protected _getData ( boolean $force = false ) : Horde_Kolab_Storage_Data
$force boolean Force returning a new handler.
Résultat Horde_Kolab_Storage_Data The data handler.

_getDataForNotepad() protected méthode

Return the Kolab data handler for the specified notepad.
protected _getDataForNotepad ( string $notepad ) : Horde_Kolab_Storage_Data
$notepad string The notepad name.
Résultat Horde_Kolab_Storage_Data The data handler.

_modify() protected méthode

Modifies an existing note.
protected _modify ( string $noteId, string $desc, string $body, string $tags ) : string
$noteId string The note to modify.
$desc string The first line of the note.
$body string The whole note body.
$tags string The tags of the note.
Résultat string The note's UID.

_move() protected méthode

Moves a note to a new notepad.
protected _move ( string $noteId, string $newNotepad ) : string
$noteId string The note to move.
$newNotepad string The new notepad.
Résultat string The note's UID.

get() public méthode

Retrieves one note from the backend.
public get ( string $noteId, string $passphrase = null ) : array
$noteId string The ID of the note to retrieve.
$passphrase string A passphrase with which this note was supposed to be encrypted.
Résultat array The array of note attributes.

getByUID() public méthode

Retrieves one note from the backend by UID.
public getByUID ( string $uid, string $passphrase = null ) : array
$uid string The UID of the note to retrieve.
$passphrase string A passphrase with which this note was supposed to be encrypted.
Résultat array The array of note attributes.

retrieve() public méthode

Retrieves all of the notes of the current notepad from the backend.
public retrieve ( )

synchronize() public méthode

Synchronize with the Kolab backend.
public synchronize ( mixed $token = false )
$token mixed A value indicating the last synchronization point, if available.