Class Mnemo_Driver_Kolab
Horde Mnemo driver for the Kolab_Storage backend.
Copyright 2004-2012 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.
-
Mnemo_Driver
-
Mnemo_Driver_Kolab
Methods summary
public
|
#
__construct( string $notepad, array $params = array() )
Construct a new Kolab storage object.
Construct a new Kolab storage object.
Parameters
- $notepad
- The name of the notepad to load/save notes from.
- $params
- The connection parameters
Throws
InvalidArguementException
|
public
array
|
#
get( string $noteId, string $passphrase = null )
Retrieve one note from the store.
Retrieve one note from the store.
Parameters
- $noteId
- The ID of the note to retrieve.
- $passphrase
- <p>A passphrase with which this note was
supposed to be encrypted.</p>
Returns
array
The array of note attributes.
|
public
array
|
#
getByUID( string $uid, string $passphrase = null )
Retrieve one note by UID.
Retrieve one note by UID.
Parameters
- $uid
- The UID of the note to retrieve.
- $passphrase
- <p>A passphrase with which this note was
supposed to be encrypted.</p>
Returns
array
The array of note attributes.
|
public
string
|
#
add( string $desc, string $body, string $category = '', string $uid = null, string $passphrase = null )
Add a note to the backend storage.
Add a note to the backend storage.
Parameters
- $desc
- The first line of the note.
- $body
- The whole note body.
- $category
- The category of the note.
- $uid
- A Unique Identifier for the note.
- $passphrase
- The passphrase to encrypt the note with.
Returns
string
The unique ID of the new note.
Throws
|
public
booelan
|
#
modify( integer $noteId, string $desc, string $body, string $category = '', string $passphrase = null )
Modify an existing note.
Parameters
- $noteId
- The note to modify.
- $desc
- The description (long) of the note.
- $body
- The description (long) of the note.
- $category
- The category of the note.
- $passphrase
- The passphrase to encrypt the note with.
Returns
booelan
|
public
mixed
|
#
move( string $noteId, string $newNotepad )
Move a note to a new notepad.
Move a note to a new notepad.
Parameters
- $noteId
- The note to move.
- $newNotepad
- The new notepad.
Returns
mixed
True on success, PEAR_Error on failure.
|
public
null
|
#
delete( string $noteId )
Delete the specified note from the current notepad
Delete the specified note from the current notepad
Parameters
- $noteId
- The note to delete.
Returns
null
|
public
null
|
#
deleteAll( )
Delete all notes from the current notepad
Delete all notes from the current notepad
Returns
null
|
public
null
|
#
retrieve( )
Retrieves all of the notes from $this->_notepad from the database.
Retrieves all of the notes from $this->_notepad from the database.
Returns
null
Throws
|
public
array
|
#
_buildNote( array $note, string $passphrase = null )
Build a note based on data array
Build a note based on data array
Parameters
- $note
- The data for the note
- $passphrase
- A passphrase for decrypting a note
Returns
array
The converted data array representing the note
|