• Home
  • Mnemo_Driver_Sql

PHP Class Mnemo_Driver_Sql, horde

Copyright 2001-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: Chuck Hagenbuch ([email protected])
Author: Michael J. Rubinsky ([email protected])
Inheritance: extends Mnemo_Driver
Datei anzeigen Open project: horde/horde

Protected Properties

Property Type Description
$_charset string Charset
$_column Horde_Db_Adapter_Base_Column Column definition of body column.
$_db Horde_Db_Adapter The database connection object.

Public Methods

Method Description
__construct ( string $notepad, array $params = [] ) Construct a new SQL 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.

Protected Methods

Method Description
_add ( string $noteId, string $desc, string $body, string $tags ) : string Adds a note to the backend storage.
_buildNote ( array $row, string $passphrase = null ) : array
_delete ( $noteId ) : string Deletes a note permanently.
_deleteAll ( ) : array Deletes all notes from the current notepad.
_generateId ( ) : string Generates a local note ID.
_modify ( string $noteId, string $desc, string $body, string $tags ) Modifies an existing note.
_move ( string $noteId, string $newNotepad ) : string Moves a note to a new notepad.

Method Details

__construct() public method

Construct a new SQL 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 method

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

_buildNote() protected method

protected _buildNote ( array $row, string $passphrase = null ) : array
$row array Hash of the note data, db keys.
$passphrase string The encryption passphrase.
return array a Note hash.

_delete() protected method

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

_deleteAll() protected method

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

_generateId() protected method

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

_modify() protected method

Modifies an existing note.
protected _modify ( string $noteId, string $desc, string $body, string $tags )
$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.

_move() protected method

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

get() public method

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

getByUID() public method

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

retrieve() public method

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

Property Details

$_charset protected_oe property

Charset
protected string $_charset
return string

$_column protected_oe property

Column definition of body column.
protected Horde_Db_Adapter_Base_Column $_column
return Horde_Db_Adapter_Base_Column

$_db protected_oe property

The database connection object.
protected Horde_Db_Adapter $_db
return Horde_Db_Adapter