\Oxws_Notes

Functions related to remarks

Summary

Methods
Properties
Constants
getConfig()
getDb()
insertNote()
insertNotes()
updateNote()
updateNotes()
deleteNote()
deleteNotes()
No public properties found
No constants found
No protected methods found
$myConfig
$oDb
N/A
No private methods found
No private properties found
N/A

Properties

$myConfig

$myConfig : object

Config object

Type

object

$oDb

$oDb : object

Database object

Type

object

Methods

getConfig()

getConfig() : object

Function to get config object

Returns

object

getDb()

getDb() : object

Function to get database object

Returns

object

insertNote()

insertNote(\JSONstring  $remark) : boolean

Function to insert note

Parameters

\JSONstring $remark

json string with remark details as key=>value pairs to insert. Ex: 'oxparentid'=>'xxxxx', 'oxtext'=>'xxxxx'.

Returns

boolean

insertNotes()

insertNotes(\JSONstring  $remarks) : null

Function to insert multiple notes

Parameters

\JSONstring $remarks

json string with remarks details as key=>value pairs to insert. Ex: 'oxparentid'=>'xxxxx', 'oxtext'=>'xxxxx'.

Returns

null

updateNote()

updateNote(\JSONstring  $remarkData) : boolean

Function to update note

Parameters

\JSONstring $remarkData

json string with remark details as key=>value pairs to update. Ex: 'oxid'=>'xxxxx', 'oxtext'=>'xxxxx'.

Returns

boolean

updateNotes()

updateNotes(\JSONstring  $remarks) : null

Function to update multiple notes

Parameters

\JSONstring $remarks

json string with remarks details as key=>value pairs to update. Ex: 'oxid'=>'xxxxx', 'oxtext'=>'xxxxx'.

Returns

null

deleteNote()

deleteNote(string  $noteId) : boolean

Function to delete a note

Parameters

string $noteId

NoteId to delete

Returns

boolean

deleteNotes()

deleteNotes(array  $noteIds) : null

Function to delete multiple notes

Parameters

array $noteIds

noteIds to be deleted

Returns

null