HumHub Documentation (unofficial)

LdapAuth extends BaseFormAuth
in package

Application

implements AutoSyncUsers, SyncAttributes, ApprovalBypass, PrimaryClient

LDAP Authentication

Interfaces

AutoSyncUsers: AutoSyncUsers interface adds the possiblity to automatically update/create users via AuthClient.
SyncAttributes: SyncAttributes interface allows the possiblitz to specify user attributes which will be automatically updated on login or by daily cronjob if AutoSyncUsers is enabled.
ApprovalBypass: ApprovalBypass interface allow automatic user approvals of an authclient.
PrimaryClient: PrimaryClient authclient interface

Constants

EVENT_CREATE_USER = 'create'
EVENT_UPDATE_USER = 'update'

Properties

$autoRefreshUsers : bool|null: Automatically refresh user profiles on cron run
$baseDn : string
$behaviors : array<string|int, Behavior>
$bindPassword : string: The password of the account used to perform account DN lookups.
$bindUsername : string: The DN of the account used to perform account DN lookups.
$byPassApproval : mixed
$clientId : string
$emailAttribute : string
$hostname : string: The hostname of LDAP server that these options represent. This option is required.
$httpClient : Client
$id : string
$idAttribute : string: ID attribute to uniquely identify user.
$ignoredDNs : array<string|int, string>
$login : Login
$loginFilter : string: The LDAP search filter used to search for accounts.
$name : string
$networkTimeout : int
$normalizeUserAttributeMap : array<string|int, mixed>
$port : int: The port on which the LDAP server is listening.
$requestOptions : array<string|int, mixed>
$stateStorage : StateStorageInterface
$syncUserTableAttributes : array<string|int, mixed>
$title : string
$userAttributes : array<string|int, mixed>
$userFilter : string
$usernameAttribute : string
$useSsl : bool: Whether or not the LDAP client should use SSL encrypted transport.
$useStartTls : bool: Whether or not the LDAP client should use TLS (aka SSLv2) encrypted transport.
$viewOptions : array<string|int, mixed>
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_httpClient : Client|array<string|int, mixed>|string
$_id : string
$_ldap : Ldap
$_name : string
$_normalizeUserAttributeMap : array<string|int, mixed>
$_requestOptions : array<string|int, mixed>
$_stateStorage : StateStorageInterface|array<string|int, mixed>|string
$_title : string
$_userAttributes : array<string|int, mixed>
$_viewOptions : array<string|int, mixed>
$loginUser : User

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
auth() : mixed: Authenticate the user using the login form.
beforeSerialize() : void: Workaround for serialization into session during the registration process
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
countFailedLoginAttempts() : mixed: Increase a counter of failed login attempts (Used after failed login action)
createRequest() : Request: Creates HTTP request instance.
delayLoginAfterFailedAttempt() : mixed: Set data(counter and time) to mark the user is delayed for next login action
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getAuthClientInstance() : LdapAuth
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getDelayedLoginTime() : int: How much seconds current user (who tried to log in by this client auth form) is delayed for login action
getFailedLoginAttemptsCount() : int: Get a failed login attempts count
getHttpClient() : Client: Returns HTTP client.
getId() : string
getIdAttribute() : mixed
getLdap() : ZendLdap: Returns Zend LDAP
getName() : string
getNormalizeUserAttributeMap() : array<string|int, mixed>
getRequestOptions() : array<string|int, mixed>
getStateStorage() : StateStorageInterface
getSyncAttributes() : array<string|int, mixed>: Returns attribute names which should be synced on login
getTitle() : string
getUser() : User: Find user based on ldap attributes
getUserAttributes() : array<string|int, mixed>
getUserByLogin() : User|null: Find user by passed username from login form
getUserCollection() : array<string|int, mixed>
getViewOptions() : array<string|int, mixed>
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
isDelayedLoginAction() : bool: Check if current user (who tried to log in by this client auth form) is delayed for login action
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
onSuccessLogin() : mixed: Action after successful login action
reportAboutFailedLoginAttempts() : mixed: Report that the logged in user had some failed attempts (Used to display the report right after successful login action)
resetFailedLoginAttempts() : mixed: Reset a counter of failed login attempts (Used after successful login action)
setHttpClient() : mixed: Sets HTTP client to be used.
setId() : mixed
setLdap() : mixed: Sets an Zend LDAP Instance
setName() : mixed
setNormalizeUserAttributeMap() : mixed
setRequestOptions() : mixed
setStateStorage() : mixed
setTitle() : mixed
setUserAttributes() : mixed
setViewOptions() : mixed
syncUsers() : mixed: Refresh ldap users
trigger() : mixed: Triggers an event.
createHttpClient() : Client: Creates HTTP client instance from reference or configuration.
defaultName() : string: Generates service name.
defaultNormalizeUserAttributeMap() : array<string|int, mixed>: Returns the default [[normalizeUserAttributeMap]] value.
defaultRequestOptions() : array<string|int, mixed>: Returns default HTTP request options.
defaultTitle() : string: Generates service title.
defaultViewOptions() : array<string|int, mixed>: Returns the default [[viewOptions]] value.
getState() : mixed: Returns persistent state value.
getStateKeyPrefix() : string: Returns session key prefix, which is used to store internal states.
getUserAuto() : User: Try to find the user if authclient_id mapping is not set yet (legency) or idAttribute is not specified.
getUserDn() : string: Returns the users LDAP DN
getUserNode() : Node: Returns Users LDAP Node
initUserAttributes() : array<string|int, mixed>: Initializes authenticated user attributes.
normalizeUserAttributes() : array<string|int, mixed>: Normalize given user attributes according to [[normalizeUserAttributeMap]].
removeState() : bool: Removes persistent state value.
setState() : $this: Sets persistent state.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

EVENT_CREATE_USER


    public
        mixed
    EVENT_CREATE_USER
    = 'create'

EVENT_UPDATE_USER


    public
        mixed
    EVENT_UPDATE_USER
    = 'update'

$autoRefreshUsers

Automatically refresh user profiles on cron run


    public
        bool|null
    $autoRefreshUsers
     = null

$baseDn


    public
        string
    $baseDn
     = null

the ldap base dn

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$bindPassword

The password of the account used to perform account DN lookups.


    public
        string
    $bindPassword

$bindUsername

The DN of the account used to perform account DN lookups.


    public
        string
    $bindUsername

LDAP servers that require the username to be in DN form when performing the “bind” require this option.

$byPassApproval


    public
        mixed
    $byPassApproval
     = true

$clientId


    public
        string
    $clientId
     = 'ldap'

the auth client id

$emailAttribute


    public
        string
    $emailAttribute
     = null

the email attribute

$hostname

The hostname of LDAP server that these options represent. This option is required.


    public
        string
    $hostname

$httpClient


    public
        Client
    $httpClient

Internal HTTP client. Note that the type of this property differs in getter and setter. See [[getHttpClient()]] and [[setHttpClient()]] for details.

$id


    public
        string
    $id

Service id.

$idAttribute

ID attribute to uniquely identify user.


    public
        string
    $idAttribute
     = null

If set to null, automatically a value email or objectguid will be used if available.

attribute name to identify node

$ignoredDNs


    public
        array<string|int, string>
    $ignoredDNs
     = []

a list of ignored DNs (lowercase)

$login


    public
        Login
    $login
     = null

the login form model

$loginFilter

The LDAP search filter used to search for accounts.


    public
        string
    $loginFilter
     = null

This string is a printf()-style expression that must contain one ‘%s’ to accommodate the username.

the login filter

$name


    public
        string
    $name

Service name.

$networkTimeout


    public
        int
    $networkTimeout
     = 30

The value for network timeout when connect to the LDAP server.

$normalizeUserAttributeMap


    public
        array<string|int, mixed>
    $normalizeUserAttributeMap

Normalize user attribute map.

$port

The port on which the LDAP server is listening.


    public
        int
    $port

389

$requestOptions read-only


    public
        array<string|int, mixed>
    $requestOptions

HTTP request options.

$stateStorage


    public
        StateStorageInterface
    $stateStorage

Stage storage. Note that the type of this property differs in getter and setter. See [[getStateStorage()]] and [[setStateStorage()]] for details.

$syncUserTableAttributes


    public
        array<string|int, mixed>
    $syncUserTableAttributes
     = ['username', 'email']

of attributes which are synced with the user table

$title


    public
        string
    $title

Service title.

$userAttributes


    public
        array<string|int, mixed>
    $userAttributes

List of user attributes.

$userFilter


    public
        string
    $userFilter
     = null

the ldap query to find humhub users

$usernameAttribute


    public
        string
    $usernameAttribute
     = null

the ldap username attribute

$useSsl

Whether or not the LDAP client should use SSL encrypted transport.


    public
        bool
    $useSsl
     = false

The useSsl and useStartTls options are mutually exclusive, but useStartTls should be favored if the server and LDAP client library support it.

$useStartTls

Whether or not the LDAP client should use TLS (aka SSLv2) encrypted transport.


    public
        bool
    $useStartTls
     = false

A value of TRUE is strongly favored in production environments to prevent passwords from be transmitted in clear text.

The default value is FALSE, as servers frequently require that a certificate be installed separately after installation. The useSsl and useStartTls options are mutually exclusive. The useStartTls option should be favored over useSsl but not all servers support this newer mechanism.

$viewOptions


    public
        array<string|int, mixed>
    $viewOptions

View options in format: optionName => optionValue.

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_httpClient


    private
        Client|array<string|int, mixed>|string
    $_httpClient
     = 'yii\httpclient\Client'

internal HTTP client.

$_id


    private
        string
    $_id

auth service id. This value mainly used as HTTP request parameter.

$_ldap


    private
        Ldap
    $_ldap
     = null

$_name


    private
        string
    $_name

auth service name. This value may be used in database records, CSS files and so on.

$_normalizeUserAttributeMap


    private
        array<string|int, mixed>
    $_normalizeUserAttributeMap

map used to normalize user attributes fetched from external auth service in format: normalizedAttributeName => sourceSpecification 'sourceSpecification' can be:

string, raw attribute name
array, pass to raw attribute value
callable, PHP callback, which should accept array of raw attributes and return normalized value.

For example:

'normalizeUserAttributeMap' => [
     'about' => 'bio',
     'language' => ['languages', 0, 'name'],
     'fullName' => function ($attributes) {
         return $attributes['firstName'] . ' ' . $attributes['lastName'];
     },
 ],

$_requestOptions


    private
        array<string|int, mixed>
    $_requestOptions
     = []

cURL request options. Option values from this field will overwrite corresponding values from [[defaultRequestOptions()]].

$_stateStorage


    private
        StateStorageInterface|array<string|int, mixed>|string
    $_stateStorage
     = 'yii\authclient\SessionStateStorage'

state storage to be used.

$_title


    private
        string
    $_title

auth service title to display in views.

$_userAttributes


    private
        array<string|int, mixed>
    $_userAttributes

authenticated user attributes.

$_viewOptions


    private
        array<string|int, mixed>
    $_viewOptions

view options in format: optionName => optionValue

$loginUser


    private
        User
    $loginUser
     = null

User from submitted login form (by username, without password)

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

auth()

Authenticate the user using the login form.


    public
                    auth() : mixed

beforeSerialize()

Workaround for serialization into session during the registration process


    public
                    beforeSerialize() : void

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

countFailedLoginAttempts()

Increase a counter of failed login attempts (Used after failed login action)


    public
                    countFailedLoginAttempts() : mixed

createRequest()

Creates HTTP request instance.


    public
                    createRequest() : Request

Return values

Request —

HTTP request instance.

delayLoginAfterFailedAttempt()

Set data(counter and time) to mark the user is delayed for next login action


    public
                    delayLoginAfterFailedAttempt() : mixed

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

getAuthClientInstance()


    public
                    getAuthClientInstance(mixed $ldapEntry) : LdapAuth

Parameters

$ldapEntry : mixed: array

Return values

LdapAuth

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getDelayedLoginTime()

How much seconds current user (who tried to log in by this client auth form) is delayed for login action


    public
                    getDelayedLoginTime() : int

Return values

int

getFailedLoginAttemptsCount()

Get a failed login attempts count


    public
                    getFailedLoginAttemptsCount() : int

Return values

int

getHttpClient()

Returns HTTP client.


    public
                    getHttpClient() : Client

Return values

Client —

internal HTTP client.

getId()


    public
                    getId() : string

Return values

string —

service id

getIdAttribute()


    public
                    getIdAttribute() : mixed

getLdap()

Returns Zend LDAP


    public
                    getLdap() : ZendLdap

Return values

ZendLdap

getName()


    public
                    getName() : string

Return values

string —

service name.

getNormalizeUserAttributeMap()


    public
                    getNormalizeUserAttributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

normalize user attribute map.

getRequestOptions()


    public
                    getRequestOptions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

HTTP request options.

getStateStorage()


    public
                    getStateStorage() : StateStorageInterface

Return values

StateStorageInterface —

stage storage.

getSyncAttributes()

Returns attribute names which should be synced on login


    public
                    getSyncAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

attribute names to be synced

getTitle()


    public
                    getTitle() : string

Return values

string —

service title.

getUser()

Find user based on ldap attributes


    public
                    getUser() : User

Return values

User —

the user

getUserAttributes()


    public
                    getUserAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

list of user attributes

getUserByLogin()

Find user by passed username from login form


    public
                    getUserByLogin() : User|null

Return values

User|null

getUserCollection()


    public
                    getUserCollection() : array<string|int, mixed>

Return values

array<string|int, mixed>

getViewOptions()


    public
                    getViewOptions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

view options in format: optionName => optionValue

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

isDelayedLoginAction()

Check if current user (who tried to log in by this client auth form) is delayed for login action


    public
                    isDelayedLoginAction() : bool

Return values

bool

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

onSuccessLogin()

Action after successful login action


    public
                    onSuccessLogin() : mixed

reportAboutFailedLoginAttempts()

Report that the logged in user had some failed attempts (Used to display the report right after successful login action)


    public
                    reportAboutFailedLoginAttempts() : mixed

resetFailedLoginAttempts()

Reset a counter of failed login attempts (Used after successful login action)


    public
                    resetFailedLoginAttempts() : mixed

setHttpClient()

Sets HTTP client to be used.


    public
                    setHttpClient(array<string|int, mixed>|Client $httpClient) : mixed

Parameters

$httpClient : array<string|int, mixed>|Client: internal HTTP client.

setId()


    public
                    setId(string $id) : mixed

Parameters

$id : string: service id.

setLdap()

Sets an Zend LDAP Instance


    public
                    setLdap(Ldap $ldap) : mixed

Parameters

$ldap : Ldap

setName()


    public
                    setName(string $name) : mixed

Parameters

$name : string: service name.

setNormalizeUserAttributeMap()


    public
                    setNormalizeUserAttributeMap(array<string|int, mixed> $normalizeUserAttributeMap) : mixed

Parameters

$normalizeUserAttributeMap : array<string|int, mixed>: normalize user attribute map.

setRequestOptions()


    public
                    setRequestOptions(array<string|int, mixed> $options) : mixed

Parameters

$options : array<string|int, mixed>: HTTP request options.

setStateStorage()


    public
                    setStateStorage(StateStorageInterface|array<string|int, mixed>|string $stateStorage) : mixed

Parameters

$stateStorage : StateStorageInterface|array<string|int, mixed>|string: stage storage to be used.

setTitle()


    public
                    setTitle(string $title) : mixed

Parameters

$title : string: service title.

setUserAttributes()


    public
                    setUserAttributes(array<string|int, mixed> $userAttributes) : mixed

Parameters

$userAttributes : array<string|int, mixed>: list of user attributes

setViewOptions()


    public
                    setViewOptions(array<string|int, mixed> $viewOptions) : mixed

Parameters

$viewOptions : array<string|int, mixed>: view options in format: optionName => optionValue

syncUsers()

Refresh ldap users


    public
                    syncUsers() : mixed

New users (found in ldap) will be automatically created if all required fiélds are set. Profile fields which are bind to LDAP will automatically updated.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

createHttpClient()

Creates HTTP client instance from reference or configuration.


    protected
                    createHttpClient(string|array<string|int, mixed> $reference) : Client

Parameters

$reference : string|array<string|int, mixed>: component name or array configuration.

Return values

Client —

HTTP client instance.

defaultName()

Generates service name.


    protected
                    defaultName() : string

Return values

string —

service name.

defaultNormalizeUserAttributeMap()

Returns the default [[normalizeUserAttributeMap]] value.


    protected
                    defaultNormalizeUserAttributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

normalize attribute map.

defaultRequestOptions()

Returns default HTTP request options.


    protected
                    defaultRequestOptions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

HTTP request options.

defaultTitle()

Generates service title.


    protected
                    defaultTitle() : string

Return values

string —

service title.

defaultViewOptions()

Returns the default [[viewOptions]] value.


    protected
                    defaultViewOptions() : array<string|int, mixed>

Particular client may override this method in order to provide specific default view options.

Return values

array<string|int, mixed> —

list of default [[viewOptions]]

getState()

Returns persistent state value.


    protected
                    getState(string $key) : mixed

Parameters

$key : string: state key.

Return values

mixed —

state value.

getStateKeyPrefix()

Returns session key prefix, which is used to store internal states.


    protected
                    getStateKeyPrefix() : string

Return values

string —

session key prefix.

getUserAuto()

Try to find the user if authclient_id mapping is not set yet (legency) or idAttribute is not specified.


    protected
                    getUserAuto() : User

Return values

User

getUserDn()

Returns the users LDAP DN


    protected
                    getUserDn() : string

Return values

string —

the user dn if found

getUserNode()

Returns Users LDAP Node


    protected
                    getUserNode() : Node

Return values

Node —

the users ldap node

initUserAttributes()

Initializes authenticated user attributes.


    protected
                    initUserAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

auth user attributes.

normalizeUserAttributes()

Normalize given user attributes according to [[normalizeUserAttributeMap]].


    protected
                    normalizeUserAttributes(mixed $attributes) : array<string|int, mixed>

Parameters

$attributes : mixed: raw attributes.

Return values

array<string|int, mixed> —

normalized attributes.

removeState()

Removes persistent state value.


    protected
                    removeState(string $key) : bool

Parameters

$key : string: state key.

Return values

bool —

success.

setState()

Sets persistent state.


    protected
                    setState(string $key, mixed $value) : $this

Parameters

$key : string: state key.
$value : mixed: state value

Return values

$this —

the object itself

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

LdapAuth extends BaseFormAuth in package Application implements AutoSyncUsers, SyncAttributes, ApprovalBypass, PrimaryClient

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

EVENT_CREATE_USER

Tags

EVENT_UPDATE_USER

Tags

Properties

$autoRefreshUsers

$baseDn

$behaviors read-only

$bindPassword

$bindUsername

$byPassApproval

Tags

$clientId

$emailAttribute

$hostname

$httpClient

$id

$idAttribute

$ignoredDNs

Tags

$login

$loginFilter

$name

$networkTimeout

$normalizeUserAttributeMap

$port

$requestOptions read-only

$stateStorage

$syncUserTableAttributes

$title

$userAttributes

$userFilter

$usernameAttribute

$useSsl

$useStartTls

$viewOptions

$_behaviors

$_events

$_eventWildcards

Tags

$_httpClient

Tags

$_id

$_ldap

$_name

$_normalizeUserAttributeMap

$_requestOptions

Tags

$_stateStorage

$_title

$_userAttributes

$_viewOptions

$loginUser

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

LdapAuth extends BaseFormAuth
in package

Application

implements AutoSyncUsers, SyncAttributes, ApprovalBypass, PrimaryClient