Class humhub\modules\ldap\commands\LdapController

Inheritancehumhub\modules\ldap\commands\LdapController » yii\console\Controller

Console tools for manage Ldap

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$defaultAction humhub\modules\ldap\commands\LdapController

Public Methods

Hide inherited methods

MethodDescriptionDefined By
actionList() Lists configured LDAP auth clients humhub\modules\ldap\commands\LdapController
actionListUsers() Lists all users found in the LDAP server humhub\modules\ldap\commands\LdapController
actionMappingClear() Clears the 'authclient_id' entries in the user table. humhub\modules\ldap\commands\LdapController
actionMappingRebuild() Rebuilds the authclient_id and auth_mode mappings in the user table humhub\modules\ldap\commands\LdapController
actionStatus() Returns status information humhub\modules\ldap\commands\LdapController
actionSync() Synchronizes all ldap users (if autoRefresh is enabled) humhub\modules\ldap\commands\LdapController

Property Details

$defaultAction public property
public $defaultAction 'list'

Method Details

actionList() public method

Lists configured LDAP auth clients

public integer actionList ( )
return integer

The exit code

actionListUsers() public method

Lists all users found in the LDAP server

public integer actionListUsers ( $id 'ldap' )
$id string

The auth client id (default: ldap)

return integer

Status code

actionMappingClear() public method

Clears the 'authclient_id' entries in the user table.

Useful if the ldap ids changed.

public integer actionMappingClear ( $id 'ldap' )
$id string

The auth client id (default: ldap)

return integer

Status code

actionMappingRebuild() public method

Rebuilds the authclient_id and auth_mode mappings in the user table

public integer actionMappingRebuild ( $id 'ldap' )
$id string

The auth client id (default: ldap)

return integer

Status code

actionStatus() public method

Returns status information

public integer actionStatus ( $id 'ldap' )
$id string

The auth client id (default: ldap)

return integer

Status code

actionSync() public method

Synchronizes all ldap users (if autoRefresh is enabled)

public integer actionSync ( $id 'ldap' )
$id string

The auth client id (default: ldap)

return integer

Status code

getAuthClient() protected method

protected humhub\modules\ldap\authclient\LdapAuth getAuthClient ( $id )
$id