\OCPIAddressBook

Interface IAddressBook

Summary

Methods
Constants
getKey()
getDisplayName()
search()
createOrUpdate()
getPermissions()
delete()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getKey()

getKey() : string

Returns

string —

defining the technical unique key

getDisplayName()

getDisplayName() : mixed

In comparison to getKey() this function returns a human readable (maybe translated) name

Returns

mixed

search()

search(string  $pattern, array  $searchProperties, array  $options, integer  $limit = null, integer  $offset = null) : array

Parameters

string $pattern

which should match within the $searchProperties

array $searchProperties

defines the properties within the query pattern should match

array $options
  • for future use. One should always have options!
integer $limit
integer $offset

Returns

array —

an array of contacts which are arrays of key-value-pairs

createOrUpdate()

createOrUpdate(array  $properties) : array

Parameters

array $properties

this array if key-value-pairs defines a contact

Returns

array —

an array representing the contact just created or updated

getPermissions()

getPermissions() : mixed

Returns

mixed

delete()

delete(object  $id) : boolean

Parameters

object $id

the unique identifier to a contact

Returns

boolean —

successful or not