• Home
  • Horde_Group_Ldap

PHP Class Horde_Group_Ldap, horde

Author: Ben Chavet ([email protected])
Author: Jan Schneider ([email protected])
Inheritance: extends Horde_Group_Base
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_filter Horde_Ldap_Filter LDAP filter for searching groups.
$_ldap Horde_Ldap Handle for the current LDAP connection.
$_params array Any additional parameters for the driver.

Public Methods

Method Description
__construct ( $params ) Constructor.
readOnly ( ) : boolean Returns whether the group backend is read-only.
renameSupported ( ) : boolean Returns whether groups can be renamed.

Protected Methods

Method Description
_addUser ( mixed $gid, string $user ) Add a user to a group.
_create ( string $name, string $email = null ) : mixed Creates a new group.
_exists ( mixed $gid ) : boolean Checks if a group exists.
_getData ( mixed $gid ) : array Returns all available attributes of a group.
_getName ( mixed $gid ) : string Returns a group name.
_listAll ( ) : array Returns a list of all groups a user may see, with IDs as keys and names as values.
_listGroups ( string $user ) : array Returns a list of groups a user belongs to.
_listUsers ( mixed $gid ) : array Returns a list of users in a group.
_nextGid ( ) : integer Searches existing groups for the highest gidnumber, and returns one higher.
_rebind ( boolean $write ) Rebinds to the LDAP server.
_remove ( mixed $gid ) Removes a group.
_removeUser ( mixed $gid, string $user ) Removes a user from a group.
_rename ( mixed $gid, string $name ) Renames a group.
_search ( string $name ) : array Searches for group names.
_setData ( mixed $gid, array | string $attribute, string $value = null ) Sets one or more attributes of a group.

Method Details

__construct() public method

Constructor.
public __construct ( $params )

_addUser() protected method

Add a user to a group.
protected _addUser ( mixed $gid, string $user )
$gid mixed A group ID.
$user string A user name.

_create() protected method

Creates a new group.
protected _create ( string $name, string $email = null ) : mixed
$name string A group name.
$email string The group's email address.
return mixed The ID of the created group.

_exists() protected method

Checks if a group exists.
protected _exists ( mixed $gid ) : boolean
$gid mixed A group ID.
return boolean True if the group exists.

_getData() protected method

Returns all available attributes of a group.
protected _getData ( mixed $gid ) : array
$gid mixed A group ID.
return array The group's date.

_getName() protected method

Returns a group name.
protected _getName ( mixed $gid ) : string
$gid mixed A group ID.
return string The group's name.

_listAll() protected method

Returns a list of all groups a user may see, with IDs as keys and names as values.
protected _listAll ( ) : array
return array All existing groups.

_listGroups() protected method

Returns a list of groups a user belongs to.
protected _listGroups ( string $user ) : array
$user string A user name.
return array A list of groups, with IDs as keys and names as values.

_listUsers() protected method

Returns a list of users in a group.
protected _listUsers ( mixed $gid ) : array
$gid mixed A group ID.
return array List of group users.

_nextGid() protected method

Searches existing groups for the highest gidnumber, and returns one higher.
protected _nextGid ( ) : integer
return integer The next group ID.

_rebind() protected method

Rebinds to the LDAP server.
protected _rebind ( boolean $write )
$write boolean Whether to rebind for write access. Use false after finishing write actions.

_remove() protected method

Removes a group.
protected _remove ( mixed $gid )
$gid mixed A group ID.

_removeUser() protected method

Removes a user from a group.
protected _removeUser ( mixed $gid, string $user )
$gid mixed A group ID.
$user string A user name.

_rename() protected method

Renames a group.
protected _rename ( mixed $gid, string $name )
$gid mixed A group ID.
$name string The new name.

_search() protected method

Searches for group names.
protected _search ( string $name ) : array
$name string A search string.
return array A list of matching groups, with IDs as keys and names as values.

_setData() protected method

Sets one or more attributes of a group.
protected _setData ( mixed $gid, array | string $attribute, string $value = null )
$gid mixed A group ID.
$attribute array | string An attribute name or a hash of attributes.
$value string An attribute value if $attribute is a string.

readOnly() public method

Returns whether the group backend is read-only.
public readOnly ( ) : boolean
return boolean

renameSupported() public method

Returns whether groups can be renamed.
public renameSupported ( ) : boolean
return boolean

Property Details

$_filter protected property

LDAP filter for searching groups.
protected Horde_Ldap_Filter $_filter
return Horde_Ldap_Filter

$_ldap protected property

Handle for the current LDAP connection.
protected Horde_Ldap $_ldap
return Horde_Ldap

$_params protected property

Any additional parameters for the driver.
protected array $_params
return array