• 홈
  • Mnemo_Driver_Kolab

PHP 클래스 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.
저자: Gunnar Wrobel ([email protected])
저자: Thomas Jarosch ([email protected])
저자: Stuart Binge ([email protected])
상속: extends Mnemo_Driver
파일 보기 프로젝트 열기: horde/horde

공개 메소드들

메소드 설명
__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.

보호된 메소드들

메소드 설명
_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.

메소드 상세

__construct() 공개 메소드

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() 보호된 메소드

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.
리턴 string The unique ID of the new note.

_buildNote() 보호된 메소드

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
리턴 array The converted data array representing the note

_buildObject() 보호된 메소드

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.
리턴 object The Kolab hash.

_delete() 보호된 메소드

Deletes a note permanently.
protected _delete ( $noteId ) : string
리턴 string The note's UID.

_deleteAll() 보호된 메소드

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

_generateId() 보호된 메소드

Generates a local note ID.
protected _generateId ( ) : string
리턴 string A new note ID.

_getData() 보호된 메소드

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.
리턴 Horde_Kolab_Storage_Data The data handler.

_getDataForNotepad() 보호된 메소드

Return the Kolab data handler for the specified notepad.
protected _getDataForNotepad ( string $notepad ) : Horde_Kolab_Storage_Data
$notepad string The notepad name.
리턴 Horde_Kolab_Storage_Data The data handler.

_modify() 보호된 메소드

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.
리턴 string The note's UID.

_move() 보호된 메소드

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.
리턴 string The note's UID.

get() 공개 메소드

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.
리턴 array The array of note attributes.

getByUID() 공개 메소드

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.
리턴 array The array of note attributes.

retrieve() 공개 메소드

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

synchronize() 공개 메소드

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