Construct a new Horde_Kolab_Server object.
Horde_Kolab_Server
Horde_Kolab_Server
([array $params = array()])
-
array
$params: Parameter array.
Add a Kolab object.
Kolab_Object|PEAR_Error
&add
(array $info)
-
array
$info: The object to store.
Returns a list of allowed email addresses for the given user.
array|PEAR_Error
addrsForIdOrMail
(string $user)
-
string
$user: The user name.
Redefined in descendants as:
Attempts to return a concrete Horde_Kolab_Server instance based on $driver.
-
mixed
$driver: The type of concrete Horde_Kolab_Server subclass to return.
-
array
$params: A hash containing any additional configuration or connection parameters a subclass might need.
Fetch a Kolab object.
Kolab_Object|PEAR_Error
&fetch
([string $uid = null], [string $type = null])
-
string
$uid: The UID of the object to fetch.
-
string
$type: The type of the object to fetch.
Generates a unique ID for the given information.
string|PEAR_Error
generateUid
(string $type, array $info)
-
string
$type: The type of the object to create.
-
array
$info: Any additional information about the object to create.
Return the root of the UID values on this server.
string
getBaseUid
()
Redefined in descendants as:
Get the groups for this object
array|PEAR_Error
getGroups
(string $uid)
-
string
$uid: The UID of the object to fetch.
Redefined in descendants as:
Identify the GID for the first group found using a specified attribute value.
mixed|PEAR_Error
gidForAttr
(string $attr, string $value, [int $restrict = KOLAB_SERVER_RESULT_SINGLE])
-
string
$attr: The name of the attribute used for searching.
-
string
$value: The desired value of the attribute.
-
int
$restrict: A KOLAB_SERVER_RESULT_* result restriction.
Redefined in descendants as:
Identify the GID for the first group found with the given mail.
mixed|PEAR_Error
gidForMail
(string $mail, [int $restrict = KOLAB_SERVER_RESULT_SINGLE])
-
string
$mail: Search for groups with this mail address.
-
int
$restrict: A KOLAB_SERVER_RESULT_* result restriction.
Generate a hash representation for a list of objects.
array|PEAR_Error
listHash
(string $type, [array $params = null])
-
string
$type: The type of the objects to be listed
-
array
$params: Additional parameters.
List all objects of a specific type
array|PEAR_Error
listObjects
(string $type, [array $params = null])
-
string
$type: The type of the objects to be listed
-
array
$params: Additional parameters.
Identify the primary mail attribute for the first object found with the given ID or mail.
mixed|PEAR_Error
mailForIdOrMail
(string $id)
-
string
$id: Search for objects with this ID/mail.
Redefined in descendants as:
Is the given UID member of the group with the given mail address?
boolean|PEAR_Error
memberOfGroupAddress
(string $uid, string $mail)
-
string
$uid: UID of the user.
-
string
$mail: Search the group with this mail address.
Redefined in descendants as:
Read object data.
array|PEAR_Error
read
(string $uid, [string $attrs = null])
-
string
$uid: The object to retrieve.
-
string
$attrs: Restrict to these attributes.
Stub for saving object data.
array|PEAR_Error
save
(string $uid, string $data)
-
string
$uid: The object to save.
-
string
$data: The data of the object.
Redefined in descendants as:
Attempts to return a reference to a concrete Horde_Kolab_Server instance based on $driver. It will only create a new instance if no Horde_Kolab_Server instance with the same parameters currently exists.
This method must be invoked as: $var = &Horde_Kolab_Server::singleton()
-
array
$params: An array of optional login parameters. May contain "uid" (for the login uid), "user" (if the uid is not yet known), and "pass" (for a password).
Update or create a Kolab object.
Kolab_Object|PEAR_Error
&store
(string $type, array $info, [string $uid = null])
-
string
$type: The type of the object to store.
-
array
$info: Any additional information about the object to store.
-
string
$uid: The unique id of the object to store.
Identify the UID for the first object found with the given alias.
mixed|PEAR_Error
uidForAlias
(string $mail, [int $restrict = KOLAB_SERVER_RESULT_SINGLE])
-
string
$mail: Search for objects with this mail alias.
-
int
$restrict: A KOLAB_SERVER_RESULT_* result restriction.
Identify the UID for the first user found using a specified attribute value.
mixed|PEAR_Error
uidForAttr
(string $attr, string $value, [int $restrict = KOLAB_SERVER_RESULT_SINGLE])
-
string
$attr: The name of the attribute used for searching.
-
string
$value: The desired value of the attribute.
-
int
$restrict: A KOLAB_SERVER_RESULT_* result restriction.
Redefined in descendants as:
Identify the UID for the first object found with the given ID.
mixed|PEAR_Error
uidForId
(string $id, [int $restrict = KOLAB_SERVER_RESULT_SINGLE])
-
string
$id: Search for objects with this ID.
-
int
$restrict: A KOLAB_SERVER_RESULT_* result restriction.
Identify the UID for the first object found with the given ID or mail.
mixed|PEAR_Error
uidForIdOrMail
(string $id)
-
string
$id: Search for objects with this uid/mail.
Redefined in descendants as:
Identify the UID for the first user found with the given mail.
mixed|PEAR_Error
uidForMail
(string $mail, [int $restrict = KOLAB_SERVER_RESULT_SINGLE])
-
string
$mail: Search for users with this mail address.
-
int
$restrict: A KOLAB_SERVER_RESULT_* result restriction.
Return the UID for a given primary mail, uid, or alias.
mixed|PEAR_Error
uidForMailAddress
(string $mail)
-
string
$mail: A valid mail address for the user.
Redefined in descendants as:
Identify the UID for the first object found with the given mail address or alias.
mixed|PEAR_Error
uidForMailOrAlias
(string $mail)
-
string
$mail: Search for objects with this mail address or alias.
Identify the UID for the first object found with the given ID, mail or alias.
mixed|PEAR_Error
uidForMailOrIdOrAlias
(string $id)
-
string
$id: Search for objects with this ID/mail/alias.
Determine the type of a Kolab object.
string
_determineType
(string $uid)
-
string
$uid: The UID of the object to examine.
Redefined in descendants as:
Generates a UID for the given information.
string|PEAR_Error
_generateUid
(string $type, string $id, array $info)
-
string
$type: The type of the object to create.
-
string
$id: The id of the object.
-
array
$info: Any additional information about the object to create.
Redefined in descendants as:
List all objects of a specific type
array|PEAR_Error
_listObjects
(string $type, [array $params = null])
-
string
$type: The type of the objects to be listed
-
array
$params: Additional parameters.
Redefined in descendants as:
Stub for reading object data.
array|PEAR_Error
_read
(string $uid, [string $attrs = null])
-
string
$uid: The object to retrieve.
-
string
$attrs: Restrict to these attributes.
Redefined in descendants as: