• 홈
  • Mnemo_Driver

PHP 클래스 Mnemo_Driver, horde

Copyright 2001-2016 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.
저자: Jon Parise ([email protected])
저자: Michael J. Rubinsky ([email protected])
파일 보기 프로젝트 열기: horde/horde

보호된 프로퍼티들

프로퍼티 타입 설명
$_memos array Array holding the current memo list. Each array entry is a hash describing a memo. The array is indexed numerically by memo ID.
$_notepad string String containing the current notepad name.
$_pgp Horde_Crypt_pgp Crypting processor.

공개 메소드들

메소드 설명
add ( string $desc, string $body, string $tags = '', string $passphrase = null ) : string Adds a note to the backend storage.
delete ( string $noteId ) Deletes a note permanently.
deleteAll ( ) Deletes all notes from the current notepad.
encryptionSupported ( ) : boolean Returns whether note encryption is supported.
fromiCalendar ( Horde_Icalendar_Vnote $vNote ) : array Create a memo (hash array) from a Horde_Icalendar_Vnote 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.
getMemoDescription ( $body ) Update the description (short summary) of a memo.
listMemos ( ) : array Lists memos based on the given criteria. All memos will be returned by default.
modify ( string $noteId, string $desc, string $body, string $tags = '', string $passphrase = null ) Modifies an existing note.
move ( string $noteId, string $newNotepad ) Moves a note to a new notepad.
retrieve ( ) Retrieves all of the notes of the current notepad from the backend.
synchronize ( mixed $token = false ) Perform any synchronization with backend data handlers that may be necessary for the driver.
toASNote ( array $memo, array $options = [] ) : Horde_ActiveSync_Message_Note Create an AS memo from this task
toiCalendar ( $memo, $calendar ) : Horde_Icalendar_Vnote Export this memo in iCalendar format.

보호된 메소드들

메소드 설명
_add ( string $noteId, string $desc, string $body, string $tags ) : string Adds a note to the backend storage.
_decrypt ( string $note, string $passphrase ) : string Decrypts a note.
_delete ( $noteId ) : string Deletes a note permanently.
_deleteAll ( ) : array Deletes all notes from the current notepad.
_encrypt ( string $note, string $passphrase ) : string Encrypts a note.
_generateId ( ) : string Generates a local note ID.
_loadPGP ( ) Loads the PGP encryption driver.
_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.

메소드 상세

_add() 추상적인 보호된 메소드

Adds a note to the backend storage.
abstract 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.

_decrypt() 보호된 메소드

Decrypts a note.
protected _decrypt ( string $note, string $passphrase ) : string
$note string The encrypted note text.
$passphrase string The passphrase to decrypt the note with.
리턴 string The decrypted text.

_delete() 추상적인 보호된 메소드

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

_deleteAll() 추상적인 보호된 메소드

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

_encrypt() 보호된 메소드

Encrypts a note.
protected _encrypt ( string $note, string $passphrase ) : string
$note string The note text.
$passphrase string The passphrase to encrypt the note with.
리턴 string The encrypted text.

_generateId() 추상적인 보호된 메소드

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

_loadPGP() 보호된 메소드

Loads the PGP encryption driver.
protected _loadPGP ( )

_modify() 추상적인 보호된 메소드

Modifies an existing note.
abstract 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.
abstract protected _move ( string $noteId, string $newNotepad ) : string
$noteId string The note to move.
$newNotepad string The new notepad.
리턴 string The note's UID.

add() 공개 메소드

Adds a note to the backend storage.
public add ( string $desc, string $body, string $tags = '', string $passphrase = null ) : string
$desc string The first line of the note.
$body string The whole note body.
$tags string The tags of the note.
$passphrase string The passphrase to encrypt the note with.
리턴 string The ID of the new note.

delete() 공개 메소드

Deletes a note permanently.
public delete ( string $noteId )
$noteId string The note to delete.

deleteAll() 공개 메소드

Deletes all notes from the current notepad.
public deleteAll ( )

encryptionSupported() 공개 메소드

Checks if PGP support could be loaded, if it supports symmetric encryption, and if we have a secure connection.
public encryptionSupported ( ) : boolean
리턴 boolean Whether encryption is suppoted.

fromiCalendar() 공개 메소드

Create a memo (hash array) from a Horde_Icalendar_Vnote object.
public fromiCalendar ( Horde_Icalendar_Vnote $vNote ) : array
$vNote Horde_Icalendar_Vnote
리턴 array Memo (hash array) created from the vNote.

get() 추상적인 공개 메소드

Retrieves one note from the backend.
abstract 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.
abstract 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.

getMemoDescription() 공개 메소드

Update the description (short summary) of a memo.
public getMemoDescription ( $body )

listMemos() 공개 메소드

Lists memos based on the given criteria. All memos will be returned by default.
public listMemos ( ) : array
리턴 array Returns a list of the requested memos.

modify() 공개 메소드

Modifies an existing note.
public modify ( string $noteId, string $desc, string $body, string $tags = '', string $passphrase = null )
$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.
$passphrase string The passphrase to encrypt the note with.

move() 공개 메소드

Moves a note to a new notepad.
public move ( string $noteId, string $newNotepad )
$noteId string The note to move.
$newNotepad string The new notepad.

retrieve() 추상적인 공개 메소드

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

synchronize() 공개 메소드

Perform any synchronization with backend data handlers that may be necessary for the driver.
public synchronize ( mixed $token = false )
$token mixed A value indicating the last synchronization point, if available.

toASNote() 공개 메소드

Create an AS memo from this task
public toASNote ( array $memo, array $options = [] ) : Horde_ActiveSync_Message_Note
$memo array A memo array.
$options array
리턴 Horde_ActiveSync_Message_Note

toiCalendar() 공개 메소드

Export this memo in iCalendar format.
public toiCalendar ( $memo, $calendar ) : Horde_Icalendar_Vnote
리턴 Horde_Icalendar_Vnote object for this event.

프로퍼티 상세

$_memos 보호되어 있는 프로퍼티

Array holding the current memo list. Each array entry is a hash describing a memo. The array is indexed numerically by memo ID.
protected array $_memos
리턴 array

$_notepad 보호되어 있는 프로퍼티

String containing the current notepad name.
protected string $_notepad
리턴 string

$_pgp 보호되어 있는 프로퍼티

Crypting processor.
protected Horde_Crypt_pgp $_pgp
리턴 Horde_Crypt_pgp