PHP Class Horde_Kolab_Server_Object_Kolabinetorgperson, horde

Copyright 2008-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Inheritance: extends Horde_Kolab_Server_Object_Inetorgperson
Show file Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$attributes array The attributes defined for this class.

Public Methods

Method Description
deleteExternalAccount ( string $mail ) : null Delete an external account.
generateCn ( array $info ) : string Generates the common name for the given information.
generateId ( array &$info ) : string | PEAR_Error Generates an ID for the given information.
getExternalAccounts ( ) : array List the external pop3 accounts of this object.
getFilter ( ) : string Return the filter string to retrieve this object type.
getServer ( string $server_type ) : string Returns the server url of the given type for this user.
prepareObjectInformation ( array &$info ) : NULL. Distill the server side object information to save.
saveExternalAccount ( array $account ) : null Create/update an external pop3 accounts of this object.

Method Details

deleteExternalAccount() public method

Delete an external account.
public deleteExternalAccount ( string $mail ) : null
$mail string The mail address of the pop3 account.
return null

generateCn() public method

Generates the common name for the given information.
public generateCn ( array $info ) : string
$info array The data of the object.
return string The common name.

generateId() public method

Generates an ID for the given information.
public generateId ( array &$info ) : string | PEAR_Error
$info array The data of the object.
return string | PEAR_Error The ID.

getExternalAccounts() public method

List the external pop3 accounts of this object.
public getExternalAccounts ( ) : array
return array The data of the pop3 accounts.

getFilter() public static method

Return the filter string to retrieve this object type.
public static getFilter ( ) : string
return string The filter to retrieve this object type from the server database.

getServer() public method

This method is used to encapsulate multidomain support.
public getServer ( string $server_type ) : string
$server_type string The type of server URL that should be returned.
return string The server url or empty on error.

prepareObjectInformation() public method

Distill the server side object information to save.
public prepareObjectInformation ( array &$info ) : NULL.
$info array The information about the object.
return NULL.

saveExternalAccount() public method

Create/update an external pop3 accounts of this object.
public saveExternalAccount ( array $account ) : null
$account array The account data.
return null

Property Details

$attributes public static property

The attributes defined for this class.
public static array $attributes
return array