Class humhub\modules\user\components\ActiveQueryUser

Inheritancehumhub\modules\user\components\ActiveQueryUser » yii\db\ActiveQuery

ActiveQueryUser is used to query User records.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
active() Limit to active users humhub\modules\user\components\ActiveQueryUser
defaultOrder() Adds default user order (e.g. by lastname) humhub\modules\user\components\ActiveQueryUser
visible() Returns only users that should appear in user lists or in the search results. humhub\modules\user\components\ActiveQueryUser

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_CHECK_ACTIVE \humhub\modules\user\components\Event An event that is triggered when only active users are requested via active(). humhub\modules\user\components\ActiveQueryUser
EVENT_CHECK_VISIBILITY \humhub\modules\user\components\Event An event that is triggered when only visible users are requested via visible(). humhub\modules\user\components\ActiveQueryUser

Method Details

active() public method

Limit to active users

public humhub\modules\user\components\ActiveQueryUser active ( )
return humhub\modules\user\components\ActiveQueryUser

The query

defaultOrder() public method

Adds default user order (e.g. by lastname)

public humhub\modules\user\components\ActiveQueryUser defaultOrder ( )
return humhub\modules\user\components\ActiveQueryUser

The query

visible() public method (available since version 1.2.3)

Returns only users that should appear in user lists or in the search results.

Also only active (enabled) users are returned.

public humhub\modules\user\components\ActiveQueryUser visible ( )
return humhub\modules\user\components\ActiveQueryUser

The query

Event Details

EVENT_CHECK_ACTIVE event of type \humhub\modules\user\components\Event

An event that is triggered when only active users are requested via active().

EVENT_CHECK_VISIBILITY event of type \humhub\modules\user\components\Event

An event that is triggered when only visible users are requested via visible().